From 6757d1265bf6b1192aed50f3fede679601a29f83 Mon Sep 17 00:00:00 2001 From: Duologic Date: Sun, 21 Apr 2024 00:06:14 +0200 Subject: [PATCH 01/17] feat!: update generator to run against schemas from foundation-sdk BREAKING CHANGE: This will drop support for regenerating imports.libsonnet +find vendor/github.com/grafana/grafana-foundation-sdk/openapi -type f | awk '{print "import \""$1"\","}' >> imports.libsonnet +echo ']' >> imports.libsonnet + OUT_DIR="${REPO_DIR}/gen" GEN_DIR="${OUT_DIR}/grafonnet-${VERSION}" @@ -35,7 +39,7 @@ mapfile -t FILES < <( jsonnet -J vendor \ -S -c -m "${OUT_DIR}" \ --tla-str version="${VERSION}" \ - --tla-code-file schemas="github.com/grafana/grok/jsonnet/${VERSION}/imports.libsonnet" \ + --tla-code-file schemas="./imports.libsonnet" \ --tla-code-file openapiSpec="github.com/grafana/grafana/public/openapi3.json" \ -e "(import 'generator/main.libsonnet')" ) diff --git a/scripts/generate_latest.sh b/scripts/generate_latest.sh index 552e1043..96653bef 100755 --- a/scripts/generate_latest.sh +++ b/scripts/generate_latest.sh @@ -19,7 +19,6 @@ jb init cp -r "${REPO_DIR}/generator" generator cp -r "${REPO_DIR}/generator/jsonnetfile.lock.json" . jb install -jb install "github.com/grafana/grok/jsonnet/${VERSION}@main" jb install ./generator OUT_DIR="${REPO_DIR}/gen" From 78436260763b14e122009ccf4228742d09c55dc3 Mon Sep 17 00:00:00 2001 From: Duologic Date: Sun, 21 Apr 2024 13:51:53 +0200 Subject: [PATCH 02/17] render all --- docs/API/accesspolicy/rules.md | 25 + .../API/alerting/muteTiming/interval/index.md | 116 +- .../interval/time_intervals/index.md | 144 + .../interval/time_intervals/times.md | 32 + .../API/alerting/muteTiming/interval/times.md | 32 - docs/API/index.md | 2 +- docs/API/librarypanel.md | 334 -- docs/API/librarypanel/index.md | 1599 ++++++++ .../fieldConfig/defaults/thresholds/steps.md | 34 + .../model/fieldConfig/overrides/index.md | 104 + .../model/fieldConfig/overrides/properties.md | 45 + docs/API/librarypanel/model/links.md | 146 + .../API/librarypanel/model/transformations.md | 140 + docs/API/panel/alertList/index.md | 572 --- .../alertList/queryOptions/transformation.md | 29 +- .../alertList/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- .../queryOptions/transformation.md | 29 +- .../standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/barChart/index.md | 13 +- .../barChart/queryOptions/transformation.md | 29 +- .../panel/barChart/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- .../barGauge/queryOptions/transformation.md | 29 +- .../panel/barGauge/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/candlestick/index.md | 83 +- .../queryOptions/transformation.md | 29 +- .../candlestick/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/canvas/index.md | 21 +- .../{connections.md => connections/index.md} | 134 +- .../root/elements/connections/vertices.md | 32 + .../canvas/options/root/elements/index.md | 44 +- .../canvas/queryOptions/transformation.md | 29 +- .../panel/canvas/standardOptions/mapping.md | 32 +- .../canvas/standardOptions/threshold/step.md | 2 +- .../queryOptions/transformation.md | 29 +- .../dashboardList/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- .../datagrid/queryOptions/transformation.md | 29 +- .../panel/datagrid/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- .../debug/queryOptions/transformation.md | 29 +- .../panel/debug/standardOptions/mapping.md | 32 +- .../debug/standardOptions/threshold/step.md | 2 +- .../gauge/queryOptions/transformation.md | 29 +- .../panel/gauge/standardOptions/mapping.md | 32 +- .../gauge/standardOptions/threshold/step.md | 2 +- docs/API/panel/geomap/index.md | 28 +- docs/API/panel/geomap/options/layers.md | 28 +- .../geomap/queryOptions/transformation.md | 29 +- .../panel/geomap/standardOptions/mapping.md | 32 +- .../geomap/standardOptions/threshold/step.md | 2 +- docs/API/panel/heatmap/index.md | 278 +- .../heatmap/queryOptions/transformation.md | 29 +- .../panel/heatmap/standardOptions/mapping.md | 32 +- .../heatmap/standardOptions/threshold/step.md | 2 +- docs/API/panel/histogram/index.md | 57 +- .../histogram/queryOptions/transformation.md | 29 +- .../histogram/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/index.md | 1 - .../panel/logs/queryOptions/transformation.md | 29 +- .../API/panel/logs/standardOptions/mapping.md | 32 +- .../logs/standardOptions/threshold/step.md | 2 +- .../panel/news/queryOptions/transformation.md | 29 +- .../API/panel/news/standardOptions/mapping.md | 32 +- .../news/standardOptions/threshold/step.md | 2 +- .../nodeGraph/queryOptions/transformation.md | 29 +- .../nodeGraph/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- .../pieChart/queryOptions/transformation.md | 29 +- .../panel/pieChart/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- .../panel/stat/queryOptions/transformation.md | 29 +- .../API/panel/stat/standardOptions/mapping.md | 32 +- .../stat/standardOptions/threshold/step.md | 2 +- docs/API/panel/stateTimeline/index.md | 28 +- .../queryOptions/transformation.md | 29 +- .../stateTimeline/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/statusHistory/index.md | 25 +- .../queryOptions/transformation.md | 29 +- .../statusHistory/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/table/index.md | 164 +- .../table/queryOptions/transformation.md | 29 +- .../panel/table/standardOptions/mapping.md | 32 +- .../table/standardOptions/threshold/step.md | 2 +- docs/API/panel/text/index.md | 7 +- .../panel/text/queryOptions/transformation.md | 29 +- .../API/panel/text/standardOptions/mapping.md | 32 +- .../text/standardOptions/threshold/step.md | 2 +- docs/API/panel/timeSeries/index.md | 37 +- .../timeSeries/queryOptions/transformation.md | 29 +- .../timeSeries/standardOptions/mapping.md | 32 +- .../standardOptions/threshold/step.md | 2 +- docs/API/panel/trend/index.md | 2 +- .../trend/queryOptions/transformation.md | 29 +- .../panel/trend/standardOptions/mapping.md | 32 +- .../trend/standardOptions/threshold/step.md | 2 +- docs/API/panel/xyChart/index.md | 4 +- docs/API/panel/xyChart/options/series.md | 4 +- .../xyChart/queryOptions/transformation.md | 29 +- .../panel/xyChart/standardOptions/mapping.md | 32 +- .../xyChart/standardOptions/threshold/step.md | 2 +- .../azureMonitor/dimensionFilters.md | 0 .../azureMonitor/resources.md | 0 .../azureTraces/filters.md | 0 .../{azureMonitor => azuremonitor}/index.md | 105 +- .../CloudWatchLogsQuery/logGroups.md | 0 .../parameters.md | 7 +- .../sql/orderBy/parameters.md | 7 +- .../sql/select/parameters.md | 7 +- .../query/{cloudWatch => cloudwatch}/index.md | 99 +- .../query/elasticsearch/bucketAggs/index.md | 585 --- docs/API/query/elasticsearch/index.md | 3145 +++++++++++++++- docs/API/query/elasticsearch/metrics/index.md | 2616 ------------- ...Monitoring.md => googlecloudmonitoring.md} | 37 +- ...rafanaPyroscope.md => grafanapyroscope.md} | 47 +- docs/API/query/index.md | 9 +- docs/API/query/loki.md | 36 +- docs/API/query/parca.md | 33 +- docs/API/query/prometheus.md | 82 +- docs/API/query/tempo/index.md | 21 +- docs/API/query/testData/csvWave.md | 56 - docs/API/query/testData/index.md | 797 ---- docs/API/role.md | 17 +- docs/API/rolebinding.md | 16 +- gen/grafonnet-latest/jsonnetfile.json | 2 +- gen/grafonnet-latest/main.libsonnet | 2 +- gen/grafonnet-v11.0.0/accesspolicy.libsonnet | 94 + gen/grafonnet-v11.0.0/alerting.libsonnet | 9 + .../clean/alerting/contactPoint.libsonnet | 33 + .../clean/alerting/messageTemplate.libsonnet | 12 + .../clean/alerting/muteTiming.libsonnet | 135 + .../alerting/notificationPolicy.libsonnet | 97 + .../clean/alerting/ruleGroup.libsonnet | 135 + .../custom/alerting/contactPoint.libsonnet | 12 + .../custom/alerting/muteTiming.libsonnet | 8 + .../alerting/notificationPolicy.libsonnet | 12 + .../custom/alerting/ruleGroup.libsonnet | 13 + .../custom/dashboard.libsonnet | 64 + .../custom/dashboard/annotation.libsonnet | 36 + .../custom/dashboard/link.libsonnet | 90 + .../custom/dashboard/variable.libsonnet | 516 +++ gen/grafonnet-v11.0.0/custom/panel.libsonnet | 171 + .../custom/query/loki.libsonnet | 27 + .../custom/query/prometheus.libsonnet | 47 + .../custom/query/tempo.libsonnet | 29 + gen/grafonnet-v11.0.0/custom/row.libsonnet | 26 + .../custom/util/dashboard.libsonnet | 55 + .../custom/util/grid.libsonnet | 173 + .../custom/util/main.libsonnet | 9 + .../custom/util/panel.libsonnet | 321 ++ .../custom/util/string.libsonnet | 27 + gen/grafonnet-v11.0.0/dashboard.libsonnet | 580 +++ gen/grafonnet-v11.0.0/docs/README.md | 31 + .../docs/accesspolicy/index.md | 156 + .../docs/accesspolicy/rules.md | 71 + .../docs/alerting/contactPoint.md | 100 + gen/grafonnet-v11.0.0/docs/alerting/index.md | 11 + .../docs/alerting/messageTemplate.md | 32 + .../docs/alerting/muteTiming/index.md | 48 + .../alerting/muteTiming/interval/index.md | 48 + .../interval/time_intervals/index.md | 144 + .../interval/time_intervals/times.md | 32 + .../docs/alerting/notificationPolicy/index.md | 173 + .../alerting/notificationPolicy/matcher.md | 45 + .../docs/alerting/ruleGroup/index.md | 72 + .../docs/alerting/ruleGroup/rule/data.md | 128 + .../docs/alerting/ruleGroup/rule/index.md | 161 + .../docs/dashboard/annotation.md | 298 ++ gen/grafonnet-v11.0.0/docs/dashboard/index.md | 480 +++ gen/grafonnet-v11.0.0/docs/dashboard/link.md | 196 + .../docs/dashboard/variable.md | 1042 ++++++ gen/grafonnet-v11.0.0/docs/folder.md | 45 + .../docs/librarypanel/index.md | 1599 ++++++++ .../fieldConfig/defaults/thresholds/steps.md | 34 + .../model/fieldConfig/overrides/index.md | 104 + .../model/fieldConfig/overrides/properties.md | 45 + .../docs/librarypanel/model/links.md | 146 + .../librarypanel/model/transformations.md | 140 + .../docs/panel/alertList/index.md | 605 +++ .../panel/alertList}/panelOptions/link.md | 0 .../alertList}/queryOptions/transformation.md | 29 +- .../alertList}/standardOptions/mapping.md | 32 +- .../alertList}/standardOptions/override.md | 0 .../standardOptions/threshold/step.md | 2 +- .../docs/panel/annotationsList/index.md | 750 ++++ .../annotationsList/panelOptions/link.md | 146 + .../queryOptions/transformation.md | 140 + .../standardOptions/mapping.md | 445 +++ .../standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/barChart/index.md | 1386 +++++++ .../docs/panel/barChart/panelOptions/link.md | 146 + .../barChart/queryOptions/transformation.md | 140 + .../panel/barChart/standardOptions/mapping.md | 445 +++ .../barChart/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/barGauge/index.md | 868 +++++ .../docs/panel/barGauge/panelOptions/link.md | 146 + .../barGauge/queryOptions/transformation.md | 140 + .../panel/barGauge/standardOptions/mapping.md | 445 +++ .../barGauge/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/candlestick/index.md | 1691 +++++++++ .../panel/candlestick/panelOptions/link.md | 146 + .../queryOptions/transformation.md | 140 + .../candlestick/standardOptions/mapping.md | 445 +++ .../candlestick/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/canvas/index.md | 737 ++++ .../root/elements/connections/index.md | 410 +++ .../root/elements/connections/vertices.md | 32 + .../canvas/options/root/elements/index.md | 512 +++ .../docs/panel/canvas/panelOptions/link.md | 146 + .../canvas/queryOptions/transformation.md | 140 + .../panel/canvas/standardOptions/mapping.md | 445 +++ .../panel/canvas/standardOptions/override.md | 244 ++ .../canvas/standardOptions/threshold/step.md | 34 + .../docs/panel/dashboardList/index.md | 761 ++++ .../panel/dashboardList/panelOptions/link.md | 146 + .../queryOptions/transformation.md | 140 + .../dashboardList/standardOptions/mapping.md | 445 +++ .../dashboardList/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/datagrid/index.md | 622 ++++ .../docs/panel/datagrid/panelOptions/link.md | 146 + .../datagrid/queryOptions/transformation.md | 140 + .../panel/datagrid/standardOptions/mapping.md | 445 +++ .../datagrid/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/debug/index.md | 689 ++++ .../docs/panel/debug/panelOptions/link.md | 146 + .../debug/queryOptions/transformation.md | 140 + .../panel/debug/standardOptions/mapping.md | 445 +++ .../panel/debug/standardOptions/override.md | 244 ++ .../debug/standardOptions/threshold/step.md | 34 + .../docs/panel/gauge/index.md | 828 +++++ .../docs/panel/gauge/panelOptions/link.md | 146 + .../gauge/queryOptions/transformation.md | 140 + .../panel/gauge/standardOptions/mapping.md | 445 +++ .../panel/gauge/standardOptions/override.md | 244 ++ .../gauge/standardOptions/threshold/step.md | 34 + .../docs/panel/geomap/index.md | 1188 ++++++ .../docs/panel/geomap/options/layers.md | 220 ++ .../docs/panel/geomap/panelOptions/link.md | 146 + .../geomap/queryOptions/transformation.md | 140 + .../panel/geomap/standardOptions/mapping.md | 445 +++ .../panel/geomap/standardOptions/override.md | 244 ++ .../geomap/standardOptions/threshold/step.md | 34 + .../docs/panel/heatmap/index.md | 1803 +++++++++ .../docs/panel/heatmap/panelOptions/link.md | 146 + .../heatmap/queryOptions/transformation.md | 140 + .../panel/heatmap/standardOptions/mapping.md | 445 +++ .../panel/heatmap/standardOptions/override.md | 244 ++ .../heatmap/standardOptions/threshold/step.md | 34 + .../docs/panel/histogram/index.md | 1242 +++++++ .../docs/panel/histogram/panelOptions/link.md | 146 + .../histogram/queryOptions/transformation.md | 140 + .../histogram/standardOptions/mapping.md | 445 +++ .../histogram/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + gen/grafonnet-v11.0.0/docs/panel/index.md | 32 + .../docs/panel/logs/index.md | 726 ++++ .../docs/panel/logs/panelOptions/link.md | 146 + .../panel/logs/queryOptions/transformation.md | 140 + .../panel/logs/standardOptions/mapping.md | 445 +++ .../panel/logs/standardOptions/override.md | 244 ++ .../logs/standardOptions/threshold/step.md | 34 + .../docs/panel/news}/index.md | 32 +- .../docs/panel/news/panelOptions/link.md | 146 + .../panel/news/queryOptions/transformation.md | 140 + .../panel/news/standardOptions/mapping.md | 445 +++ .../panel/news/standardOptions/override.md | 244 ++ .../news/standardOptions/threshold/step.md | 34 + .../docs/panel/nodeGraph/index.md | 738 ++++ .../panel/nodeGraph/options/nodes/arcs.md | 33 + .../docs/panel/nodeGraph/panelOptions/link.md | 146 + .../nodeGraph/queryOptions/transformation.md | 140 + .../nodeGraph/standardOptions/mapping.md | 445 +++ .../nodeGraph/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/pieChart/index.md | 1136 ++++++ .../docs/panel/pieChart/panelOptions/link.md | 146 + .../pieChart/queryOptions/transformation.md | 140 + .../panel/pieChart/standardOptions/mapping.md | 445 +++ .../pieChart/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + gen/grafonnet-v11.0.0/docs/panel/row.md | 179 + .../docs/panel/stat/index.md | 841 +++++ .../docs/panel/stat/panelOptions/link.md | 146 + .../panel/stat/queryOptions/transformation.md | 140 + .../panel/stat/standardOptions/mapping.md | 445 +++ .../panel/stat/standardOptions/override.md | 244 ++ .../stat/standardOptions/threshold/step.md | 34 + .../docs/panel/stateTimeline/index.md | 1045 ++++++ .../panel/stateTimeline/panelOptions/link.md | 146 + .../queryOptions/transformation.md | 140 + .../stateTimeline/standardOptions/mapping.md | 445 +++ .../stateTimeline/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/statusHistory/index.md | 1032 ++++++ .../panel/statusHistory/panelOptions/link.md | 146 + .../queryOptions/transformation.md | 140 + .../statusHistory/standardOptions/mapping.md | 445 +++ .../statusHistory/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/table/index.md | 1943 ++++++++++ .../docs/panel/table/options/sortBy.md | 34 + .../docs/panel/table/panelOptions/link.md | 146 + .../table/queryOptions/transformation.md | 140 + .../panel/table/standardOptions/mapping.md | 445 +++ .../panel/table/standardOptions/override.md | 244 ++ .../table/standardOptions/threshold/step.md | 34 + .../docs/panel/text/index.md | 702 ++++ .../docs/panel/text/panelOptions/link.md | 146 + .../panel/text/queryOptions/transformation.md | 140 + .../panel/text/standardOptions/mapping.md | 445 +++ .../panel/text/standardOptions/override.md | 244 ++ .../text/standardOptions/threshold/step.md | 34 + .../docs/panel/timeSeries/index.md | 1543 ++++++++ .../panel/timeSeries/panelOptions/link.md | 146 + .../timeSeries/queryOptions/transformation.md | 140 + .../timeSeries/standardOptions/mapping.md | 445 +++ .../timeSeries/standardOptions/override.md | 244 ++ .../standardOptions/threshold/step.md | 34 + .../docs/panel/trend/index.md | 1496 ++++++++ .../docs/panel/trend/panelOptions/link.md | 146 + .../trend/queryOptions/transformation.md | 140 + .../panel/trend/standardOptions/mapping.md | 445 +++ .../panel/trend/standardOptions/override.md | 244 ++ .../trend/standardOptions/threshold/step.md | 34 + .../docs/panel/xyChart/index.md | 1574 ++++++++ .../docs/panel/xyChart/options/series.md | 663 ++++ .../docs/panel/xyChart/panelOptions/link.md | 146 + .../xyChart/queryOptions/transformation.md | 140 + .../panel/xyChart/standardOptions/mapping.md | 445 +++ .../panel/xyChart/standardOptions/override.md | 244 ++ .../xyChart/standardOptions/threshold/step.md | 34 + gen/grafonnet-v11.0.0/docs/preferences.md | 210 ++ gen/grafonnet-v11.0.0/docs/publicdashboard.md | 84 + .../azureMonitor/dimensionFilters.md | 69 + .../azuremonitor/azureMonitor/resources.md | 68 + .../query/azuremonitor/azureTraces/filters.md | 57 + .../docs/query/azuremonitor/index.md | 1513 ++++++++ .../CloudWatchLogsQuery/logGroups.md | 57 + .../parameters.md | 29 + .../sql/orderBy/parameters.md | 29 + .../sql/select/parameters.md | 29 + .../docs/query/cloudwatch/index.md | 1299 +++++++ .../bucketAggs/Filters/settings/filters.md | 32 + .../docs/query/elasticsearch/index.md | 3256 +++++++++++++++++ .../BucketScript/pipelineVariables.md | 32 + .../BucketScript/pipelineVariables.md | 32 + .../docs/query/googlecloudmonitoring.md | 624 ++++ .../docs/query/grafanapyroscope.md | 154 + gen/grafonnet-v11.0.0/docs/query/index.md | 15 + gen/grafonnet-v11.0.0/docs/query/loki.md | 181 + gen/grafonnet-v11.0.0/docs/query/parca.md | 94 + .../docs/query/prometheus.md | 196 + .../docs/query/tempo/filters.md | 94 + .../docs/query/tempo/groupBy.md | 94 + .../docs/query/tempo/index.md | 289 ++ gen/grafonnet-v11.0.0/docs/role.md | 81 + gen/grafonnet-v11.0.0/docs/rolebinding.md | 189 + gen/grafonnet-v11.0.0/docs/team.md | 33 + gen/grafonnet-v11.0.0/docs/util.md | 285 ++ gen/grafonnet-v11.0.0/folder.libsonnet | 16 + gen/grafonnet-v11.0.0/jsonnetfile.json | 24 + gen/grafonnet-v11.0.0/librarypanel.libsonnet | 1130 ++++++ gen/grafonnet-v11.0.0/main.libsonnet | 26 + gen/grafonnet-v11.0.0/panel.libsonnet | 791 ++++ .../panel/alertList.libsonnet | 19 + .../panel/annotationsList.libsonnet | 94 + .../panel/barChart.libsonnet | 553 +++ .../panel/barGauge.libsonnet | 168 + .../panel/candlestick.libsonnet | 830 +++++ gen/grafonnet-v11.0.0/panel/canvas.libsonnet | 544 +++ .../panel/dashboardList.libsonnet | 100 + .../panel/datagrid.libsonnet | 28 + gen/grafonnet-v11.0.0/panel/debug.libsonnet | 67 + gen/grafonnet-v11.0.0/panel/gauge.libsonnet | 150 + gen/grafonnet-v11.0.0/panel/geomap.libsonnet | 486 +++ gen/grafonnet-v11.0.0/panel/heatmap.libsonnet | 839 +++++ .../panel/histogram.libsonnet | 486 +++ gen/grafonnet-v11.0.0/panel/logs.libsonnet | 76 + gen/grafonnet-v11.0.0/panel/news.libsonnet | 34 + .../panel/nodeGraph.libsonnet | 118 + .../panel/pieChart.libsonnet | 380 ++ gen/grafonnet-v11.0.0/panel/row.libsonnet | 103 + gen/grafonnet-v11.0.0/panel/stat.libsonnet | 156 + .../panel/stateTimeline.libsonnet | 309 ++ .../panel/statusHistory.libsonnet | 303 ++ gen/grafonnet-v11.0.0/panel/table.libsonnet | 1274 +++++++ gen/grafonnet-v11.0.0/panel/text.libsonnet | 73 + .../panel/timeSeries.libsonnet | 747 ++++ gen/grafonnet-v11.0.0/panel/trend.libsonnet | 718 ++++ gen/grafonnet-v11.0.0/panel/xyChart.libsonnet | 1070 ++++++ gen/grafonnet-v11.0.0/panelindex.libsonnet | 30 + gen/grafonnet-v11.0.0/preferences.libsonnet | 88 + .../publicdashboard.libsonnet | 28 + gen/grafonnet-v11.0.0/query.libsonnet | 13 + .../query/azuremonitor.libsonnet | 859 +++++ .../query/cloudwatch.libsonnet | 692 ++++ .../query/elasticsearch.libsonnet | 1451 ++++++++ .../query/googlecloudmonitoring.libsonnet | 298 ++ .../query/grafanapyroscope.libsonnet | 64 + gen/grafonnet-v11.0.0/query/loki.libsonnet | 57 + gen/grafonnet-v11.0.0/query/parca.libsonnet | 32 + .../query/prometheus.libsonnet | 61 + gen/grafonnet-v11.0.0/query/tempo.libsonnet | 165 + .../raw/alerting/contactPoint.libsonnet | 32 + .../raw/alerting/messageTemplate.libsonnet | 16 + .../raw/alerting/muteTiming.libsonnet | 134 + .../raw/alerting/notificationPolicy.libsonnet | 130 + .../raw/alerting/ruleGroup.libsonnet | 234 ++ gen/grafonnet-v11.0.0/role.libsonnet | 28 + gen/grafonnet-v11.0.0/rolebinding.libsonnet | 92 + gen/grafonnet-v11.0.0/team.libsonnet | 12 + 424 files changed, 93015 insertions(+), 6438 deletions(-) create mode 100644 docs/API/alerting/muteTiming/interval/time_intervals/index.md create mode 100644 docs/API/alerting/muteTiming/interval/time_intervals/times.md delete mode 100644 docs/API/alerting/muteTiming/interval/times.md delete mode 100644 docs/API/librarypanel.md create mode 100644 docs/API/librarypanel/index.md create mode 100644 docs/API/librarypanel/model/fieldConfig/defaults/thresholds/steps.md create mode 100644 docs/API/librarypanel/model/fieldConfig/overrides/index.md create mode 100644 docs/API/librarypanel/model/fieldConfig/overrides/properties.md create mode 100644 docs/API/librarypanel/model/links.md create mode 100644 docs/API/librarypanel/model/transformations.md rename docs/API/panel/canvas/options/root/elements/{connections.md => connections/index.md} (64%) create mode 100644 docs/API/panel/canvas/options/root/elements/connections/vertices.md rename docs/API/query/{azureMonitor => azuremonitor}/azureMonitor/dimensionFilters.md (100%) rename docs/API/query/{azureMonitor => azuremonitor}/azureMonitor/resources.md (100%) rename docs/API/query/{azureMonitor => azuremonitor}/azureTraces/filters.md (100%) rename docs/API/query/{azureMonitor => azuremonitor}/index.md (92%) rename docs/API/query/{cloudWatch => cloudwatch}/CloudWatchLogsQuery/logGroups.md (100%) rename docs/API/query/{cloudWatch => cloudwatch}/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md (68%) rename docs/API/query/{cloudWatch => cloudwatch}/CloudWatchMetricsQuery/sql/orderBy/parameters.md (68%) rename docs/API/query/{cloudWatch => cloudwatch}/CloudWatchMetricsQuery/sql/select/parameters.md (68%) rename docs/API/query/{cloudWatch => cloudwatch}/index.md (93%) delete mode 100644 docs/API/query/elasticsearch/bucketAggs/index.md delete mode 100644 docs/API/query/elasticsearch/metrics/index.md rename docs/API/query/{googleCloudMonitoring.md => googlecloudmonitoring.md} (92%) rename docs/API/query/{grafanaPyroscope.md => grafanapyroscope.md} (60%) delete mode 100644 docs/API/query/testData/csvWave.md delete mode 100644 docs/API/query/testData/index.md create mode 100644 gen/grafonnet-v11.0.0/accesspolicy.libsonnet create mode 100644 gen/grafonnet-v11.0.0/alerting.libsonnet create mode 100644 gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet create mode 100644 gen/grafonnet-v11.0.0/clean/alerting/messageTemplate.libsonnet create mode 100644 gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet create mode 100644 gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet create mode 100644 gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/dashboard.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/panel.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/loki.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/row.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/util/grid.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/util/main.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/util/panel.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/util/string.libsonnet create mode 100644 gen/grafonnet-v11.0.0/dashboard.libsonnet create mode 100644 gen/grafonnet-v11.0.0/docs/README.md create mode 100644 gen/grafonnet-v11.0.0/docs/accesspolicy/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/messageTemplate.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md create mode 100644 gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/dashboard/annotation.md create mode 100644 gen/grafonnet-v11.0.0/docs/dashboard/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/dashboard/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/dashboard/variable.md create mode 100644 gen/grafonnet-v11.0.0/docs/folder.md create mode 100644 gen/grafonnet-v11.0.0/docs/librarypanel/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md create mode 100644 gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md create mode 100644 gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md create mode 100644 gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/alertList/index.md rename {docs/API/panel/alertGroups => gen/grafonnet-v11.0.0/docs/panel/alertList}/panelOptions/link.md (100%) rename {docs/API/panel/alertGroups => gen/grafonnet-v11.0.0/docs/panel/alertList}/queryOptions/transformation.md (80%) rename {docs/API/panel/alertGroups => gen/grafonnet-v11.0.0/docs/panel/alertList}/standardOptions/mapping.md (94%) rename {docs/API/panel/alertGroups => gen/grafonnet-v11.0.0/docs/panel/alertList}/standardOptions/override.md (100%) rename {docs/API/panel/alertGroups => gen/grafonnet-v11.0.0/docs/panel/alertList}/standardOptions/threshold/step.md (95%) create mode 100644 gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barChart/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/debug/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/gauge/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/histogram/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/logs/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md rename {docs/API/panel/alertGroups => gen/grafonnet-v11.0.0/docs/panel/news}/index.md (96%) create mode 100644 gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/row.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stat/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/text/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/trend/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md create mode 100644 gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md create mode 100644 gen/grafonnet-v11.0.0/docs/preferences.md create mode 100644 gen/grafonnet-v11.0.0/docs/publicdashboard.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/dimensionFilters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/resources.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureTraces/filters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchLogsQuery/logGroups.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/loki.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/parca.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/prometheus.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/tempo/filters.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/tempo/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/role.md create mode 100644 gen/grafonnet-v11.0.0/docs/rolebinding.md create mode 100644 gen/grafonnet-v11.0.0/docs/team.md create mode 100644 gen/grafonnet-v11.0.0/docs/util.md create mode 100644 gen/grafonnet-v11.0.0/folder.libsonnet create mode 100644 gen/grafonnet-v11.0.0/jsonnetfile.json create mode 100644 gen/grafonnet-v11.0.0/librarypanel.libsonnet create mode 100644 gen/grafonnet-v11.0.0/main.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/alertList.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/barChart.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/barGauge.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/candlestick.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/canvas.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/datagrid.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/debug.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/gauge.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/geomap.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/heatmap.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/histogram.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/logs.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/news.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/pieChart.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/row.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/stat.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/table.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/text.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/trend.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panel/xyChart.libsonnet create mode 100644 gen/grafonnet-v11.0.0/panelindex.libsonnet create mode 100644 gen/grafonnet-v11.0.0/preferences.libsonnet create mode 100644 gen/grafonnet-v11.0.0/publicdashboard.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/loki.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/parca.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/prometheus.libsonnet create mode 100644 gen/grafonnet-v11.0.0/query/tempo.libsonnet create mode 100644 gen/grafonnet-v11.0.0/raw/alerting/contactPoint.libsonnet create mode 100644 gen/grafonnet-v11.0.0/raw/alerting/messageTemplate.libsonnet create mode 100644 gen/grafonnet-v11.0.0/raw/alerting/muteTiming.libsonnet create mode 100644 gen/grafonnet-v11.0.0/raw/alerting/notificationPolicy.libsonnet create mode 100644 gen/grafonnet-v11.0.0/raw/alerting/ruleGroup.libsonnet create mode 100644 gen/grafonnet-v11.0.0/role.libsonnet create mode 100644 gen/grafonnet-v11.0.0/rolebinding.libsonnet create mode 100644 gen/grafonnet-v11.0.0/team.libsonnet diff --git a/docs/API/accesspolicy/rules.md b/docs/API/accesspolicy/rules.md index 6f328d41..86de7c06 100644 --- a/docs/API/accesspolicy/rules.md +++ b/docs/API/accesspolicy/rules.md @@ -5,8 +5,10 @@ ## Index * [`fn withKind(value)`](#fn-withkind) +* [`fn withKindMixin(value)`](#fn-withkindmixin) * [`fn withTarget(value)`](#fn-withtarget) * [`fn withVerb(value)`](#fn-withverb) +* [`fn withVerbMixin(value)`](#fn-withverbmixin) ## Fields @@ -20,6 +22,17 @@ PARAMETERS: * **value** (`string`) +The kind this rule applies to (dashboards, alert, etc) +### fn withKindMixin + +```jsonnet +withKindMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + The kind this rule applies to (dashboards, alert, etc) ### fn withTarget @@ -42,5 +55,17 @@ PARAMETERS: * **value** (`string`) +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" +### fn withVerbMixin + +```jsonnet +withVerbMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + READ, WRITE, CREATE, DELETE, ... should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" \ No newline at end of file diff --git a/docs/API/alerting/muteTiming/interval/index.md b/docs/API/alerting/muteTiming/interval/index.md index aecdd1d9..18021fc9 100644 --- a/docs/API/alerting/muteTiming/interval/index.md +++ b/docs/API/alerting/muteTiming/interval/index.md @@ -4,50 +4,20 @@ ## Subpackages -* [times](times.md) +* [time_intervals](time_intervals/index.md) ## Index -* [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) -* [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) -* [`fn withLocation(value)`](#fn-withlocation) -* [`fn withMonths(value)`](#fn-withmonths) -* [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) -* [`fn withTimes(value)`](#fn-withtimes) -* [`fn withTimesMixin(value)`](#fn-withtimesmixin) -* [`fn withWeekdays(value)`](#fn-withweekdays) -* [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) -* [`fn withYears(value)`](#fn-withyears) -* [`fn withYearsMixin(value)`](#fn-withyearsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeIntervals(value)`](#fn-withtimeintervals) +* [`fn withTimeIntervalsMixin(value)`](#fn-withtimeintervalsmixin) ## Fields -### fn withDaysOfMonth +### fn withName ```jsonnet -withDaysOfMonth(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withDaysOfMonthMixin - -```jsonnet -withDaysOfMonthMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withLocation - -```jsonnet -withLocation(value) +withName(value) ``` PARAMETERS: @@ -55,76 +25,10 @@ PARAMETERS: * **value** (`string`) -### fn withMonths - -```jsonnet -withMonths(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withMonthsMixin - -```jsonnet -withMonthsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withTimes - -```jsonnet -withTimes(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withTimesMixin - -```jsonnet -withTimesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withWeekdays - -```jsonnet -withWeekdays(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withWeekdaysMixin - -```jsonnet -withWeekdaysMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withYears +### fn withTimeIntervals ```jsonnet -withYears(value) +withTimeIntervals(value) ``` PARAMETERS: @@ -132,10 +36,10 @@ PARAMETERS: * **value** (`array`) -### fn withYearsMixin +### fn withTimeIntervalsMixin ```jsonnet -withYearsMixin(value) +withTimeIntervalsMixin(value) ``` PARAMETERS: diff --git a/docs/API/alerting/muteTiming/interval/time_intervals/index.md b/docs/API/alerting/muteTiming/interval/time_intervals/index.md new file mode 100644 index 00000000..e649ec25 --- /dev/null +++ b/docs/API/alerting/muteTiming/interval/time_intervals/index.md @@ -0,0 +1,144 @@ +# time_intervals + + + +## Subpackages + +* [times](times.md) + +## Index + +* [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) +* [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withMonths(value)`](#fn-withmonths) +* [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) +* [`fn withTimes(value)`](#fn-withtimes) +* [`fn withTimesMixin(value)`](#fn-withtimesmixin) +* [`fn withWeekdays(value)`](#fn-withweekdays) +* [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) +* [`fn withYears(value)`](#fn-withyears) +* [`fn withYearsMixin(value)`](#fn-withyearsmixin) + +## Fields + +### fn withDaysOfMonth + +```jsonnet +withDaysOfMonth(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDaysOfMonthMixin + +```jsonnet +withDaysOfMonthMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMonths + +```jsonnet +withMonths(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMonthsMixin + +```jsonnet +withMonthsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimes + +```jsonnet +withTimes(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimesMixin + +```jsonnet +withTimesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdays + +```jsonnet +withWeekdays(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdaysMixin + +```jsonnet +withWeekdaysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYears + +```jsonnet +withYears(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYearsMixin + +```jsonnet +withYearsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/docs/API/alerting/muteTiming/interval/time_intervals/times.md b/docs/API/alerting/muteTiming/interval/time_intervals/times.md new file mode 100644 index 00000000..8304969e --- /dev/null +++ b/docs/API/alerting/muteTiming/interval/time_intervals/times.md @@ -0,0 +1,32 @@ +# times + + + +## Index + +* [`fn withEndTime(value)`](#fn-withendtime) +* [`fn withStartTime(value)`](#fn-withstarttime) + +## Fields + +### fn withEndTime + +```jsonnet +withEndTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withStartTime + +```jsonnet +withStartTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/API/alerting/muteTiming/interval/times.md b/docs/API/alerting/muteTiming/interval/times.md deleted file mode 100644 index 43f7b3fe..00000000 --- a/docs/API/alerting/muteTiming/interval/times.md +++ /dev/null @@ -1,32 +0,0 @@ -# times - - - -## Index - -* [`fn withFrom(value)`](#fn-withfrom) -* [`fn withTo(value)`](#fn-withto) - -## Fields - -### fn withFrom - -```jsonnet -withFrom(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withTo - -```jsonnet -withTo(value) -``` - -PARAMETERS: - -* **value** (`string`) - diff --git a/docs/API/index.md b/docs/API/index.md index 89658610..05bd30a7 100644 --- a/docs/API/index.md +++ b/docs/API/index.md @@ -8,7 +8,7 @@ * [alerting](alerting/index.md) * [dashboard](dashboard/index.md) * [folder](folder.md) -* [librarypanel](librarypanel.md) +* [librarypanel](librarypanel/index.md) * [panel](panel/index.md) * [preferences](preferences.md) * [publicdashboard](publicdashboard.md) diff --git a/docs/API/librarypanel.md b/docs/API/librarypanel.md deleted file mode 100644 index c4244ce4..00000000 --- a/docs/API/librarypanel.md +++ /dev/null @@ -1,334 +0,0 @@ -# librarypanel - -grafonnet.librarypanel - -## Index - -* [`fn withDescription(value)`](#fn-withdescription) -* [`fn withFolderUid(value)`](#fn-withfolderuid) -* [`fn withMeta(value)`](#fn-withmeta) -* [`fn withMetaMixin(value)`](#fn-withmetamixin) -* [`fn withModel(value)`](#fn-withmodel) -* [`fn withModelMixin(value)`](#fn-withmodelmixin) -* [`fn withName(value)`](#fn-withname) -* [`fn withSchemaVersion(value)`](#fn-withschemaversion) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUid(value)`](#fn-withuid) -* [`fn withVersion(value)`](#fn-withversion) -* [`obj meta`](#obj-meta) - * [`fn withConnectedDashboards(value)`](#fn-metawithconnecteddashboards) - * [`fn withCreated(value)`](#fn-metawithcreated) - * [`fn withCreatedBy(value)`](#fn-metawithcreatedby) - * [`fn withCreatedByMixin(value)`](#fn-metawithcreatedbymixin) - * [`fn withFolderName(value)`](#fn-metawithfoldername) - * [`fn withFolderUid(value)`](#fn-metawithfolderuid) - * [`fn withUpdated(value)`](#fn-metawithupdated) - * [`fn withUpdatedBy(value)`](#fn-metawithupdatedby) - * [`fn withUpdatedByMixin(value)`](#fn-metawithupdatedbymixin) - * [`obj createdBy`](#obj-metacreatedby) - * [`fn withAvatarUrl(value)`](#fn-metacreatedbywithavatarurl) - * [`fn withId(value)`](#fn-metacreatedbywithid) - * [`fn withName(value)`](#fn-metacreatedbywithname) - * [`obj updatedBy`](#obj-metaupdatedby) - * [`fn withAvatarUrl(value)`](#fn-metaupdatedbywithavatarurl) - * [`fn withId(value)`](#fn-metaupdatedbywithid) - * [`fn withName(value)`](#fn-metaupdatedbywithname) - -## Fields - -### fn withDescription - -```jsonnet -withDescription(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Panel description -### fn withFolderUid - -```jsonnet -withFolderUid(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Folder UID -### fn withMeta - -```jsonnet -withMeta(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withMetaMixin - -```jsonnet -withMetaMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withModel - -```jsonnet -withModel(value) -``` - -PARAMETERS: - -* **value** (`object`) - -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; -### fn withModelMixin - -```jsonnet -withModelMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; -### fn withName - -```jsonnet -withName(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Panel name (also saved in the model) -### fn withSchemaVersion - -```jsonnet -withSchemaVersion(value) -``` - -PARAMETERS: - -* **value** (`integer`) - -Dashboard version when this was saved (zero if unknown) -### fn withType - -```jsonnet -withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The panel type (from inside the model) -### fn withUid - -```jsonnet -withUid(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Library element UID -### fn withVersion - -```jsonnet -withVersion(value) -``` - -PARAMETERS: - -* **value** (`integer`) - -panel version, incremented each time the dashboard is updated. -### obj meta - - -#### fn meta.withConnectedDashboards - -```jsonnet -meta.withConnectedDashboards(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn meta.withCreated - -```jsonnet -meta.withCreated(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn meta.withCreatedBy - -```jsonnet -meta.withCreatedBy(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn meta.withCreatedByMixin - -```jsonnet -meta.withCreatedByMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn meta.withFolderName - -```jsonnet -meta.withFolderName(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn meta.withFolderUid - -```jsonnet -meta.withFolderUid(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn meta.withUpdated - -```jsonnet -meta.withUpdated(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn meta.withUpdatedBy - -```jsonnet -meta.withUpdatedBy(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn meta.withUpdatedByMixin - -```jsonnet -meta.withUpdatedByMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### obj meta.createdBy - - -##### fn meta.createdBy.withAvatarUrl - -```jsonnet -meta.createdBy.withAvatarUrl(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn meta.createdBy.withId - -```jsonnet -meta.createdBy.withId(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -##### fn meta.createdBy.withName - -```jsonnet -meta.createdBy.withName(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj meta.updatedBy - - -##### fn meta.updatedBy.withAvatarUrl - -```jsonnet -meta.updatedBy.withAvatarUrl(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn meta.updatedBy.withId - -```jsonnet -meta.updatedBy.withId(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -##### fn meta.updatedBy.withName - -```jsonnet -meta.updatedBy.withName(value) -``` - -PARAMETERS: - -* **value** (`string`) - diff --git a/docs/API/librarypanel/index.md b/docs/API/librarypanel/index.md new file mode 100644 index 00000000..0592b470 --- /dev/null +++ b/docs/API/librarypanel/index.md @@ -0,0 +1,1599 @@ +# librarypanel + +grafonnet.librarypanel + +## Subpackages + +* [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md) +* [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md) +* [model.links](model/links.md) +* [model.transformations](model/transformations.md) + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withMeta(value)`](#fn-withmeta) +* [`fn withMetaMixin(value)`](#fn-withmetamixin) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withSchemaVersion(value)`](#fn-withschemaversion) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVersion(value)`](#fn-withversion) +* [`obj meta`](#obj-meta) + * [`fn withConnectedDashboards(value)`](#fn-metawithconnecteddashboards) + * [`fn withCreated(value)`](#fn-metawithcreated) + * [`fn withCreatedBy(value)`](#fn-metawithcreatedby) + * [`fn withCreatedByMixin(value)`](#fn-metawithcreatedbymixin) + * [`fn withFolderName(value)`](#fn-metawithfoldername) + * [`fn withFolderUid(value)`](#fn-metawithfolderuid) + * [`fn withUpdated(value)`](#fn-metawithupdated) + * [`fn withUpdatedBy(value)`](#fn-metawithupdatedby) + * [`fn withUpdatedByMixin(value)`](#fn-metawithupdatedbymixin) + * [`obj createdBy`](#obj-metacreatedby) + * [`fn withAvatarUrl(value)`](#fn-metacreatedbywithavatarurl) + * [`fn withId(value)`](#fn-metacreatedbywithid) + * [`fn withName(value)`](#fn-metacreatedbywithname) + * [`obj updatedBy`](#obj-metaupdatedby) + * [`fn withAvatarUrl(value)`](#fn-metaupdatedbywithavatarurl) + * [`fn withId(value)`](#fn-metaupdatedbywithid) + * [`fn withName(value)`](#fn-metaupdatedbywithname) +* [`obj model`](#obj-model) + * [`fn withCacheTimeout(value)`](#fn-modelwithcachetimeout) + * [`fn withDatasource(value)`](#fn-modelwithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-modelwithdatasourcemixin) + * [`fn withDescription(value)`](#fn-modelwithdescription) + * [`fn withFieldConfig(value)`](#fn-modelwithfieldconfig) + * [`fn withFieldConfigMixin(value)`](#fn-modelwithfieldconfigmixin) + * [`fn withHideTimeOverride(value=true)`](#fn-modelwithhidetimeoverride) + * [`fn withInterval(value)`](#fn-modelwithinterval) + * [`fn withLinks(value)`](#fn-modelwithlinks) + * [`fn withLinksMixin(value)`](#fn-modelwithlinksmixin) + * [`fn withMaxDataPoints(value)`](#fn-modelwithmaxdatapoints) + * [`fn withMaxPerRow(value)`](#fn-modelwithmaxperrow) + * [`fn withOptions(value)`](#fn-modelwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelwithoptionsmixin) + * [`fn withPluginVersion(value)`](#fn-modelwithpluginversion) + * [`fn withQueryCachingTTL(value)`](#fn-modelwithquerycachingttl) + * [`fn withRepeat(value)`](#fn-modelwithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-modelwithrepeatdirection) + * [`fn withTargets(value)`](#fn-modelwithtargets) + * [`fn withTargetsMixin(value)`](#fn-modelwithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-modelwithtimefrom) + * [`fn withTimeShift(value)`](#fn-modelwithtimeshift) + * [`fn withTitle(value)`](#fn-modelwithtitle) + * [`fn withTransformations(value)`](#fn-modelwithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-modelwithtransformationsmixin) + * [`fn withTransparent(value=true)`](#fn-modelwithtransparent) + * [`fn withType(value)`](#fn-modelwithtype) + * [`obj datasource`](#obj-modeldatasource) + * [`fn withType(value)`](#fn-modeldatasourcewithtype) + * [`fn withUid(value)`](#fn-modeldatasourcewithuid) + * [`obj fieldConfig`](#obj-modelfieldconfig) + * [`fn withDefaults(value)`](#fn-modelfieldconfigwithdefaults) + * [`fn withDefaultsMixin(value)`](#fn-modelfieldconfigwithdefaultsmixin) + * [`fn withOverrides(value)`](#fn-modelfieldconfigwithoverrides) + * [`fn withOverridesMixin(value)`](#fn-modelfieldconfigwithoverridesmixin) + * [`obj defaults`](#obj-modelfieldconfigdefaults) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultswithcolor) + * [`fn withColorMixin(value)`](#fn-modelfieldconfigdefaultswithcolormixin) + * [`fn withCustom(value)`](#fn-modelfieldconfigdefaultswithcustom) + * [`fn withCustomMixin(value)`](#fn-modelfieldconfigdefaultswithcustommixin) + * [`fn withDecimals(value)`](#fn-modelfieldconfigdefaultswithdecimals) + * [`fn withDescription(value)`](#fn-modelfieldconfigdefaultswithdescription) + * [`fn withDisplayName(value)`](#fn-modelfieldconfigdefaultswithdisplayname) + * [`fn withDisplayNameFromDS(value)`](#fn-modelfieldconfigdefaultswithdisplaynamefromds) + * [`fn withFilterable(value=true)`](#fn-modelfieldconfigdefaultswithfilterable) + * [`fn withLinks(value)`](#fn-modelfieldconfigdefaultswithlinks) + * [`fn withLinksMixin(value)`](#fn-modelfieldconfigdefaultswithlinksmixin) + * [`fn withMappings(value)`](#fn-modelfieldconfigdefaultswithmappings) + * [`fn withMappingsMixin(value)`](#fn-modelfieldconfigdefaultswithmappingsmixin) + * [`fn withMax(value)`](#fn-modelfieldconfigdefaultswithmax) + * [`fn withMin(value)`](#fn-modelfieldconfigdefaultswithmin) + * [`fn withNoValue(value)`](#fn-modelfieldconfigdefaultswithnovalue) + * [`fn withPath(value)`](#fn-modelfieldconfigdefaultswithpath) + * [`fn withThresholds(value)`](#fn-modelfieldconfigdefaultswiththresholds) + * [`fn withThresholdsMixin(value)`](#fn-modelfieldconfigdefaultswiththresholdsmixin) + * [`fn withUnit(value)`](#fn-modelfieldconfigdefaultswithunit) + * [`fn withWriteable(value=true)`](#fn-modelfieldconfigdefaultswithwriteable) + * [`obj color`](#obj-modelfieldconfigdefaultscolor) + * [`fn withFixedColor(value)`](#fn-modelfieldconfigdefaultscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-modelfieldconfigdefaultscolorwithseriesby) + * [`obj mappings`](#obj-modelfieldconfigdefaultsmappings) + * [`obj RangeMap`](#obj-modelfieldconfigdefaultsmappingsrangemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsrangemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsrangemapoptions) + * [`fn withFrom(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithto) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsrangemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithtext) + * [`obj RegexMap`](#obj-modelfieldconfigdefaultsmappingsregexmap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsregexmapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsregexmapoptions) + * [`fn withPattern(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsregexmapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithtext) + * [`obj SpecialValueMap`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptions) + * [`fn withMatch(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithtext) + * [`obj ValueMap`](#obj-modelfieldconfigdefaultsmappingsvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithtype) + * [`obj thresholds`](#obj-modelfieldconfigdefaultsthresholds) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultsthresholdswithmode) + * [`fn withSteps(value)`](#fn-modelfieldconfigdefaultsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-modelfieldconfigdefaultsthresholdswithstepsmixin) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder UID +### fn withMeta + +```jsonnet +withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withMetaMixin + +```jsonnet +withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: should be the same panel schema defined in dashboard +Typescript: Omit; +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: should be the same panel schema defined in dashboard +Typescript: Omit; +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel name (also saved in the model) +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Dashboard version when this was saved (zero if unknown) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel type (from inside the model) +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library element UID +### fn withVersion + +```jsonnet +withVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +panel version, incremented each time the dashboard is updated. +### obj meta + + +#### fn meta.withConnectedDashboards + +```jsonnet +meta.withConnectedDashboards(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn meta.withCreated + +```jsonnet +meta.withCreated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withCreatedBy + +```jsonnet +meta.withCreatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withCreatedByMixin + +```jsonnet +meta.withCreatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withFolderName + +```jsonnet +meta.withFolderName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withFolderUid + +```jsonnet +meta.withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdated + +```jsonnet +meta.withUpdated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdatedBy + +```jsonnet +meta.withUpdatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withUpdatedByMixin + +```jsonnet +meta.withUpdatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj meta.createdBy + + +##### fn meta.createdBy.withAvatarUrl + +```jsonnet +meta.createdBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.createdBy.withId + +```jsonnet +meta.createdBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.createdBy.withName + +```jsonnet +meta.createdBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj meta.updatedBy + + +##### fn meta.updatedBy.withAvatarUrl + +```jsonnet +meta.updatedBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.updatedBy.withId + +```jsonnet +meta.updatedBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.updatedBy.withName + +```jsonnet +meta.updatedBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj model + + +#### fn model.withCacheTimeout + +```jsonnet +model.withCacheTimeout(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets panel queries cache timeout. +#### fn model.withDatasource + +```jsonnet +model.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDatasourceMixin + +```jsonnet +model.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDescription + +```jsonnet +model.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn model.withFieldConfig + +```jsonnet +model.withFieldConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withFieldConfigMixin + +```jsonnet +model.withFieldConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withHideTimeOverride + +```jsonnet +model.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn model.withInterval + +```jsonnet +model.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withLinks + +```jsonnet +model.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withLinksMixin + +```jsonnet +model.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withMaxDataPoints + +```jsonnet +model.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn model.withMaxPerRow + +```jsonnet +model.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn model.withOptions + +```jsonnet +model.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withOptionsMixin + +```jsonnet +model.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withPluginVersion + +```jsonnet +model.withPluginVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs. +#### fn model.withQueryCachingTTL + +```jsonnet +model.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn model.withRepeat + +```jsonnet +model.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn model.withRepeatDirection + +```jsonnet +model.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn model.withTargets + +```jsonnet +model.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTargetsMixin + +```jsonnet +model.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTimeFrom + +```jsonnet +model.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTimeShift + +```jsonnet +model.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTitle + +```jsonnet +model.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn model.withTransformations + +```jsonnet +model.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransformationsMixin + +```jsonnet +model.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransparent + +```jsonnet +model.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +#### fn model.withType + +```jsonnet +model.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel plugin type id. This is used to find the plugin to display the panel. +#### obj model.datasource + + +##### fn model.datasource.withType + +```jsonnet +model.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn model.datasource.withUid + +```jsonnet +model.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +#### obj model.fieldConfig + + +##### fn model.fieldConfig.withDefaults + +```jsonnet +model.fieldConfig.withDefaults(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withDefaultsMixin + +```jsonnet +model.fieldConfig.withDefaultsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withOverrides + +```jsonnet +model.fieldConfig.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### fn model.fieldConfig.withOverridesMixin + +```jsonnet +model.fieldConfig.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### obj model.fieldConfig.defaults + + +###### fn model.fieldConfig.defaults.withColor + +```jsonnet +model.fieldConfig.defaults.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withColorMixin + +```jsonnet +model.fieldConfig.defaults.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withCustom + +```jsonnet +model.fieldConfig.defaults.withCustom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withCustomMixin + +```jsonnet +model.fieldConfig.defaults.withCustomMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withDecimals + +```jsonnet +model.fieldConfig.defaults.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +###### fn model.fieldConfig.defaults.withDescription + +```jsonnet +model.fieldConfig.defaults.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Human readable field metadata +###### fn model.fieldConfig.defaults.withDisplayName + +```jsonnet +model.fieldConfig.defaults.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +###### fn model.fieldConfig.defaults.withDisplayNameFromDS + +```jsonnet +model.fieldConfig.defaults.withDisplayNameFromDS(value) +``` + +PARAMETERS: + +* **value** (`string`) + +This can be used by data sources that return and explicit naming structure for values and labels +When this property is configured, this value is used rather than the default naming strategy. +###### fn model.fieldConfig.defaults.withFilterable + +```jsonnet +model.fieldConfig.defaults.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +###### fn model.fieldConfig.defaults.withLinks + +```jsonnet +model.fieldConfig.defaults.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withLinksMixin + +```jsonnet +model.fieldConfig.defaults.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withMappings + +```jsonnet +model.fieldConfig.defaults.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMappingsMixin + +```jsonnet +model.fieldConfig.defaults.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMax + +```jsonnet +model.fieldConfig.defaults.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withMin + +```jsonnet +model.fieldConfig.defaults.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withNoValue + +```jsonnet +model.fieldConfig.defaults.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +###### fn model.fieldConfig.defaults.withPath + +```jsonnet +model.fieldConfig.defaults.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +###### fn model.fieldConfig.defaults.withThresholds + +```jsonnet +model.fieldConfig.defaults.withThresholds(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withThresholdsMixin + +```jsonnet +model.fieldConfig.defaults.withThresholdsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withUnit + +```jsonnet +model.fieldConfig.defaults.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +###### fn model.fieldConfig.defaults.withWriteable + +```jsonnet +model.fieldConfig.defaults.withWriteable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source can write a value to the path. Auth/authz are supported separately +###### obj model.fieldConfig.defaults.color + + +####### fn model.fieldConfig.defaults.color.withFixedColor + +```jsonnet +model.fieldConfig.defaults.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +####### fn model.fieldConfig.defaults.color.withMode + +```jsonnet +model.fieldConfig.defaults.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +####### fn model.fieldConfig.defaults.color.withSeriesBy + +```jsonnet +model.fieldConfig.defaults.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +###### obj model.fieldConfig.defaults.mappings + + +####### obj model.fieldConfig.defaults.mappings.RangeMap + + +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RangeMap.options + + +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withFrom + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withTo + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +######### obj model.fieldConfig.defaults.mappings.RangeMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.RegexMap + + +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RegexMap.options + + +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withPattern + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.RegexMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.SpecialValueMap + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.SpecialValueMap.options + + +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.SpecialValueMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.ValueMap + + +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withType() +``` + + + +###### obj model.fieldConfig.defaults.thresholds + + +####### fn model.fieldConfig.defaults.thresholds.withMode + +```jsonnet +model.fieldConfig.defaults.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +####### fn model.fieldConfig.defaults.thresholds.withSteps + +```jsonnet +model.fieldConfig.defaults.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +####### fn model.fieldConfig.defaults.thresholds.withStepsMixin + +```jsonnet +model.fieldConfig.defaults.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/docs/API/librarypanel/model/fieldConfig/defaults/thresholds/steps.md b/docs/API/librarypanel/model/fieldConfig/defaults/thresholds/steps.md new file mode 100644 index 00000000..79d0a171 --- /dev/null +++ b/docs/API/librarypanel/model/fieldConfig/defaults/thresholds/steps.md @@ -0,0 +1,34 @@ +# steps + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/librarypanel/model/fieldConfig/overrides/index.md b/docs/API/librarypanel/model/fieldConfig/overrides/index.md new file mode 100644 index 00000000..35b01d5e --- /dev/null +++ b/docs/API/librarypanel/model/fieldConfig/overrides/index.md @@ -0,0 +1,104 @@ +# overrides + + + +## Subpackages + +* [properties](properties.md) + +## Index + +* [`fn withMatcher(value)`](#fn-withmatcher) +* [`fn withMatcherMixin(value)`](#fn-withmatchermixin) +* [`fn withProperties(value)`](#fn-withproperties) +* [`fn withPropertiesMixin(value)`](#fn-withpropertiesmixin) +* [`obj matcher`](#obj-matcher) + * [`fn withId(value="")`](#fn-matcherwithid) + * [`fn withOptions(value)`](#fn-matcherwithoptions) + * [`fn withOptionsMixin(value)`](#fn-matcherwithoptionsmixin) + +## Fields + +### fn withMatcher + +```jsonnet +withMatcher(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withMatcherMixin + +```jsonnet +withMatcherMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withProperties + +```jsonnet +withProperties(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPropertiesMixin + +```jsonnet +withPropertiesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj matcher + + +#### fn matcher.withId + +```jsonnet +matcher.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn matcher.withOptions + +```jsonnet +matcher.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn matcher.withOptionsMixin + +```jsonnet +matcher.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/librarypanel/model/fieldConfig/overrides/properties.md b/docs/API/librarypanel/model/fieldConfig/overrides/properties.md new file mode 100644 index 00000000..766e1987 --- /dev/null +++ b/docs/API/librarypanel/model/fieldConfig/overrides/properties.md @@ -0,0 +1,45 @@ +# properties + + + +## Index + +* [`fn withId(value="")`](#fn-withid) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) + +## Fields + +### fn withId + +```jsonnet +withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + diff --git a/docs/API/librarypanel/model/links.md b/docs/API/librarypanel/model/links.md new file mode 100644 index 00000000..fcc060a9 --- /dev/null +++ b/docs/API/librarypanel/model/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/docs/API/librarypanel/model/transformations.md b/docs/API/librarypanel/model/transformations.md new file mode 100644 index 00000000..df55608e --- /dev/null +++ b/docs/API/librarypanel/model/transformations.md @@ -0,0 +1,140 @@ +# transformations + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/alertList/index.md b/docs/API/panel/alertList/index.md index 6a2b1e89..66807e33 100644 --- a/docs/API/panel/alertList/index.md +++ b/docs/API/panel/alertList/index.md @@ -16,56 +16,6 @@ grafonnet.panel.alertList * [`obj libraryPanel`](#obj-librarypanel) * [`fn withName(value)`](#fn-librarypanelwithname) * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withAlertListOptions(value)`](#fn-optionswithalertlistoptions) - * [`fn withAlertListOptionsMixin(value)`](#fn-optionswithalertlistoptionsmixin) - * [`fn withUnifiedAlertListOptions(value)`](#fn-optionswithunifiedalertlistoptions) - * [`fn withUnifiedAlertListOptionsMixin(value)`](#fn-optionswithunifiedalertlistoptionsmixin) - * [`obj AlertListOptions`](#obj-optionsalertlistoptions) - * [`fn withAlertName(value)`](#fn-optionsalertlistoptionswithalertname) - * [`fn withDashboardAlerts(value=true)`](#fn-optionsalertlistoptionswithdashboardalerts) - * [`fn withDashboardTitle(value)`](#fn-optionsalertlistoptionswithdashboardtitle) - * [`fn withFolderId(value)`](#fn-optionsalertlistoptionswithfolderid) - * [`fn withMaxItems(value)`](#fn-optionsalertlistoptionswithmaxitems) - * [`fn withShowOptions(value)`](#fn-optionsalertlistoptionswithshowoptions) - * [`fn withSortOrder(value)`](#fn-optionsalertlistoptionswithsortorder) - * [`fn withStateFilter(value)`](#fn-optionsalertlistoptionswithstatefilter) - * [`fn withStateFilterMixin(value)`](#fn-optionsalertlistoptionswithstatefiltermixin) - * [`fn withTags(value)`](#fn-optionsalertlistoptionswithtags) - * [`fn withTagsMixin(value)`](#fn-optionsalertlistoptionswithtagsmixin) - * [`obj stateFilter`](#obj-optionsalertlistoptionsstatefilter) - * [`fn withAlerting(value=true)`](#fn-optionsalertlistoptionsstatefilterwithalerting) - * [`fn withExecutionError(value=true)`](#fn-optionsalertlistoptionsstatefilterwithexecutionerror) - * [`fn withNoData(value=true)`](#fn-optionsalertlistoptionsstatefilterwithnodata) - * [`fn withOk(value=true)`](#fn-optionsalertlistoptionsstatefilterwithok) - * [`fn withPaused(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpaused) - * [`fn withPending(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpending) - * [`obj UnifiedAlertListOptions`](#obj-optionsunifiedalertlistoptions) - * [`fn withAlertInstanceLabelFilter(value)`](#fn-optionsunifiedalertlistoptionswithalertinstancelabelfilter) - * [`fn withAlertName(value)`](#fn-optionsunifiedalertlistoptionswithalertname) - * [`fn withDashboardAlerts(value=true)`](#fn-optionsunifiedalertlistoptionswithdashboardalerts) - * [`fn withDatasource(value)`](#fn-optionsunifiedalertlistoptionswithdatasource) - * [`fn withFolder(value)`](#fn-optionsunifiedalertlistoptionswithfolder) - * [`fn withFolderMixin(value)`](#fn-optionsunifiedalertlistoptionswithfoldermixin) - * [`fn withGroupBy(value)`](#fn-optionsunifiedalertlistoptionswithgroupby) - * [`fn withGroupByMixin(value)`](#fn-optionsunifiedalertlistoptionswithgroupbymixin) - * [`fn withGroupMode(value)`](#fn-optionsunifiedalertlistoptionswithgroupmode) - * [`fn withMaxItems(value)`](#fn-optionsunifiedalertlistoptionswithmaxitems) - * [`fn withShowInstances(value=true)`](#fn-optionsunifiedalertlistoptionswithshowinstances) - * [`fn withSortOrder(value)`](#fn-optionsunifiedalertlistoptionswithsortorder) - * [`fn withStateFilter(value)`](#fn-optionsunifiedalertlistoptionswithstatefilter) - * [`fn withStateFilterMixin(value)`](#fn-optionsunifiedalertlistoptionswithstatefiltermixin) - * [`fn withViewMode(value)`](#fn-optionsunifiedalertlistoptionswithviewmode) - * [`obj folder`](#obj-optionsunifiedalertlistoptionsfolder) - * [`fn withId(value)`](#fn-optionsunifiedalertlistoptionsfolderwithid) - * [`fn withTitle(value)`](#fn-optionsunifiedalertlistoptionsfolderwithtitle) - * [`obj stateFilter`](#obj-optionsunifiedalertlistoptionsstatefilter) - * [`fn withError(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwitherror) - * [`fn withFiring(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithfiring) - * [`fn withInactive(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithinactive) - * [`fn withNoData(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnodata) - * [`fn withNormal(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnormal) - * [`fn withPending(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithpending) * [`obj panelOptions`](#obj-paneloptions) * [`fn withDescription(value)`](#fn-paneloptionswithdescription) * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) @@ -148,528 +98,6 @@ PARAMETERS: * **value** (`string`) Library panel uid -### obj options - - -#### fn options.withAlertListOptions - -```jsonnet -options.withAlertListOptions(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn options.withAlertListOptionsMixin - -```jsonnet -options.withAlertListOptionsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn options.withUnifiedAlertListOptions - -```jsonnet -options.withUnifiedAlertListOptions(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn options.withUnifiedAlertListOptionsMixin - -```jsonnet -options.withUnifiedAlertListOptionsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### obj options.AlertListOptions - - -##### fn options.AlertListOptions.withAlertName - -```jsonnet -options.AlertListOptions.withAlertName(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn options.AlertListOptions.withDashboardAlerts - -```jsonnet -options.AlertListOptions.withDashboardAlerts(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn options.AlertListOptions.withDashboardTitle - -```jsonnet -options.AlertListOptions.withDashboardTitle(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn options.AlertListOptions.withFolderId - -```jsonnet -options.AlertListOptions.withFolderId(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -##### fn options.AlertListOptions.withMaxItems - -```jsonnet -options.AlertListOptions.withMaxItems(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -##### fn options.AlertListOptions.withShowOptions - -```jsonnet -options.AlertListOptions.withShowOptions(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"current"`, `"changes"` - - -##### fn options.AlertListOptions.withSortOrder - -```jsonnet -options.AlertListOptions.withSortOrder(value) -``` - -PARAMETERS: - -* **value** (`number`) - - valid values: `1`, `2`, `3`, `4`, `5` - - -##### fn options.AlertListOptions.withStateFilter - -```jsonnet -options.AlertListOptions.withStateFilter(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.AlertListOptions.withStateFilterMixin - -```jsonnet -options.AlertListOptions.withStateFilterMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.AlertListOptions.withTags - -```jsonnet -options.AlertListOptions.withTags(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn options.AlertListOptions.withTagsMixin - -```jsonnet -options.AlertListOptions.withTagsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### obj options.AlertListOptions.stateFilter - - -###### fn options.AlertListOptions.stateFilter.withAlerting - -```jsonnet -options.AlertListOptions.stateFilter.withAlerting(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.AlertListOptions.stateFilter.withExecutionError - -```jsonnet -options.AlertListOptions.stateFilter.withExecutionError(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.AlertListOptions.stateFilter.withNoData - -```jsonnet -options.AlertListOptions.stateFilter.withNoData(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.AlertListOptions.stateFilter.withOk - -```jsonnet -options.AlertListOptions.stateFilter.withOk(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.AlertListOptions.stateFilter.withPaused - -```jsonnet -options.AlertListOptions.stateFilter.withPaused(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.AlertListOptions.stateFilter.withPending - -```jsonnet -options.AlertListOptions.stateFilter.withPending(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -#### obj options.UnifiedAlertListOptions - - -##### fn options.UnifiedAlertListOptions.withAlertInstanceLabelFilter - -```jsonnet -options.UnifiedAlertListOptions.withAlertInstanceLabelFilter(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn options.UnifiedAlertListOptions.withAlertName - -```jsonnet -options.UnifiedAlertListOptions.withAlertName(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn options.UnifiedAlertListOptions.withDashboardAlerts - -```jsonnet -options.UnifiedAlertListOptions.withDashboardAlerts(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn options.UnifiedAlertListOptions.withDatasource - -```jsonnet -options.UnifiedAlertListOptions.withDatasource(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn options.UnifiedAlertListOptions.withFolder - -```jsonnet -options.UnifiedAlertListOptions.withFolder(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.UnifiedAlertListOptions.withFolderMixin - -```jsonnet -options.UnifiedAlertListOptions.withFolderMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.UnifiedAlertListOptions.withGroupBy - -```jsonnet -options.UnifiedAlertListOptions.withGroupBy(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn options.UnifiedAlertListOptions.withGroupByMixin - -```jsonnet -options.UnifiedAlertListOptions.withGroupByMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn options.UnifiedAlertListOptions.withGroupMode - -```jsonnet -options.UnifiedAlertListOptions.withGroupMode(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"default"`, `"custom"` - - -##### fn options.UnifiedAlertListOptions.withMaxItems - -```jsonnet -options.UnifiedAlertListOptions.withMaxItems(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -##### fn options.UnifiedAlertListOptions.withShowInstances - -```jsonnet -options.UnifiedAlertListOptions.withShowInstances(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn options.UnifiedAlertListOptions.withSortOrder - -```jsonnet -options.UnifiedAlertListOptions.withSortOrder(value) -``` - -PARAMETERS: - -* **value** (`number`) - - valid values: `1`, `2`, `3`, `4`, `5` - - -##### fn options.UnifiedAlertListOptions.withStateFilter - -```jsonnet -options.UnifiedAlertListOptions.withStateFilter(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.UnifiedAlertListOptions.withStateFilterMixin - -```jsonnet -options.UnifiedAlertListOptions.withStateFilterMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.UnifiedAlertListOptions.withViewMode - -```jsonnet -options.UnifiedAlertListOptions.withViewMode(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"list"`, `"stat"` - - -##### obj options.UnifiedAlertListOptions.folder - - -###### fn options.UnifiedAlertListOptions.folder.withId - -```jsonnet -options.UnifiedAlertListOptions.folder.withId(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -###### fn options.UnifiedAlertListOptions.folder.withTitle - -```jsonnet -options.UnifiedAlertListOptions.folder.withTitle(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj options.UnifiedAlertListOptions.stateFilter - - -###### fn options.UnifiedAlertListOptions.stateFilter.withError - -```jsonnet -options.UnifiedAlertListOptions.stateFilter.withError(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.UnifiedAlertListOptions.stateFilter.withFiring - -```jsonnet -options.UnifiedAlertListOptions.stateFilter.withFiring(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.UnifiedAlertListOptions.stateFilter.withInactive - -```jsonnet -options.UnifiedAlertListOptions.stateFilter.withInactive(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.UnifiedAlertListOptions.stateFilter.withNoData - -```jsonnet -options.UnifiedAlertListOptions.stateFilter.withNoData(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.UnifiedAlertListOptions.stateFilter.withNormal - -```jsonnet -options.UnifiedAlertListOptions.stateFilter.withNormal(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn options.UnifiedAlertListOptions.stateFilter.withPending - -```jsonnet -options.UnifiedAlertListOptions.stateFilter.withPending(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - ### obj panelOptions diff --git a/docs/API/panel/alertList/queryOptions/transformation.md b/docs/API/panel/alertList/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/alertList/queryOptions/transformation.md +++ b/docs/API/panel/alertList/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/alertList/standardOptions/mapping.md b/docs/API/panel/alertList/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/alertList/standardOptions/mapping.md +++ b/docs/API/panel/alertList/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/alertList/standardOptions/threshold/step.md b/docs/API/panel/alertList/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/alertList/standardOptions/threshold/step.md +++ b/docs/API/panel/alertList/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/annotationsList/queryOptions/transformation.md b/docs/API/panel/annotationsList/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/annotationsList/queryOptions/transformation.md +++ b/docs/API/panel/annotationsList/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/annotationsList/standardOptions/mapping.md b/docs/API/panel/annotationsList/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/annotationsList/standardOptions/mapping.md +++ b/docs/API/panel/annotationsList/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/annotationsList/standardOptions/threshold/step.md b/docs/API/panel/annotationsList/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/annotationsList/standardOptions/threshold/step.md +++ b/docs/API/panel/annotationsList/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/barChart/index.md b/docs/API/panel/barChart/index.md index c8dd8117..caf3c7f8 100644 --- a/docs/API/panel/barChart/index.md +++ b/docs/API/panel/barChart/index.md @@ -276,9 +276,9 @@ fieldConfig.defaults.custom.withGradientMode(value) PARAMETERS: * **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` -Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. -Gradient appearance is influenced by the Fill opacity setting. +TODO docs ###### fn fieldConfig.defaults.custom.withHideFrom ```jsonnet @@ -567,8 +567,9 @@ options.withOrientation(value) PARAMETERS: * **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` -Controls the orientation of the bar chart, either vertical or horizontal. +TODO docs #### fn options.withShowValue ```jsonnet @@ -578,8 +579,9 @@ options.withShowValue(value) PARAMETERS: * **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` -This controls whether values are shown on top or to the left of bars. +TODO docs #### fn options.withStacking ```jsonnet @@ -589,8 +591,9 @@ options.withStacking(value) PARAMETERS: * **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` -Controls whether bars are stacked or not, either normally or in percent mode. +TODO docs #### fn options.withText ```jsonnet diff --git a/docs/API/panel/barChart/queryOptions/transformation.md b/docs/API/panel/barChart/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/barChart/queryOptions/transformation.md +++ b/docs/API/panel/barChart/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/barChart/standardOptions/mapping.md b/docs/API/panel/barChart/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/barChart/standardOptions/mapping.md +++ b/docs/API/panel/barChart/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/barChart/standardOptions/threshold/step.md b/docs/API/panel/barChart/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/barChart/standardOptions/threshold/step.md +++ b/docs/API/panel/barChart/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/barGauge/queryOptions/transformation.md b/docs/API/panel/barGauge/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/barGauge/queryOptions/transformation.md +++ b/docs/API/panel/barGauge/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/barGauge/standardOptions/mapping.md b/docs/API/panel/barGauge/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/barGauge/standardOptions/mapping.md +++ b/docs/API/panel/barGauge/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/barGauge/standardOptions/threshold/step.md b/docs/API/panel/barGauge/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/barGauge/standardOptions/threshold/step.md +++ b/docs/API/panel/barGauge/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/candlestick/index.md b/docs/API/panel/candlestick/index.md index 3a15f556..ab1accee 100644 --- a/docs/API/panel/candlestick/index.md +++ b/docs/API/panel/candlestick/index.md @@ -78,8 +78,8 @@ grafonnet.panel.candlestick * [`fn withColorStrategy(value)`](#fn-optionswithcolorstrategy) * [`fn withColors(value)`](#fn-optionswithcolors) * [`fn withColorsMixin(value)`](#fn-optionswithcolorsmixin) - * [`fn withFields(value={})`](#fn-optionswithfields) - * [`fn withFieldsMixin(value={})`](#fn-optionswithfieldsmixin) + * [`fn withFields(value)`](#fn-optionswithfields) + * [`fn withFieldsMixin(value)`](#fn-optionswithfieldsmixin) * [`fn withIncludeAllFields(value=true)`](#fn-optionswithincludeallfields) * [`fn withLegend(value)`](#fn-optionswithlegend) * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) @@ -91,14 +91,11 @@ grafonnet.panel.candlestick * [`fn withFlat(value="gray")`](#fn-optionscolorswithflat) * [`fn withUp(value="green")`](#fn-optionscolorswithup) * [`obj fields`](#obj-optionsfields) - * [`fn withCandlestickFieldMap(value)`](#fn-optionsfieldswithcandlestickfieldmap) - * [`fn withCandlestickFieldMapMixin(value)`](#fn-optionsfieldswithcandlestickfieldmapmixin) - * [`obj CandlestickFieldMap`](#obj-optionsfieldscandlestickfieldmap) - * [`fn withClose(value)`](#fn-optionsfieldscandlestickfieldmapwithclose) - * [`fn withHigh(value)`](#fn-optionsfieldscandlestickfieldmapwithhigh) - * [`fn withLow(value)`](#fn-optionsfieldscandlestickfieldmapwithlow) - * [`fn withOpen(value)`](#fn-optionsfieldscandlestickfieldmapwithopen) - * [`fn withVolume(value)`](#fn-optionsfieldscandlestickfieldmapwithvolume) + * [`fn withClose(value)`](#fn-optionsfieldswithclose) + * [`fn withHigh(value)`](#fn-optionsfieldswithhigh) + * [`fn withLow(value)`](#fn-optionsfieldswithlow) + * [`fn withOpen(value)`](#fn-optionsfieldswithopen) + * [`fn withVolume(value)`](#fn-optionsfieldswithvolume) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) @@ -293,7 +290,7 @@ fieldConfig.defaults.custom.withBarAlignment(value) PARAMETERS: -* **value** (`integer`) +* **value** (`string`) - valid values: `-1`, `0`, `1` TODO docs @@ -794,8 +791,9 @@ options.withCandleStyle(value) PARAMETERS: * **value** (`string`) + - valid values: `"candles"`, `"ohlcbars"` + -Sets the style of the candlesticks #### fn options.withColorStrategy ```jsonnet @@ -805,8 +803,9 @@ options.withColorStrategy(value) PARAMETERS: * **value** (`string`) + - valid values: `"open-close"`, `"close-close"` + -Sets the color strategy for the candlesticks #### fn options.withColors ```jsonnet @@ -832,27 +831,25 @@ PARAMETERS: #### fn options.withFields ```jsonnet -options.withFields(value={}) +options.withFields(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{}` -Map fields to appropriate dimension + #### fn options.withFieldsMixin ```jsonnet -options.withFieldsMixin(value={}) +options.withFieldsMixin(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{}` -Map fields to appropriate dimension + #### fn options.withIncludeAllFields ```jsonnet @@ -896,8 +893,9 @@ options.withMode(value) PARAMETERS: * **value** (`string`) + - valid values: `"candles+volume"`, `"candles"`, `"volume"` + -Sets which dimensions are used for the visualization #### fn options.withTooltip ```jsonnet @@ -962,35 +960,10 @@ PARAMETERS: #### obj options.fields -##### fn options.fields.withCandlestickFieldMap - -```jsonnet -options.fields.withCandlestickFieldMap(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn options.fields.withCandlestickFieldMapMixin - -```jsonnet -options.fields.withCandlestickFieldMapMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### obj options.fields.CandlestickFieldMap - - -###### fn options.fields.CandlestickFieldMap.withClose +##### fn options.fields.withClose ```jsonnet -options.fields.CandlestickFieldMap.withClose(value) +options.fields.withClose(value) ``` PARAMETERS: @@ -998,10 +971,10 @@ PARAMETERS: * **value** (`string`) Corresponds to the final (end) value of the given period -###### fn options.fields.CandlestickFieldMap.withHigh +##### fn options.fields.withHigh ```jsonnet -options.fields.CandlestickFieldMap.withHigh(value) +options.fields.withHigh(value) ``` PARAMETERS: @@ -1009,10 +982,10 @@ PARAMETERS: * **value** (`string`) Corresponds to the highest value of the given period -###### fn options.fields.CandlestickFieldMap.withLow +##### fn options.fields.withLow ```jsonnet -options.fields.CandlestickFieldMap.withLow(value) +options.fields.withLow(value) ``` PARAMETERS: @@ -1020,10 +993,10 @@ PARAMETERS: * **value** (`string`) Corresponds to the lowest value of the given period -###### fn options.fields.CandlestickFieldMap.withOpen +##### fn options.fields.withOpen ```jsonnet -options.fields.CandlestickFieldMap.withOpen(value) +options.fields.withOpen(value) ``` PARAMETERS: @@ -1031,10 +1004,10 @@ PARAMETERS: * **value** (`string`) Corresponds to the starting value of the given period -###### fn options.fields.CandlestickFieldMap.withVolume +##### fn options.fields.withVolume ```jsonnet -options.fields.CandlestickFieldMap.withVolume(value) +options.fields.withVolume(value) ``` PARAMETERS: diff --git a/docs/API/panel/candlestick/queryOptions/transformation.md b/docs/API/panel/candlestick/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/candlestick/queryOptions/transformation.md +++ b/docs/API/panel/candlestick/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/candlestick/standardOptions/mapping.md b/docs/API/panel/candlestick/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/candlestick/standardOptions/mapping.md +++ b/docs/API/panel/candlestick/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/candlestick/standardOptions/threshold/step.md b/docs/API/panel/candlestick/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/candlestick/standardOptions/threshold/step.md +++ b/docs/API/panel/candlestick/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/canvas/index.md b/docs/API/panel/canvas/index.md index b63952f7..5d8a9652 100644 --- a/docs/API/panel/canvas/index.md +++ b/docs/API/panel/canvas/index.md @@ -18,6 +18,7 @@ grafonnet.panel.canvas * [`fn withName(value)`](#fn-librarypanelwithname) * [`fn withUid(value)`](#fn-librarypanelwithuid) * [`obj options`](#obj-options) + * [`fn withInfinitePan(value=true)`](#fn-optionswithinfinitepan) * [`fn withInlineEditing(value=true)`](#fn-optionswithinlineediting) * [`fn withPanZoom(value=true)`](#fn-optionswithpanzoom) * [`fn withRoot(value)`](#fn-optionswithroot) @@ -27,7 +28,7 @@ grafonnet.panel.canvas * [`fn withElements(value)`](#fn-optionsrootwithelements) * [`fn withElementsMixin(value)`](#fn-optionsrootwithelementsmixin) * [`fn withName(value)`](#fn-optionsrootwithname) - * [`fn withType(value)`](#fn-optionsrootwithtype) + * [`fn withType()`](#fn-optionsrootwithtype) * [`obj panelOptions`](#obj-paneloptions) * [`fn withDescription(value)`](#fn-paneloptionswithdescription) * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) @@ -113,6 +114,18 @@ Library panel uid ### obj options +#### fn options.withInfinitePan + +```jsonnet +options.withInfinitePan(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable infinite pan #### fn options.withInlineEditing ```jsonnet @@ -212,13 +225,9 @@ Name of the root element ##### fn options.root.withType ```jsonnet -options.root.withType(value) +options.root.withType() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"frame"` Type of root element (frame) ### obj panelOptions diff --git a/docs/API/panel/canvas/options/root/elements/connections.md b/docs/API/panel/canvas/options/root/elements/connections/index.md similarity index 64% rename from docs/API/panel/canvas/options/root/elements/connections.md rename to docs/API/panel/canvas/options/root/elements/connections/index.md index e8e62264..f1571587 100644 --- a/docs/API/panel/canvas/options/root/elements/connections.md +++ b/docs/API/panel/canvas/options/root/elements/connections/index.md @@ -2,6 +2,10 @@ +## Subpackages + +* [vertices](vertices.md) + ## Index * [`fn withColor(value)`](#fn-withcolor) @@ -11,9 +15,15 @@ * [`fn withSizeMixin(value)`](#fn-withsizemixin) * [`fn withSource(value)`](#fn-withsource) * [`fn withSourceMixin(value)`](#fn-withsourcemixin) +* [`fn withSourceOriginal(value)`](#fn-withsourceoriginal) +* [`fn withSourceOriginalMixin(value)`](#fn-withsourceoriginalmixin) * [`fn withTarget(value)`](#fn-withtarget) * [`fn withTargetMixin(value)`](#fn-withtargetmixin) * [`fn withTargetName(value)`](#fn-withtargetname) +* [`fn withTargetOriginal(value)`](#fn-withtargetoriginal) +* [`fn withTargetOriginalMixin(value)`](#fn-withtargetoriginalmixin) +* [`fn withVertices(value)`](#fn-withvertices) +* [`fn withVerticesMixin(value)`](#fn-withverticesmixin) * [`obj color`](#obj-color) * [`fn withField(value)`](#fn-colorwithfield) * [`fn withFixed(value)`](#fn-colorwithfixed) @@ -26,9 +36,15 @@ * [`obj source`](#obj-source) * [`fn withX(value)`](#fn-sourcewithx) * [`fn withY(value)`](#fn-sourcewithy) +* [`obj sourceOriginal`](#obj-sourceoriginal) + * [`fn withX(value)`](#fn-sourceoriginalwithx) + * [`fn withY(value)`](#fn-sourceoriginalwithy) * [`obj target`](#obj-target) * [`fn withX(value)`](#fn-targetwithx) * [`fn withY(value)`](#fn-targetwithy) +* [`obj targetOriginal`](#obj-targetoriginal) + * [`fn withX(value)`](#fn-targetoriginalwithx) + * [`fn withY(value)`](#fn-targetoriginalwithy) ## Fields @@ -110,6 +126,28 @@ PARAMETERS: * **value** (`object`) +### fn withSourceOriginal + +```jsonnet +withSourceOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginalMixin + +```jsonnet +withSourceOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + ### fn withTarget ```jsonnet @@ -143,6 +181,50 @@ PARAMETERS: * **value** (`string`) +### fn withTargetOriginal + +```jsonnet +withTargetOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetOriginalMixin + +```jsonnet +withTargetOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withVertices + +```jsonnet +withVertices(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withVerticesMixin + +```jsonnet +withVerticesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + ### obj color @@ -167,7 +249,7 @@ PARAMETERS: * **value** (`string`) - +color value ### obj size @@ -252,6 +334,31 @@ PARAMETERS: * **value** (`number`) +### obj sourceOriginal + + +#### fn sourceOriginal.withX + +```jsonnet +sourceOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn sourceOriginal.withY + +```jsonnet +sourceOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + ### obj target @@ -276,3 +383,28 @@ PARAMETERS: * **value** (`number`) + +### obj targetOriginal + + +#### fn targetOriginal.withX + +```jsonnet +targetOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn targetOriginal.withY + +```jsonnet +targetOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/docs/API/panel/canvas/options/root/elements/connections/vertices.md b/docs/API/panel/canvas/options/root/elements/connections/vertices.md new file mode 100644 index 00000000..70f44a38 --- /dev/null +++ b/docs/API/panel/canvas/options/root/elements/connections/vertices.md @@ -0,0 +1,32 @@ +# vertices + + + +## Index + +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) + +## Fields + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/docs/API/panel/canvas/options/root/elements/index.md b/docs/API/panel/canvas/options/root/elements/index.md index 7892a2f5..73f5b6ea 100644 --- a/docs/API/panel/canvas/options/root/elements/index.md +++ b/docs/API/panel/canvas/options/root/elements/index.md @@ -4,7 +4,7 @@ ## Subpackages -* [connections](connections.md) +* [connections](connections/index.md) ## Index @@ -13,6 +13,7 @@ * [`fn withBorder(value)`](#fn-withborder) * [`fn withBorderMixin(value)`](#fn-withbordermixin) * [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) * [`fn withConnections(value)`](#fn-withconnections) * [`fn withConnectionsMixin(value)`](#fn-withconnectionsmixin) * [`fn withConstraint(value)`](#fn-withconstraint) @@ -37,6 +38,7 @@ * [`obj border`](#obj-border) * [`fn withColor(value)`](#fn-borderwithcolor) * [`fn withColorMixin(value)`](#fn-borderwithcolormixin) + * [`fn withRadius(value)`](#fn-borderwithradius) * [`fn withWidth(value)`](#fn-borderwithwidth) * [`obj color`](#obj-bordercolor) * [`fn withField(value)`](#fn-bordercolorwithfield) @@ -49,6 +51,7 @@ * [`fn withHeight(value)`](#fn-placementwithheight) * [`fn withLeft(value)`](#fn-placementwithleft) * [`fn withRight(value)`](#fn-placementwithright) + * [`fn withRotation(value)`](#fn-placementwithrotation) * [`fn withTop(value)`](#fn-placementwithtop) * [`fn withWidth(value)`](#fn-placementwithwidth) @@ -106,7 +109,18 @@ withConfig(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) TODO: figure out how to define this (element config(s)) ### fn withConnections @@ -280,7 +294,7 @@ PARAMETERS: * **value** (`string`) - +color value #### obj background.image @@ -343,6 +357,17 @@ PARAMETERS: * **value** (`object`) +#### fn border.withRadius + +```jsonnet +border.withRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + + #### fn border.withWidth ```jsonnet @@ -378,7 +403,7 @@ PARAMETERS: * **value** (`string`) - +color value ### obj constraint @@ -453,6 +478,17 @@ PARAMETERS: * **value** (`number`) +#### fn placement.withRotation + +```jsonnet +placement.withRotation(value) +``` + +PARAMETERS: + +* **value** (`number`) + + #### fn placement.withTop ```jsonnet diff --git a/docs/API/panel/canvas/queryOptions/transformation.md b/docs/API/panel/canvas/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/canvas/queryOptions/transformation.md +++ b/docs/API/panel/canvas/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/canvas/standardOptions/mapping.md b/docs/API/panel/canvas/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/canvas/standardOptions/mapping.md +++ b/docs/API/panel/canvas/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/canvas/standardOptions/threshold/step.md b/docs/API/panel/canvas/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/canvas/standardOptions/threshold/step.md +++ b/docs/API/panel/canvas/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/dashboardList/queryOptions/transformation.md b/docs/API/panel/dashboardList/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/dashboardList/queryOptions/transformation.md +++ b/docs/API/panel/dashboardList/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/dashboardList/standardOptions/mapping.md b/docs/API/panel/dashboardList/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/dashboardList/standardOptions/mapping.md +++ b/docs/API/panel/dashboardList/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/dashboardList/standardOptions/threshold/step.md b/docs/API/panel/dashboardList/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/dashboardList/standardOptions/threshold/step.md +++ b/docs/API/panel/dashboardList/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/datagrid/queryOptions/transformation.md b/docs/API/panel/datagrid/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/datagrid/queryOptions/transformation.md +++ b/docs/API/panel/datagrid/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/datagrid/standardOptions/mapping.md b/docs/API/panel/datagrid/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/datagrid/standardOptions/mapping.md +++ b/docs/API/panel/datagrid/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/datagrid/standardOptions/threshold/step.md b/docs/API/panel/datagrid/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/datagrid/standardOptions/threshold/step.md +++ b/docs/API/panel/datagrid/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/debug/queryOptions/transformation.md b/docs/API/panel/debug/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/debug/queryOptions/transformation.md +++ b/docs/API/panel/debug/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/debug/standardOptions/mapping.md b/docs/API/panel/debug/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/debug/standardOptions/mapping.md +++ b/docs/API/panel/debug/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/debug/standardOptions/threshold/step.md b/docs/API/panel/debug/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/debug/standardOptions/threshold/step.md +++ b/docs/API/panel/debug/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/gauge/queryOptions/transformation.md b/docs/API/panel/gauge/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/gauge/queryOptions/transformation.md +++ b/docs/API/panel/gauge/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/gauge/standardOptions/mapping.md b/docs/API/panel/gauge/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/gauge/standardOptions/mapping.md +++ b/docs/API/panel/gauge/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/gauge/standardOptions/threshold/step.md b/docs/API/panel/gauge/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/gauge/standardOptions/threshold/step.md +++ b/docs/API/panel/gauge/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/geomap/index.md b/docs/API/panel/geomap/index.md index 27afea9c..c1a2e05e 100644 --- a/docs/API/panel/geomap/index.md +++ b/docs/API/panel/geomap/index.md @@ -30,7 +30,9 @@ grafonnet.panel.geomap * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) * [`obj basemap`](#obj-optionsbasemap) * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) + * [`fn withConfigMixin(value)`](#fn-optionsbasemapwithconfigmixin) * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) + * [`fn withFilterDataMixin(value)`](#fn-optionsbasemapwithfilterdatamixin) * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) * [`fn withName(value)`](#fn-optionsbasemapwithname) @@ -272,7 +274,18 @@ options.basemap.withConfig(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withConfigMixin + +```jsonnet +options.basemap.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Custom options depending on the type ##### fn options.basemap.withFilterData @@ -283,7 +296,18 @@ options.basemap.withFilterData(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withFilterDataMixin + +```jsonnet +options.basemap.withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Defines a frame MatcherConfig that may filter data for the given layer ##### fn options.basemap.withLocation diff --git a/docs/API/panel/geomap/options/layers.md b/docs/API/panel/geomap/options/layers.md index d65f7c60..cf4881df 100644 --- a/docs/API/panel/geomap/options/layers.md +++ b/docs/API/panel/geomap/options/layers.md @@ -5,7 +5,9 @@ ## Index * [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) * [`fn withFilterData(value)`](#fn-withfilterdata) +* [`fn withFilterDataMixin(value)`](#fn-withfilterdatamixin) * [`fn withLocation(value)`](#fn-withlocation) * [`fn withLocationMixin(value)`](#fn-withlocationmixin) * [`fn withName(value)`](#fn-withname) @@ -31,7 +33,18 @@ withConfig(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Custom options depending on the type +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Custom options depending on the type ### fn withFilterData @@ -42,7 +55,18 @@ withFilterData(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withFilterDataMixin + +```jsonnet +withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Defines a frame MatcherConfig that may filter data for the given layer ### fn withLocation diff --git a/docs/API/panel/geomap/queryOptions/transformation.md b/docs/API/panel/geomap/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/geomap/queryOptions/transformation.md +++ b/docs/API/panel/geomap/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/geomap/standardOptions/mapping.md b/docs/API/panel/geomap/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/geomap/standardOptions/mapping.md +++ b/docs/API/panel/geomap/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/geomap/standardOptions/threshold/step.md b/docs/API/panel/geomap/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/geomap/standardOptions/threshold/step.md +++ b/docs/API/panel/geomap/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/heatmap/index.md b/docs/API/panel/heatmap/index.md index f313ed7a..336c823d 100644 --- a/docs/API/panel/heatmap/index.md +++ b/docs/API/panel/heatmap/index.md @@ -37,21 +37,21 @@ grafonnet.panel.heatmap * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) * [`fn withCellRadius(value)`](#fn-optionswithcellradius) - * [`fn withCellValues(value={})`](#fn-optionswithcellvalues) - * [`fn withCellValuesMixin(value={})`](#fn-optionswithcellvaluesmixin) - * [`fn withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolor) - * [`fn withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolormixin) + * [`fn withCellValues(value)`](#fn-optionswithcellvalues) + * [`fn withCellValuesMixin(value)`](#fn-optionswithcellvaluesmixin) + * [`fn withColor(value)`](#fn-optionswithcolor) + * [`fn withColorMixin(value)`](#fn-optionswithcolormixin) * [`fn withExemplars(value)`](#fn-optionswithexemplars) * [`fn withExemplarsMixin(value)`](#fn-optionswithexemplarsmixin) - * [`fn withFilterValues(value={"le": 0.000000001})`](#fn-optionswithfiltervalues) - * [`fn withFilterValuesMixin(value={"le": 0.000000001})`](#fn-optionswithfiltervaluesmixin) + * [`fn withFilterValues(value)`](#fn-optionswithfiltervalues) + * [`fn withFilterValuesMixin(value)`](#fn-optionswithfiltervaluesmixin) * [`fn withLegend(value)`](#fn-optionswithlegend) * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTooltip(value={"mode": "single","showColorScale": false,"yHistogram": false})`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value={"mode": "single","showColorScale": false,"yHistogram": false})`](#fn-optionswithtooltipmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`fn withYAxis(value)`](#fn-optionswithyaxis) * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) * [`obj calculation`](#obj-optionscalculation) @@ -78,46 +78,34 @@ grafonnet.panel.heatmap * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) * [`obj cellValues`](#obj-optionscellvalues) - * [`fn withCellValues(value)`](#fn-optionscellvalueswithcellvalues) - * [`fn withCellValuesMixin(value)`](#fn-optionscellvalueswithcellvaluesmixin) - * [`obj CellValues`](#obj-optionscellvaluescellvalues) - * [`fn withDecimals(value)`](#fn-optionscellvaluescellvalueswithdecimals) - * [`fn withUnit(value)`](#fn-optionscellvaluescellvalueswithunit) + * [`fn withDecimals(value)`](#fn-optionscellvalueswithdecimals) + * [`fn withUnit(value)`](#fn-optionscellvalueswithunit) * [`obj color`](#obj-optionscolor) - * [`fn withHeatmapColorOptions(value)`](#fn-optionscolorwithheatmapcoloroptions) - * [`fn withHeatmapColorOptionsMixin(value)`](#fn-optionscolorwithheatmapcoloroptionsmixin) - * [`obj HeatmapColorOptions`](#obj-optionscolorheatmapcoloroptions) - * [`fn withExponent(value)`](#fn-optionscolorheatmapcoloroptionswithexponent) - * [`fn withFill(value)`](#fn-optionscolorheatmapcoloroptionswithfill) - * [`fn withMax(value)`](#fn-optionscolorheatmapcoloroptionswithmax) - * [`fn withMin(value)`](#fn-optionscolorheatmapcoloroptionswithmin) - * [`fn withMode(value)`](#fn-optionscolorheatmapcoloroptionswithmode) - * [`fn withReverse(value=true)`](#fn-optionscolorheatmapcoloroptionswithreverse) - * [`fn withScale(value)`](#fn-optionscolorheatmapcoloroptionswithscale) - * [`fn withScheme(value)`](#fn-optionscolorheatmapcoloroptionswithscheme) - * [`fn withSteps(value)`](#fn-optionscolorheatmapcoloroptionswithsteps) + * [`fn withExponent(value)`](#fn-optionscolorwithexponent) + * [`fn withFill(value)`](#fn-optionscolorwithfill) + * [`fn withMax(value)`](#fn-optionscolorwithmax) + * [`fn withMin(value)`](#fn-optionscolorwithmin) + * [`fn withMode(value)`](#fn-optionscolorwithmode) + * [`fn withReverse(value=true)`](#fn-optionscolorwithreverse) + * [`fn withScale(value)`](#fn-optionscolorwithscale) + * [`fn withScheme(value)`](#fn-optionscolorwithscheme) + * [`fn withSteps(value)`](#fn-optionscolorwithsteps) * [`obj exemplars`](#obj-optionsexemplars) * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) * [`obj filterValues`](#obj-optionsfiltervalues) - * [`fn withFilterValueRange(value)`](#fn-optionsfiltervalueswithfiltervaluerange) - * [`fn withFilterValueRangeMixin(value)`](#fn-optionsfiltervalueswithfiltervaluerangemixin) - * [`obj FilterValueRange`](#obj-optionsfiltervaluesfiltervaluerange) - * [`fn withGe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithge) - * [`fn withLe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithle) + * [`fn withGe(value)`](#fn-optionsfiltervalueswithge) + * [`fn withLe(value)`](#fn-optionsfiltervalueswithle) * [`obj legend`](#obj-optionslegend) * [`fn withShow(value=true)`](#fn-optionslegendwithshow) * [`obj rowsFrame`](#obj-optionsrowsframe) * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) * [`obj tooltip`](#obj-optionstooltip) - * [`fn withHeatmapTooltip(value)`](#fn-optionstooltipwithheatmaptooltip) - * [`fn withHeatmapTooltipMixin(value)`](#fn-optionstooltipwithheatmaptooltipmixin) - * [`obj HeatmapTooltip`](#obj-optionstooltipheatmaptooltip) - * [`fn withMaxHeight(value)`](#fn-optionstooltipheatmaptooltipwithmaxheight) - * [`fn withMaxWidth(value)`](#fn-optionstooltipheatmaptooltipwithmaxwidth) - * [`fn withMode(value)`](#fn-optionstooltipheatmaptooltipwithmode) - * [`fn withShowColorScale(value=true)`](#fn-optionstooltipheatmaptooltipwithshowcolorscale) - * [`fn withYHistogram(value=true)`](#fn-optionstooltipheatmaptooltipwithyhistogram) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withShowColorScale(value=true)`](#fn-optionstooltipwithshowcolorscale) + * [`fn withYHistogram(value=true)`](#fn-optionstooltipwithyhistogram) * [`obj yAxis`](#obj-optionsyaxis) * [`fn withAxisBorderShow(value=true)`](#fn-optionsyaxiswithaxisbordershow) * [`fn withAxisCenteredZero(value=true)`](#fn-optionsyaxiswithaxiscenteredzero) @@ -413,51 +401,47 @@ Controls cell radius #### fn options.withCellValues ```jsonnet -options.withCellValues(value={}) +options.withCellValues(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{}` -Controls cell value unit +Controls cell value options #### fn options.withCellValuesMixin ```jsonnet -options.withCellValuesMixin(value={}) +options.withCellValuesMixin(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{}` -Controls cell value unit +Controls cell value options #### fn options.withColor ```jsonnet -options.withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) +options.withColor(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}` -Controls the color options +Controls various color options #### fn options.withColorMixin ```jsonnet -options.withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) +options.withColorMixin(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}` -Controls the color options +Controls various color options #### fn options.withExemplars ```jsonnet @@ -483,27 +467,25 @@ Controls exemplar options #### fn options.withFilterValues ```jsonnet -options.withFilterValues(value={"le": 0.000000001}) +options.withFilterValues(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"le": 0.000000001}` -Filters values between a given range +Controls the value filter range #### fn options.withFilterValuesMixin ```jsonnet -options.withFilterValuesMixin(value={"le": 0.000000001}) +options.withFilterValuesMixin(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"le": 0.000000001}` -Filters values between a given range +Controls the value filter range #### fn options.withLegend ```jsonnet @@ -557,33 +539,29 @@ options.withShowValue(value) PARAMETERS: * **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` -| *{ - layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed -} -Controls the display of the value in the cell +TODO docs #### fn options.withTooltip ```jsonnet -options.withTooltip(value={"mode": "single","showColorScale": false,"yHistogram": false}) +options.withTooltip(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"mode": "single","showColorScale": false,"yHistogram": false}` Controls tooltip options #### fn options.withTooltipMixin ```jsonnet -options.withTooltipMixin(value={"mode": "single","showColorScale": false,"yHistogram": false}) +options.withTooltipMixin(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"mode": "single","showColorScale": false,"yHistogram": false}` Controls tooltip options #### fn options.withYAxis @@ -828,35 +806,10 @@ TODO docs #### obj options.cellValues -##### fn options.cellValues.withCellValues - -```jsonnet -options.cellValues.withCellValues(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls cell value options -##### fn options.cellValues.withCellValuesMixin - -```jsonnet -options.cellValues.withCellValuesMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls cell value options -##### obj options.cellValues.CellValues - - -###### fn options.cellValues.CellValues.withDecimals +##### fn options.cellValues.withDecimals ```jsonnet -options.cellValues.CellValues.withDecimals(value) +options.cellValues.withDecimals(value) ``` PARAMETERS: @@ -864,10 +817,10 @@ PARAMETERS: * **value** (`number`) Controls the number of decimals for cell values -###### fn options.cellValues.CellValues.withUnit +##### fn options.cellValues.withUnit ```jsonnet -options.cellValues.CellValues.withUnit(value) +options.cellValues.withUnit(value) ``` PARAMETERS: @@ -878,35 +831,10 @@ Controls the cell value unit #### obj options.color -##### fn options.color.withHeatmapColorOptions - -```jsonnet -options.color.withHeatmapColorOptions(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls various color options -##### fn options.color.withHeatmapColorOptionsMixin +##### fn options.color.withExponent ```jsonnet -options.color.withHeatmapColorOptionsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls various color options -##### obj options.color.HeatmapColorOptions - - -###### fn options.color.HeatmapColorOptions.withExponent - -```jsonnet -options.color.HeatmapColorOptions.withExponent(value) +options.color.withExponent(value) ``` PARAMETERS: @@ -914,10 +842,10 @@ PARAMETERS: * **value** (`number`) Controls the exponent when scale is set to exponential -###### fn options.color.HeatmapColorOptions.withFill +##### fn options.color.withFill ```jsonnet -options.color.HeatmapColorOptions.withFill(value) +options.color.withFill(value) ``` PARAMETERS: @@ -925,10 +853,10 @@ PARAMETERS: * **value** (`string`) Controls the color fill when in opacity mode -###### fn options.color.HeatmapColorOptions.withMax +##### fn options.color.withMax ```jsonnet -options.color.HeatmapColorOptions.withMax(value) +options.color.withMax(value) ``` PARAMETERS: @@ -936,10 +864,10 @@ PARAMETERS: * **value** (`number`) Sets the maximum value for the color scale -###### fn options.color.HeatmapColorOptions.withMin +##### fn options.color.withMin ```jsonnet -options.color.HeatmapColorOptions.withMin(value) +options.color.withMin(value) ``` PARAMETERS: @@ -947,10 +875,10 @@ PARAMETERS: * **value** (`number`) Sets the minimum value for the color scale -###### fn options.color.HeatmapColorOptions.withMode +##### fn options.color.withMode ```jsonnet -options.color.HeatmapColorOptions.withMode(value) +options.color.withMode(value) ``` PARAMETERS: @@ -959,10 +887,10 @@ PARAMETERS: - valid values: `"opacity"`, `"scheme"` Controls the color mode of the heatmap -###### fn options.color.HeatmapColorOptions.withReverse +##### fn options.color.withReverse ```jsonnet -options.color.HeatmapColorOptions.withReverse(value=true) +options.color.withReverse(value=true) ``` PARAMETERS: @@ -971,10 +899,10 @@ PARAMETERS: - default value: `true` Reverses the color scheme -###### fn options.color.HeatmapColorOptions.withScale +##### fn options.color.withScale ```jsonnet -options.color.HeatmapColorOptions.withScale(value) +options.color.withScale(value) ``` PARAMETERS: @@ -983,10 +911,10 @@ PARAMETERS: - valid values: `"linear"`, `"exponential"` Controls the color scale of the heatmap -###### fn options.color.HeatmapColorOptions.withScheme +##### fn options.color.withScheme ```jsonnet -options.color.HeatmapColorOptions.withScheme(value) +options.color.withScheme(value) ``` PARAMETERS: @@ -994,10 +922,10 @@ PARAMETERS: * **value** (`string`) Controls the color scheme used -###### fn options.color.HeatmapColorOptions.withSteps +##### fn options.color.withSteps ```jsonnet -options.color.HeatmapColorOptions.withSteps(value) +options.color.withSteps(value) ``` PARAMETERS: @@ -1022,35 +950,10 @@ Sets the color of the exemplar markers #### obj options.filterValues -##### fn options.filterValues.withFilterValueRange - -```jsonnet -options.filterValues.withFilterValueRange(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls the value filter range -##### fn options.filterValues.withFilterValueRangeMixin +##### fn options.filterValues.withGe ```jsonnet -options.filterValues.withFilterValueRangeMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls the value filter range -##### obj options.filterValues.FilterValueRange - - -###### fn options.filterValues.FilterValueRange.withGe - -```jsonnet -options.filterValues.FilterValueRange.withGe(value) +options.filterValues.withGe(value) ``` PARAMETERS: @@ -1058,10 +961,10 @@ PARAMETERS: * **value** (`number`) Sets the filter range to values greater than or equal to the given value -###### fn options.filterValues.FilterValueRange.withLe +##### fn options.filterValues.withLe ```jsonnet -options.filterValues.FilterValueRange.withLe(value) +options.filterValues.withLe(value) ``` PARAMETERS: @@ -1113,35 +1016,10 @@ Sets the name of the cell when not calculating from data #### obj options.tooltip -##### fn options.tooltip.withHeatmapTooltip - -```jsonnet -options.tooltip.withHeatmapTooltip(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls tooltip options -##### fn options.tooltip.withHeatmapTooltipMixin - -```jsonnet -options.tooltip.withHeatmapTooltipMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Controls tooltip options -##### obj options.tooltip.HeatmapTooltip - - -###### fn options.tooltip.HeatmapTooltip.withMaxHeight +##### fn options.tooltip.withMaxHeight ```jsonnet -options.tooltip.HeatmapTooltip.withMaxHeight(value) +options.tooltip.withMaxHeight(value) ``` PARAMETERS: @@ -1149,10 +1027,10 @@ PARAMETERS: * **value** (`number`) -###### fn options.tooltip.HeatmapTooltip.withMaxWidth +##### fn options.tooltip.withMaxWidth ```jsonnet -options.tooltip.HeatmapTooltip.withMaxWidth(value) +options.tooltip.withMaxWidth(value) ``` PARAMETERS: @@ -1160,10 +1038,10 @@ PARAMETERS: * **value** (`number`) -###### fn options.tooltip.HeatmapTooltip.withMode +##### fn options.tooltip.withMode ```jsonnet -options.tooltip.HeatmapTooltip.withMode(value) +options.tooltip.withMode(value) ``` PARAMETERS: @@ -1172,10 +1050,10 @@ PARAMETERS: - valid values: `"single"`, `"multi"`, `"none"` TODO docs -###### fn options.tooltip.HeatmapTooltip.withShowColorScale +##### fn options.tooltip.withShowColorScale ```jsonnet -options.tooltip.HeatmapTooltip.withShowColorScale(value=true) +options.tooltip.withShowColorScale(value=true) ``` PARAMETERS: @@ -1184,10 +1062,10 @@ PARAMETERS: - default value: `true` Controls if the tooltip shows a color scale in header -###### fn options.tooltip.HeatmapTooltip.withYHistogram +##### fn options.tooltip.withYHistogram ```jsonnet -options.tooltip.HeatmapTooltip.withYHistogram(value=true) +options.tooltip.withYHistogram(value=true) ``` PARAMETERS: diff --git a/docs/API/panel/heatmap/queryOptions/transformation.md b/docs/API/panel/heatmap/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/heatmap/queryOptions/transformation.md +++ b/docs/API/panel/heatmap/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/heatmap/standardOptions/mapping.md b/docs/API/panel/heatmap/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/heatmap/standardOptions/mapping.md +++ b/docs/API/panel/heatmap/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/heatmap/standardOptions/threshold/step.md b/docs/API/panel/heatmap/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/heatmap/standardOptions/threshold/step.md +++ b/docs/API/panel/heatmap/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/histogram/index.md b/docs/API/panel/histogram/index.md index c71865d4..0d098f74 100644 --- a/docs/API/panel/histogram/index.md +++ b/docs/API/panel/histogram/index.md @@ -32,6 +32,8 @@ grafonnet.panel.histogram * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) @@ -40,6 +42,9 @@ grafonnet.panel.histogram * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) * [`obj libraryPanel`](#obj-librarypanel) * [`fn withName(value)`](#fn-librarypanelwithname) * [`fn withUid(value)`](#fn-librarypanelwithuid) @@ -259,9 +264,9 @@ fieldConfig.defaults.custom.withGradientMode(value) PARAMETERS: * **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` -Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. -Gradient appearance is influenced by the Fill opacity setting. +TODO docs ###### fn fieldConfig.defaults.custom.withHideFrom ```jsonnet @@ -317,6 +322,28 @@ PARAMETERS: * **value** (`object`) +TODO docs +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + TODO docs ###### obj fieldConfig.defaults.custom.hideFrom @@ -393,6 +420,32 @@ PARAMETERS: * **value** (`string`) - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + TODO docs ### obj libraryPanel diff --git a/docs/API/panel/histogram/queryOptions/transformation.md b/docs/API/panel/histogram/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/histogram/queryOptions/transformation.md +++ b/docs/API/panel/histogram/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/histogram/standardOptions/mapping.md b/docs/API/panel/histogram/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/histogram/standardOptions/mapping.md +++ b/docs/API/panel/histogram/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/histogram/standardOptions/threshold/step.md b/docs/API/panel/histogram/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/histogram/standardOptions/threshold/step.md +++ b/docs/API/panel/histogram/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/index.md b/docs/API/panel/index.md index d29f1572..3111a61d 100644 --- a/docs/API/panel/index.md +++ b/docs/API/panel/index.md @@ -4,7 +4,6 @@ grafonnet.panel ## Subpackages -* [alertGroups](alertGroups/index.md) * [alertList](alertList/index.md) * [annotationsList](annotationsList/index.md) * [barChart](barChart/index.md) diff --git a/docs/API/panel/logs/queryOptions/transformation.md b/docs/API/panel/logs/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/logs/queryOptions/transformation.md +++ b/docs/API/panel/logs/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/logs/standardOptions/mapping.md b/docs/API/panel/logs/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/logs/standardOptions/mapping.md +++ b/docs/API/panel/logs/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/logs/standardOptions/threshold/step.md b/docs/API/panel/logs/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/logs/standardOptions/threshold/step.md +++ b/docs/API/panel/logs/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/news/queryOptions/transformation.md b/docs/API/panel/news/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/news/queryOptions/transformation.md +++ b/docs/API/panel/news/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/news/standardOptions/mapping.md b/docs/API/panel/news/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/news/standardOptions/mapping.md +++ b/docs/API/panel/news/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/news/standardOptions/threshold/step.md b/docs/API/panel/news/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/news/standardOptions/threshold/step.md +++ b/docs/API/panel/news/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/nodeGraph/queryOptions/transformation.md b/docs/API/panel/nodeGraph/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/nodeGraph/queryOptions/transformation.md +++ b/docs/API/panel/nodeGraph/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/nodeGraph/standardOptions/mapping.md b/docs/API/panel/nodeGraph/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/nodeGraph/standardOptions/mapping.md +++ b/docs/API/panel/nodeGraph/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/nodeGraph/standardOptions/threshold/step.md b/docs/API/panel/nodeGraph/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/nodeGraph/standardOptions/threshold/step.md +++ b/docs/API/panel/nodeGraph/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/pieChart/queryOptions/transformation.md b/docs/API/panel/pieChart/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/pieChart/queryOptions/transformation.md +++ b/docs/API/panel/pieChart/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/pieChart/standardOptions/mapping.md b/docs/API/panel/pieChart/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/pieChart/standardOptions/mapping.md +++ b/docs/API/panel/pieChart/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/pieChart/standardOptions/threshold/step.md b/docs/API/panel/pieChart/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/pieChart/standardOptions/threshold/step.md +++ b/docs/API/panel/pieChart/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/stat/queryOptions/transformation.md b/docs/API/panel/stat/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/stat/queryOptions/transformation.md +++ b/docs/API/panel/stat/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/stat/standardOptions/mapping.md b/docs/API/panel/stat/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/stat/standardOptions/mapping.md +++ b/docs/API/panel/stat/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/stat/standardOptions/threshold/step.md b/docs/API/panel/stat/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/stat/standardOptions/threshold/step.md +++ b/docs/API/panel/stat/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/stateTimeline/index.md b/docs/API/panel/stateTimeline/index.md index bc2d505a..e04563e7 100644 --- a/docs/API/panel/stateTimeline/index.md +++ b/docs/API/panel/stateTimeline/index.md @@ -49,6 +49,9 @@ grafonnet.panel.stateTimeline * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) * [`obj tooltip`](#obj-optionstooltip) * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) @@ -242,8 +245,9 @@ options.withAlignValue(value) PARAMETERS: * **value** (`string`) + - valid values: `"center"`, `"left"`, `"right"` -Controls value alignment on the timelines +Controls the value alignment in the TimelineChart component #### fn options.withLegend ```jsonnet @@ -299,8 +303,9 @@ options.withShowValue(value) PARAMETERS: * **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` -Show timeline values on chart +TODO docs #### fn options.withTimezone ```jsonnet @@ -465,6 +470,25 @@ PARAMETERS: * **value** (`number`) +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone #### obj options.tooltip diff --git a/docs/API/panel/stateTimeline/queryOptions/transformation.md b/docs/API/panel/stateTimeline/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/stateTimeline/queryOptions/transformation.md +++ b/docs/API/panel/stateTimeline/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/stateTimeline/standardOptions/mapping.md b/docs/API/panel/stateTimeline/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/stateTimeline/standardOptions/mapping.md +++ b/docs/API/panel/stateTimeline/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/stateTimeline/standardOptions/threshold/step.md b/docs/API/panel/stateTimeline/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/stateTimeline/standardOptions/threshold/step.md +++ b/docs/API/panel/stateTimeline/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/statusHistory/index.md b/docs/API/panel/statusHistory/index.md index a96e3a81..0d31d6a1 100644 --- a/docs/API/panel/statusHistory/index.md +++ b/docs/API/panel/statusHistory/index.md @@ -48,6 +48,9 @@ grafonnet.panel.statusHistory * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) * [`obj tooltip`](#obj-optionstooltip) * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) @@ -287,8 +290,9 @@ options.withShowValue(value) PARAMETERS: * **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` -Show values on the columns +TODO docs #### fn options.withTimezone ```jsonnet @@ -453,6 +457,25 @@ PARAMETERS: * **value** (`number`) +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone #### obj options.tooltip diff --git a/docs/API/panel/statusHistory/queryOptions/transformation.md b/docs/API/panel/statusHistory/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/statusHistory/queryOptions/transformation.md +++ b/docs/API/panel/statusHistory/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/statusHistory/standardOptions/mapping.md b/docs/API/panel/statusHistory/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/statusHistory/standardOptions/mapping.md +++ b/docs/API/panel/statusHistory/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/statusHistory/standardOptions/threshold/step.md b/docs/API/panel/statusHistory/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/statusHistory/standardOptions/threshold/step.md +++ b/docs/API/panel/statusHistory/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/table/index.md b/docs/API/panel/table/index.md index f515f0ad..d5c25b8b 100644 --- a/docs/API/panel/table/index.md +++ b/docs/API/panel/table/index.md @@ -45,22 +45,23 @@ grafonnet.panel.table * [`fn withTableSparklineCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptions) * [`fn withTableSparklineCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptionsmixin) * [`obj TableAutoCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableautocelloptions) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithtype) * [`obj TableBarGaugeCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablebargaugecelloptions) * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithmode) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithtype) * [`fn withValueDisplayMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithvaluedisplaymode) * [`obj TableColorTextCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecolortextcelloptions) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithtype) * [`obj TableColoredBackgroundCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptions) + * [`fn withApplyToRow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithapplytorow) * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithmode) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithtype) * [`obj TableDataLinksCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptions) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptionswithtype) * [`obj TableImageCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableimagecelloptions) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtype) * [`obj TableJsonViewCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptions) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptionswithtype) * [`obj TableSparklineCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptions) * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisbordershow) * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscenteredzero) @@ -100,7 +101,7 @@ grafonnet.panel.table * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstyle) * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstylemixin) * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtransform) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtype) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtype) * [`obj hideFrom`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefrom) * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithlegend) * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithtooltip) @@ -123,24 +124,21 @@ grafonnet.panel.table * [`fn withUid(value)`](#fn-librarypanelwithuid) * [`obj options`](#obj-options) * [`fn withCellHeight(value)`](#fn-optionswithcellheight) - * [`fn withFooter(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfooter) - * [`fn withFooterMixin(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfootermixin) + * [`fn withFooter(value)`](#fn-optionswithfooter) + * [`fn withFooterMixin(value)`](#fn-optionswithfootermixin) * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) * [`fn withShowTypeIcons(value=true)`](#fn-optionswithshowtypeicons) * [`fn withSortBy(value)`](#fn-optionswithsortby) * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) * [`obj footer`](#obj-optionsfooter) - * [`fn withTableFooterOptions(value)`](#fn-optionsfooterwithtablefooteroptions) - * [`fn withTableFooterOptionsMixin(value)`](#fn-optionsfooterwithtablefooteroptionsmixin) - * [`obj TableFooterOptions`](#obj-optionsfootertablefooteroptions) - * [`fn withCountRows(value=true)`](#fn-optionsfootertablefooteroptionswithcountrows) - * [`fn withEnablePagination(value=true)`](#fn-optionsfootertablefooteroptionswithenablepagination) - * [`fn withFields(value)`](#fn-optionsfootertablefooteroptionswithfields) - * [`fn withFieldsMixin(value)`](#fn-optionsfootertablefooteroptionswithfieldsmixin) - * [`fn withReducer(value)`](#fn-optionsfootertablefooteroptionswithreducer) - * [`fn withReducerMixin(value)`](#fn-optionsfootertablefooteroptionswithreducermixin) - * [`fn withShow(value=true)`](#fn-optionsfootertablefooteroptionswithshow) + * [`fn withCountRows(value=true)`](#fn-optionsfooterwithcountrows) + * [`fn withEnablePagination(value=true)`](#fn-optionsfooterwithenablepagination) + * [`fn withFields(value)`](#fn-optionsfooterwithfields) + * [`fn withFieldsMixin(value)`](#fn-optionsfooterwithfieldsmixin) + * [`fn withReducer(value)`](#fn-optionsfooterwithreducer) + * [`fn withReducerMixin(value)`](#fn-optionsfooterwithreducermixin) + * [`fn withShow(value=true)`](#fn-optionsfooterwithshow) * [`obj panelOptions`](#obj-paneloptions) * [`fn withDescription(value)`](#fn-paneloptionswithdescription) * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) @@ -282,7 +280,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +?? default is missing or false ?? ###### fn fieldConfig.defaults.custom.withHideHeader ```jsonnet @@ -514,12 +512,9 @@ Sparkline cell options ######## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions @@ -541,12 +536,9 @@ for the bar gauge component of Grafana UI ######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode @@ -567,17 +559,26 @@ Allows for the table cell gauge display type to set the gauge mode. ######## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + ######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode ```jsonnet @@ -595,12 +596,9 @@ or a gradient. ######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions @@ -609,12 +607,9 @@ PARAMETERS: ######## fn fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj fieldConfig.defaults.custom.cellOptions.TableImageCellOptions @@ -623,12 +618,9 @@ PARAMETERS: ######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions @@ -637,12 +629,9 @@ PARAMETERS: ######## fn fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions @@ -760,7 +749,7 @@ fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignme PARAMETERS: -* **value** (`integer`) +* **value** (`string`) - valid values: `-1`, `0`, `1` TODO docs @@ -1085,12 +1074,9 @@ TODO docs ######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType ```jsonnet -fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType(value) +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType() ``` -PARAMETERS: - -* **value** (`string`) ######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom @@ -1284,32 +1270,31 @@ options.withCellHeight(value) PARAMETERS: * **value** (`string`) + - valid values: `"sm"`, `"md"`, `"lg"` -Controls the height of the rows +Height of a table cell #### fn options.withFooter ```jsonnet -options.withFooter(value={"countRows": false,"reducer": [],"show": false}) +options.withFooter(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"countRows": false,"reducer": [],"show": false}` -Controls footer options +Footer options #### fn options.withFooterMixin ```jsonnet -options.withFooterMixin(value={"countRows": false,"reducer": [],"show": false}) +options.withFooterMixin(value) ``` PARAMETERS: * **value** (`object`) - - default value: `{"countRows": false,"reducer": [],"show": false}` -Controls footer options +Footer options #### fn options.withFrameIndex ```jsonnet @@ -1371,35 +1356,10 @@ Used to control row sorting #### obj options.footer -##### fn options.footer.withTableFooterOptions - -```jsonnet -options.footer.withTableFooterOptions(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Footer options -##### fn options.footer.withTableFooterOptionsMixin +##### fn options.footer.withCountRows ```jsonnet -options.footer.withTableFooterOptionsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Footer options -##### obj options.footer.TableFooterOptions - - -###### fn options.footer.TableFooterOptions.withCountRows - -```jsonnet -options.footer.TableFooterOptions.withCountRows(value=true) +options.footer.withCountRows(value=true) ``` PARAMETERS: @@ -1408,10 +1368,10 @@ PARAMETERS: - default value: `true` -###### fn options.footer.TableFooterOptions.withEnablePagination +##### fn options.footer.withEnablePagination ```jsonnet -options.footer.TableFooterOptions.withEnablePagination(value=true) +options.footer.withEnablePagination(value=true) ``` PARAMETERS: @@ -1420,10 +1380,10 @@ PARAMETERS: - default value: `true` -###### fn options.footer.TableFooterOptions.withFields +##### fn options.footer.withFields ```jsonnet -options.footer.TableFooterOptions.withFields(value) +options.footer.withFields(value) ``` PARAMETERS: @@ -1431,10 +1391,10 @@ PARAMETERS: * **value** (`array`) -###### fn options.footer.TableFooterOptions.withFieldsMixin +##### fn options.footer.withFieldsMixin ```jsonnet -options.footer.TableFooterOptions.withFieldsMixin(value) +options.footer.withFieldsMixin(value) ``` PARAMETERS: @@ -1442,32 +1402,32 @@ PARAMETERS: * **value** (`array`) -###### fn options.footer.TableFooterOptions.withReducer +##### fn options.footer.withReducer ```jsonnet -options.footer.TableFooterOptions.withReducer(value) +options.footer.withReducer(value) ``` PARAMETERS: * **value** (`array`) - -###### fn options.footer.TableFooterOptions.withReducerMixin +actually 1 value +##### fn options.footer.withReducerMixin ```jsonnet -options.footer.TableFooterOptions.withReducerMixin(value) +options.footer.withReducerMixin(value) ``` PARAMETERS: * **value** (`array`) - -###### fn options.footer.TableFooterOptions.withShow +actually 1 value +##### fn options.footer.withShow ```jsonnet -options.footer.TableFooterOptions.withShow(value=true) +options.footer.withShow(value=true) ``` PARAMETERS: diff --git a/docs/API/panel/table/queryOptions/transformation.md b/docs/API/panel/table/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/table/queryOptions/transformation.md +++ b/docs/API/panel/table/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/table/standardOptions/mapping.md b/docs/API/panel/table/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/table/standardOptions/mapping.md +++ b/docs/API/panel/table/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/table/standardOptions/threshold/step.md b/docs/API/panel/table/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/table/standardOptions/threshold/step.md +++ b/docs/API/panel/table/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/text/index.md b/docs/API/panel/text/index.md index 460aa72a..82e0a100 100644 --- a/docs/API/panel/text/index.md +++ b/docs/API/panel/text/index.md @@ -22,7 +22,7 @@ grafonnet.panel.text * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) * [`fn withMode(value)`](#fn-optionswithmode) * [`obj code`](#obj-optionscode) - * [`fn withLanguage(value="plaintext")`](#fn-optionscodewithlanguage) + * [`fn withLanguage(value)`](#fn-optionscodewithlanguage) * [`fn withShowLineNumbers(value=true)`](#fn-optionscodewithshowlinenumbers) * [`fn withShowMiniMap(value=true)`](#fn-optionscodewithshowminimap) * [`obj panelOptions`](#obj-paneloptions) @@ -162,14 +162,13 @@ PARAMETERS: ##### fn options.code.withLanguage ```jsonnet -options.code.withLanguage(value="plaintext") +options.code.withLanguage(value) ``` PARAMETERS: * **value** (`string`) - - default value: `"plaintext"` - - valid values: `"plaintext"`, `"yaml"`, `"xml"`, `"typescript"`, `"sql"`, `"go"`, `"markdown"`, `"html"`, `"json"` + - valid values: `"json"`, `"yaml"`, `"xml"`, `"typescript"`, `"sql"`, `"go"`, `"markdown"`, `"html"`, `"plaintext"` ##### fn options.code.withShowLineNumbers diff --git a/docs/API/panel/text/queryOptions/transformation.md b/docs/API/panel/text/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/text/queryOptions/transformation.md +++ b/docs/API/panel/text/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/text/standardOptions/mapping.md b/docs/API/panel/text/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/text/standardOptions/mapping.md +++ b/docs/API/panel/text/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/text/standardOptions/threshold/step.md b/docs/API/panel/text/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/text/standardOptions/threshold/step.md +++ b/docs/API/panel/text/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/timeSeries/index.md b/docs/API/panel/timeSeries/index.md index 4b2fa8f4..0868e660 100644 --- a/docs/API/panel/timeSeries/index.md +++ b/docs/API/panel/timeSeries/index.md @@ -76,6 +76,7 @@ grafonnet.panel.timeSeries * [`obj options`](#obj-options) * [`fn withLegend(value)`](#fn-optionswithlegend) * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) * [`fn withTimezone(value)`](#fn-optionswithtimezone) * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) * [`fn withTooltip(value)`](#fn-optionswithtooltip) @@ -91,6 +92,9 @@ grafonnet.panel.timeSeries * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) * [`obj tooltip`](#obj-optionstooltip) * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) @@ -274,7 +278,7 @@ fieldConfig.defaults.custom.withBarAlignment(value) PARAMETERS: -* **value** (`integer`) +* **value** (`string`) - valid values: `-1`, `0`, `1` TODO docs @@ -787,6 +791,18 @@ PARAMETERS: * **value** (`object`) +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + TODO docs #### fn options.withTimezone @@ -952,6 +968,25 @@ PARAMETERS: * **value** (`number`) +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone #### obj options.tooltip diff --git a/docs/API/panel/timeSeries/queryOptions/transformation.md b/docs/API/panel/timeSeries/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/timeSeries/queryOptions/transformation.md +++ b/docs/API/panel/timeSeries/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/timeSeries/standardOptions/mapping.md b/docs/API/panel/timeSeries/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/timeSeries/standardOptions/mapping.md +++ b/docs/API/panel/timeSeries/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/timeSeries/standardOptions/threshold/step.md b/docs/API/panel/timeSeries/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/timeSeries/standardOptions/threshold/step.md +++ b/docs/API/panel/timeSeries/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/trend/index.md b/docs/API/panel/trend/index.md index ad7d92c0..9a3dfabb 100644 --- a/docs/API/panel/trend/index.md +++ b/docs/API/panel/trend/index.md @@ -273,7 +273,7 @@ fieldConfig.defaults.custom.withBarAlignment(value) PARAMETERS: -* **value** (`integer`) +* **value** (`string`) - valid values: `-1`, `0`, `1` TODO docs diff --git a/docs/API/panel/trend/queryOptions/transformation.md b/docs/API/panel/trend/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/trend/queryOptions/transformation.md +++ b/docs/API/panel/trend/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/trend/standardOptions/mapping.md b/docs/API/panel/trend/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/trend/standardOptions/mapping.md +++ b/docs/API/panel/trend/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/trend/standardOptions/threshold/step.md b/docs/API/panel/trend/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/trend/standardOptions/threshold/step.md +++ b/docs/API/panel/trend/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/xyChart/index.md b/docs/API/panel/xyChart/index.md index eba78057..12137f35 100644 --- a/docs/API/panel/xyChart/index.md +++ b/docs/API/panel/xyChart/index.md @@ -564,7 +564,7 @@ PARAMETERS: * **value** (`string`) - +color value ###### obj fieldConfig.defaults.custom.lineStyle @@ -626,7 +626,7 @@ PARAMETERS: * **value** (`string`) - +color value ###### obj fieldConfig.defaults.custom.pointSize diff --git a/docs/API/panel/xyChart/options/series.md b/docs/API/panel/xyChart/options/series.md index 80fed2f7..30e01524 100644 --- a/docs/API/panel/xyChart/options/series.md +++ b/docs/API/panel/xyChart/options/series.md @@ -502,7 +502,7 @@ PARAMETERS: * **value** (`string`) - +color value ### obj lineStyle @@ -564,7 +564,7 @@ PARAMETERS: * **value** (`string`) - +color value ### obj pointSize diff --git a/docs/API/panel/xyChart/queryOptions/transformation.md b/docs/API/panel/xyChart/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/xyChart/queryOptions/transformation.md +++ b/docs/API/panel/xyChart/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/xyChart/standardOptions/mapping.md b/docs/API/panel/xyChart/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/xyChart/standardOptions/mapping.md +++ b/docs/API/panel/xyChart/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/xyChart/standardOptions/threshold/step.md b/docs/API/panel/xyChart/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/xyChart/standardOptions/threshold/step.md +++ b/docs/API/panel/xyChart/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/query/azureMonitor/azureMonitor/dimensionFilters.md b/docs/API/query/azuremonitor/azureMonitor/dimensionFilters.md similarity index 100% rename from docs/API/query/azureMonitor/azureMonitor/dimensionFilters.md rename to docs/API/query/azuremonitor/azureMonitor/dimensionFilters.md diff --git a/docs/API/query/azureMonitor/azureMonitor/resources.md b/docs/API/query/azuremonitor/azureMonitor/resources.md similarity index 100% rename from docs/API/query/azureMonitor/azureMonitor/resources.md rename to docs/API/query/azuremonitor/azureMonitor/resources.md diff --git a/docs/API/query/azureMonitor/azureTraces/filters.md b/docs/API/query/azuremonitor/azureTraces/filters.md similarity index 100% rename from docs/API/query/azureMonitor/azureTraces/filters.md rename to docs/API/query/azuremonitor/azureTraces/filters.md diff --git a/docs/API/query/azureMonitor/index.md b/docs/API/query/azuremonitor/index.md similarity index 92% rename from docs/API/query/azureMonitor/index.md rename to docs/API/query/azuremonitor/index.md index 05b67bff..1355e0ef 100644 --- a/docs/API/query/azureMonitor/index.md +++ b/docs/API/query/azuremonitor/index.md @@ -1,6 +1,6 @@ -# azureMonitor +# azuremonitor -grafonnet.query.azureMonitor +grafonnet.query.azuremonitor ## Subpackages @@ -19,6 +19,7 @@ grafonnet.query.azureMonitor * [`fn withAzureTraces(value)`](#fn-withazuretraces) * [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) * [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) * [`fn withHide(value=true)`](#fn-withhide) @@ -98,51 +99,51 @@ grafonnet.query.azureMonitor * [`fn withWorkspacesQuery(value)`](#fn-grafanatemplatevariablefnwithworkspacesquery) * [`fn withWorkspacesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithworkspacesquerymixin) * [`obj AppInsightsGroupByQuery`](#obj-grafanatemplatevariablefnappinsightsgroupbyquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithkind) * [`fn withMetricName(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithmetricname) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithrawquery) * [`obj AppInsightsMetricNameQuery`](#obj-grafanatemplatevariablefnappinsightsmetricnamequery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithkind) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithrawquery) * [`obj MetricDefinitionsQuery`](#obj-grafanatemplatevariablefnmetricdefinitionsquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithkind) * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithmetricnamespace) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithrawquery) * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcegroup) * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcename) * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithsubscription) * [`obj MetricNamesQuery`](#obj-grafanatemplatevariablefnmetricnamesquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamesquerywithkind) * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithmetricnamespace) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithrawquery) * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcegroup) * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcename) * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithsubscription) * [`obj MetricNamespaceQuery`](#obj-grafanatemplatevariablefnmetricnamespacequery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamespacequerywithkind) * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithmetricnamespace) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithrawquery) * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcegroup) * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcename) * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithsubscription) * [`obj ResourceGroupsQuery`](#obj-grafanatemplatevariablefnresourcegroupsquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcegroupsquerywithkind) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithrawquery) * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithsubscription) * [`obj ResourceNamesQuery`](#obj-grafanatemplatevariablefnresourcenamesquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcenamesquerywithkind) * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithmetricnamespace) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithrawquery) * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithresourcegroup) * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithsubscription) * [`obj SubscriptionsQuery`](#obj-grafanatemplatevariablefnsubscriptionsquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnsubscriptionsquerywithkind) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithrawquery) * [`obj UnknownQuery`](#obj-grafanatemplatevariablefnunknownquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnunknownquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnunknownquerywithkind) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnunknownquerywithrawquery) * [`obj WorkspacesQuery`](#obj-grafanatemplatevariablefnworkspacesquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithkind) + * [`fn withKind()`](#fn-grafanatemplatevariablefnworkspacesquerywithkind) * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithrawquery) * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithsubscription) @@ -244,7 +245,21 @@ withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. @@ -283,9 +298,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withNamespace ```jsonnet @@ -1087,13 +1100,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind ```jsonnet -grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind(value) +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"AppInsightsGroupByQuery"` ##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName @@ -1124,13 +1133,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind ```jsonnet -grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind(value) +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"AppInsightsMetricNameQuery"` ##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery @@ -1150,13 +1155,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind ```jsonnet -grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind(value) +grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"MetricDefinitionsQuery"` ##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace @@ -1220,13 +1221,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withKind ```jsonnet -grafanaTemplateVariableFn.MetricNamesQuery.withKind(value) +grafanaTemplateVariableFn.MetricNamesQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"MetricNamesQuery"` ##### fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace @@ -1290,13 +1287,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind ```jsonnet -grafanaTemplateVariableFn.MetricNamespaceQuery.withKind(value) +grafanaTemplateVariableFn.MetricNamespaceQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"MetricNamespaceQuery"` ##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace @@ -1360,13 +1353,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind ```jsonnet -grafanaTemplateVariableFn.ResourceGroupsQuery.withKind(value) +grafanaTemplateVariableFn.ResourceGroupsQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"ResourceGroupsQuery"` ##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery @@ -1397,13 +1386,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind ```jsonnet -grafanaTemplateVariableFn.ResourceNamesQuery.withKind(value) +grafanaTemplateVariableFn.ResourceNamesQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"ResourceNamesQuery"` ##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace @@ -1456,13 +1441,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind ```jsonnet -grafanaTemplateVariableFn.SubscriptionsQuery.withKind(value) +grafanaTemplateVariableFn.SubscriptionsQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"SubscriptionsQuery"` ##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery @@ -1482,13 +1463,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.UnknownQuery.withKind ```jsonnet -grafanaTemplateVariableFn.UnknownQuery.withKind(value) +grafanaTemplateVariableFn.UnknownQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"UnknownQuery"` ##### fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery @@ -1508,13 +1485,9 @@ PARAMETERS: ##### fn grafanaTemplateVariableFn.WorkspacesQuery.withKind ```jsonnet -grafanaTemplateVariableFn.WorkspacesQuery.withKind(value) +grafanaTemplateVariableFn.WorkspacesQuery.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"WorkspacesQuery"` ##### fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery diff --git a/docs/API/query/cloudWatch/CloudWatchLogsQuery/logGroups.md b/docs/API/query/cloudwatch/CloudWatchLogsQuery/logGroups.md similarity index 100% rename from docs/API/query/cloudWatch/CloudWatchLogsQuery/logGroups.md rename to docs/API/query/cloudwatch/CloudWatchLogsQuery/logGroups.md diff --git a/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md similarity index 68% rename from docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md rename to docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md index a7f04020..d2fb19d9 100644 --- a/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md +++ b/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md @@ -5,7 +5,7 @@ ## Index * [`fn withName(value)`](#fn-withname) -* [`fn withType(value)`](#fn-withtype) +* [`fn withType()`](#fn-withtype) ## Fields @@ -23,10 +23,7 @@ PARAMETERS: ### fn withType ```jsonnet -withType(value) +withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md similarity index 68% rename from docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md rename to docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md index a7f04020..d2fb19d9 100644 --- a/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md +++ b/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md @@ -5,7 +5,7 @@ ## Index * [`fn withName(value)`](#fn-withname) -* [`fn withType(value)`](#fn-withtype) +* [`fn withType()`](#fn-withtype) ## Fields @@ -23,10 +23,7 @@ PARAMETERS: ### fn withType ```jsonnet -withType(value) +withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md b/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md similarity index 68% rename from docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md rename to docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md index a7f04020..d2fb19d9 100644 --- a/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md +++ b/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md @@ -5,7 +5,7 @@ ## Index * [`fn withName(value)`](#fn-withname) -* [`fn withType(value)`](#fn-withtype) +* [`fn withType()`](#fn-withtype) ## Fields @@ -23,10 +23,7 @@ PARAMETERS: ### fn withType ```jsonnet -withType(value) +withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/query/cloudWatch/index.md b/docs/API/query/cloudwatch/index.md similarity index 93% rename from docs/API/query/cloudWatch/index.md rename to docs/API/query/cloudwatch/index.md index 36cc7219..d6b1381c 100644 --- a/docs/API/query/cloudWatch/index.md +++ b/docs/API/query/cloudwatch/index.md @@ -1,6 +1,6 @@ -# cloudWatch +# cloudwatch -grafonnet.query.cloudWatch +grafonnet.query.cloudwatch ## Subpackages @@ -16,6 +16,7 @@ grafonnet.query.cloudWatch * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-cloudwatchannotationquerywithdatasourcemixin) * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) @@ -33,6 +34,7 @@ grafonnet.query.cloudWatch * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) * [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-cloudwatchlogsquerywithdatasourcemixin) * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) @@ -50,6 +52,7 @@ grafonnet.query.cloudWatch * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-cloudwatchmetricsquerywithdatasourcemixin) * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) @@ -94,11 +97,11 @@ grafonnet.query.cloudWatch * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithname) * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparameters) * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparametersmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) * [`obj QueryEditorPropertyExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpression) * [`fn withProperty(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithproperty) * [`fn withPropertyMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithpropertymixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithtype) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithtype) * [`obj property`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionproperty) * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithname) * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithtype) @@ -110,12 +113,12 @@ grafonnet.query.cloudWatch * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbywithname) * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparameters) * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparametersmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlorderbywithtype) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlorderbywithtype) * [`obj select`](#obj-cloudwatchmetricsquerysqlselect) * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectwithname) * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlselectwithparameters) * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlselectwithparametersmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlselectwithtype) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlselectwithtype) * [`obj where`](#obj-cloudwatchmetricsquerysqlwhere) * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressions) * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressionsmixin) @@ -173,7 +176,21 @@ CloudWatchAnnotationQuery.withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchAnnotationQuery.withDatasourceMixin + +```jsonnet +CloudWatchAnnotationQuery.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. @@ -212,9 +229,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. #### fn CloudWatchAnnotationQuery.withMatchExact ```jsonnet @@ -364,7 +379,21 @@ CloudWatchLogsQuery.withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchLogsQuery.withDatasourceMixin + +```jsonnet +CloudWatchLogsQuery.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. @@ -392,9 +421,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. #### fn CloudWatchLogsQuery.withId ```jsonnet @@ -554,7 +581,21 @@ CloudWatchMetricsQuery.withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchMetricsQuery.withDatasourceMixin + +```jsonnet +CloudWatchMetricsQuery.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. @@ -604,9 +645,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. #### fn CloudWatchMetricsQuery.withId ```jsonnet @@ -649,7 +688,7 @@ CloudWatchMetricsQuery.withMetricEditorMode(value) PARAMETERS: -* **value** (`integer`) +* **value** (`string`) - valid values: `0`, `1` @@ -672,7 +711,7 @@ CloudWatchMetricsQuery.withMetricQueryType(value) PARAMETERS: -* **value** (`integer`) +* **value** (`string`) - valid values: `0`, `1` @@ -1033,12 +1072,9 @@ PARAMETERS: ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType ```jsonnet -CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType(value) +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType() ``` -PARAMETERS: - -* **value** (`string`) ###### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression @@ -1069,12 +1105,9 @@ PARAMETERS: ####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType ```jsonnet -CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType(value) +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType() ``` -PARAMETERS: - -* **value** (`string`) ####### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property @@ -1179,12 +1212,9 @@ PARAMETERS: ###### fn CloudWatchMetricsQuery.sql.orderBy.withType ```jsonnet -CloudWatchMetricsQuery.sql.orderBy.withType(value) +CloudWatchMetricsQuery.sql.orderBy.withType() ``` -PARAMETERS: - -* **value** (`string`) ##### obj CloudWatchMetricsQuery.sql.select @@ -1226,12 +1256,9 @@ PARAMETERS: ###### fn CloudWatchMetricsQuery.sql.select.withType ```jsonnet -CloudWatchMetricsQuery.sql.select.withType(value) +CloudWatchMetricsQuery.sql.select.withType() ``` -PARAMETERS: - -* **value** (`string`) ##### obj CloudWatchMetricsQuery.sql.where diff --git a/docs/API/query/elasticsearch/bucketAggs/index.md b/docs/API/query/elasticsearch/bucketAggs/index.md deleted file mode 100644 index 07316dbc..00000000 --- a/docs/API/query/elasticsearch/bucketAggs/index.md +++ /dev/null @@ -1,585 +0,0 @@ -# bucketAggs - - - -## Subpackages - -* [Filters.settings.filters](Filters/settings/filters.md) - -## Index - -* [`obj DateHistogram`](#obj-datehistogram) - * [`fn withField(value)`](#fn-datehistogramwithfield) - * [`fn withId(value)`](#fn-datehistogramwithid) - * [`fn withSettings(value)`](#fn-datehistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-datehistogramwithsettingsmixin) - * [`fn withType(value)`](#fn-datehistogramwithtype) - * [`obj settings`](#obj-datehistogramsettings) - * [`fn withInterval(value)`](#fn-datehistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-datehistogramsettingswithmindoccount) - * [`fn withOffset(value)`](#fn-datehistogramsettingswithoffset) - * [`fn withTimeZone(value)`](#fn-datehistogramsettingswithtimezone) - * [`fn withTrimEdges(value)`](#fn-datehistogramsettingswithtrimedges) -* [`obj Filters`](#obj-filters) - * [`fn withId(value)`](#fn-filterswithid) - * [`fn withSettings(value)`](#fn-filterswithsettings) - * [`fn withSettingsMixin(value)`](#fn-filterswithsettingsmixin) - * [`fn withType(value)`](#fn-filterswithtype) - * [`obj settings`](#obj-filterssettings) - * [`fn withFilters(value)`](#fn-filterssettingswithfilters) - * [`fn withFiltersMixin(value)`](#fn-filterssettingswithfiltersmixin) -* [`obj GeoHashGrid`](#obj-geohashgrid) - * [`fn withField(value)`](#fn-geohashgridwithfield) - * [`fn withId(value)`](#fn-geohashgridwithid) - * [`fn withSettings(value)`](#fn-geohashgridwithsettings) - * [`fn withSettingsMixin(value)`](#fn-geohashgridwithsettingsmixin) - * [`fn withType(value)`](#fn-geohashgridwithtype) - * [`obj settings`](#obj-geohashgridsettings) - * [`fn withPrecision(value)`](#fn-geohashgridsettingswithprecision) -* [`obj Histogram`](#obj-histogram) - * [`fn withField(value)`](#fn-histogramwithfield) - * [`fn withId(value)`](#fn-histogramwithid) - * [`fn withSettings(value)`](#fn-histogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-histogramwithsettingsmixin) - * [`fn withType(value)`](#fn-histogramwithtype) - * [`obj settings`](#obj-histogramsettings) - * [`fn withInterval(value)`](#fn-histogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-histogramsettingswithmindoccount) -* [`obj Nested`](#obj-nested) - * [`fn withField(value)`](#fn-nestedwithfield) - * [`fn withId(value)`](#fn-nestedwithid) - * [`fn withSettings(value)`](#fn-nestedwithsettings) - * [`fn withSettingsMixin(value)`](#fn-nestedwithsettingsmixin) - * [`fn withType(value)`](#fn-nestedwithtype) -* [`obj Terms`](#obj-terms) - * [`fn withField(value)`](#fn-termswithfield) - * [`fn withId(value)`](#fn-termswithid) - * [`fn withSettings(value)`](#fn-termswithsettings) - * [`fn withSettingsMixin(value)`](#fn-termswithsettingsmixin) - * [`fn withType(value)`](#fn-termswithtype) - * [`obj settings`](#obj-termssettings) - * [`fn withMinDocCount(value)`](#fn-termssettingswithmindoccount) - * [`fn withMissing(value)`](#fn-termssettingswithmissing) - * [`fn withOrder(value)`](#fn-termssettingswithorder) - * [`fn withOrderBy(value)`](#fn-termssettingswithorderby) - * [`fn withSize(value)`](#fn-termssettingswithsize) - -## Fields - -### obj DateHistogram - - -#### fn DateHistogram.withField - -```jsonnet -DateHistogram.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn DateHistogram.withId - -```jsonnet -DateHistogram.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn DateHistogram.withSettings - -```jsonnet -DateHistogram.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn DateHistogram.withSettingsMixin - -```jsonnet -DateHistogram.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn DateHistogram.withType - -```jsonnet -DateHistogram.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj DateHistogram.settings - - -##### fn DateHistogram.settings.withInterval - -```jsonnet -DateHistogram.settings.withInterval(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn DateHistogram.settings.withMinDocCount - -```jsonnet -DateHistogram.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn DateHistogram.settings.withOffset - -```jsonnet -DateHistogram.settings.withOffset(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn DateHistogram.settings.withTimeZone - -```jsonnet -DateHistogram.settings.withTimeZone(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn DateHistogram.settings.withTrimEdges - -```jsonnet -DateHistogram.settings.withTrimEdges(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj Filters - - -#### fn Filters.withId - -```jsonnet -Filters.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Filters.withSettings - -```jsonnet -Filters.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Filters.withSettingsMixin - -```jsonnet -Filters.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Filters.withType - -```jsonnet -Filters.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj Filters.settings - - -##### fn Filters.settings.withFilters - -```jsonnet -Filters.settings.withFilters(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn Filters.settings.withFiltersMixin - -```jsonnet -Filters.settings.withFiltersMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### obj GeoHashGrid - - -#### fn GeoHashGrid.withField - -```jsonnet -GeoHashGrid.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn GeoHashGrid.withId - -```jsonnet -GeoHashGrid.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn GeoHashGrid.withSettings - -```jsonnet -GeoHashGrid.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn GeoHashGrid.withSettingsMixin - -```jsonnet -GeoHashGrid.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn GeoHashGrid.withType - -```jsonnet -GeoHashGrid.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj GeoHashGrid.settings - - -##### fn GeoHashGrid.settings.withPrecision - -```jsonnet -GeoHashGrid.settings.withPrecision(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj Histogram - - -#### fn Histogram.withField - -```jsonnet -Histogram.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Histogram.withId - -```jsonnet -Histogram.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Histogram.withSettings - -```jsonnet -Histogram.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Histogram.withSettingsMixin - -```jsonnet -Histogram.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Histogram.withType - -```jsonnet -Histogram.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj Histogram.settings - - -##### fn Histogram.settings.withInterval - -```jsonnet -Histogram.settings.withInterval(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn Histogram.settings.withMinDocCount - -```jsonnet -Histogram.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj Nested - - -#### fn Nested.withField - -```jsonnet -Nested.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Nested.withId - -```jsonnet -Nested.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Nested.withSettings - -```jsonnet -Nested.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Nested.withSettingsMixin - -```jsonnet -Nested.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Nested.withType - -```jsonnet -Nested.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj Terms - - -#### fn Terms.withField - -```jsonnet -Terms.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Terms.withId - -```jsonnet -Terms.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Terms.withSettings - -```jsonnet -Terms.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Terms.withSettingsMixin - -```jsonnet -Terms.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn Terms.withType - -```jsonnet -Terms.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj Terms.settings - - -##### fn Terms.settings.withMinDocCount - -```jsonnet -Terms.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn Terms.settings.withMissing - -```jsonnet -Terms.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn Terms.settings.withOrder - -```jsonnet -Terms.settings.withOrder(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"desc"`, `"asc"` - - -##### fn Terms.settings.withOrderBy - -```jsonnet -Terms.settings.withOrderBy(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn Terms.settings.withSize - -```jsonnet -Terms.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - diff --git a/docs/API/query/elasticsearch/index.md b/docs/API/query/elasticsearch/index.md index b5926b0b..d26292ae 100644 --- a/docs/API/query/elasticsearch/index.md +++ b/docs/API/query/elasticsearch/index.md @@ -4,8 +4,9 @@ grafonnet.query.elasticsearch ## Subpackages -* [bucketAggs](bucketAggs/index.md) -* [metrics](metrics/index.md) +* [bucketAggs.Filters.settings.filters](bucketAggs/Filters/settings/filters.md) +* [metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables](metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [metrics.PipelineMetricAggregation.BucketScript.pipelineVariables](metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md) ## Index @@ -13,6 +14,7 @@ grafonnet.query.elasticsearch * [`fn withBucketAggs(value)`](#fn-withbucketaggs) * [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withMetrics(value)`](#fn-withmetrics) * [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) @@ -20,6 +22,314 @@ grafonnet.query.elasticsearch * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) * [`fn withTimeField(value)`](#fn-withtimefield) +* [`obj bucketAggs`](#obj-bucketaggs) + * [`obj DateHistogram`](#obj-bucketaggsdatehistogram) + * [`fn withField(value)`](#fn-bucketaggsdatehistogramwithfield) + * [`fn withId(value)`](#fn-bucketaggsdatehistogramwithid) + * [`fn withSettings(value)`](#fn-bucketaggsdatehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsdatehistogramwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsdatehistogramwithtype) + * [`obj settings`](#obj-bucketaggsdatehistogramsettings) + * [`fn withInterval(value)`](#fn-bucketaggsdatehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-bucketaggsdatehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-bucketaggsdatehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-bucketaggsdatehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-bucketaggsdatehistogramsettingswithtrimedges) + * [`obj Filters`](#obj-bucketaggsfilters) + * [`fn withId(value)`](#fn-bucketaggsfilterswithid) + * [`fn withSettings(value)`](#fn-bucketaggsfilterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsfilterswithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsfilterswithtype) + * [`obj settings`](#obj-bucketaggsfilterssettings) + * [`fn withFilters(value)`](#fn-bucketaggsfilterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-bucketaggsfilterssettingswithfiltersmixin) + * [`obj GeoHashGrid`](#obj-bucketaggsgeohashgrid) + * [`fn withField(value)`](#fn-bucketaggsgeohashgridwithfield) + * [`fn withId(value)`](#fn-bucketaggsgeohashgridwithid) + * [`fn withSettings(value)`](#fn-bucketaggsgeohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsgeohashgridwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsgeohashgridwithtype) + * [`obj settings`](#obj-bucketaggsgeohashgridsettings) + * [`fn withPrecision(value)`](#fn-bucketaggsgeohashgridsettingswithprecision) + * [`obj Histogram`](#obj-bucketaggshistogram) + * [`fn withField(value)`](#fn-bucketaggshistogramwithfield) + * [`fn withId(value)`](#fn-bucketaggshistogramwithid) + * [`fn withSettings(value)`](#fn-bucketaggshistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggshistogramwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggshistogramwithtype) + * [`obj settings`](#obj-bucketaggshistogramsettings) + * [`fn withInterval(value)`](#fn-bucketaggshistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-bucketaggshistogramsettingswithmindoccount) + * [`obj Nested`](#obj-bucketaggsnested) + * [`fn withField(value)`](#fn-bucketaggsnestedwithfield) + * [`fn withId(value)`](#fn-bucketaggsnestedwithid) + * [`fn withSettings(value)`](#fn-bucketaggsnestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsnestedwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsnestedwithtype) + * [`obj Terms`](#obj-bucketaggsterms) + * [`fn withField(value)`](#fn-bucketaggstermswithfield) + * [`fn withId(value)`](#fn-bucketaggstermswithid) + * [`fn withSettings(value)`](#fn-bucketaggstermswithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggstermswithsettingsmixin) + * [`fn withType()`](#fn-bucketaggstermswithtype) + * [`obj settings`](#obj-bucketaggstermssettings) + * [`fn withMinDocCount(value)`](#fn-bucketaggstermssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-bucketaggstermssettingswithmissing) + * [`fn withOrder(value)`](#fn-bucketaggstermssettingswithorder) + * [`fn withOrderBy(value)`](#fn-bucketaggstermssettingswithorderby) + * [`fn withSize(value)`](#fn-bucketaggstermssettingswithsize) +* [`obj metrics`](#obj-metrics) + * [`obj Count`](#obj-metricscount) + * [`fn withHide(value=true)`](#fn-metricscountwithhide) + * [`fn withId(value)`](#fn-metricscountwithid) + * [`fn withType()`](#fn-metricscountwithtype) + * [`obj MetricAggregationWithSettings`](#obj-metricsmetricaggregationwithsettings) + * [`obj Average`](#obj-metricsmetricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricsmetricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricsmetricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricsmetricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricsmetricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricsmetricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricsmetricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricsmetricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricsmetricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricsmetricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricsmetricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricsmetricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricsmetricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricsmetricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricsmetricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricsmetricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricsmetricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricsmetricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricsmetricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) + * [`obj PipelineMetricAggregation`](#obj-metricspipelinemetricaggregation) + * [`obj BucketScript`](#obj-metricspipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-metricspipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricspipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricspipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-metricspipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricspipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricspipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-metricspipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-metricspipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-metricspipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-metricspipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationmovingaveragewithtype) ## Fields @@ -33,7 +343,7 @@ PARAMETERS: * **value** (`string`) -Alias pattern + ### fn withBucketAggs ```jsonnet @@ -44,7 +354,7 @@ PARAMETERS: * **value** (`array`) -List of bucket aggregations + ### fn withBucketAggsMixin ```jsonnet @@ -55,7 +365,7 @@ PARAMETERS: * **value** (`array`) -List of bucket aggregations + ### fn withDatasource ```jsonnet @@ -64,12 +374,20 @@ withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null ### fn withHide ```jsonnet @@ -81,9 +399,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) + ### fn withMetrics ```jsonnet @@ -94,7 +410,7 @@ PARAMETERS: * **value** (`array`) -List of metric aggregations + ### fn withMetricsMixin ```jsonnet @@ -105,7 +421,7 @@ PARAMETERS: * **value** (`array`) -List of metric aggregations + ### fn withQuery ```jsonnet @@ -116,7 +432,7 @@ PARAMETERS: * **value** (`string`) -Lucene query + ### fn withQueryType ```jsonnet @@ -127,8 +443,7 @@ PARAMETERS: * **value** (`string`) -Specify the query flavor -TODO make this required and give it a default + ### fn withRefId ```jsonnet @@ -139,9 +454,7 @@ PARAMETERS: * **value** (`string`) -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. + ### fn withTimeField ```jsonnet @@ -152,4 +465,2792 @@ PARAMETERS: * **value** (`string`) -Name of time field \ No newline at end of file + +### obj bucketAggs + + +#### obj bucketAggs.DateHistogram + + +##### fn bucketAggs.DateHistogram.withField + +```jsonnet +bucketAggs.DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.DateHistogram.withId + +```jsonnet +bucketAggs.DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.DateHistogram.withSettings + +```jsonnet +bucketAggs.DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.DateHistogram.withSettingsMixin + +```jsonnet +bucketAggs.DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.DateHistogram.withType + +```jsonnet +bucketAggs.DateHistogram.withType() +``` + + + +##### obj bucketAggs.DateHistogram.settings + + +###### fn bucketAggs.DateHistogram.settings.withInterval + +```jsonnet +bucketAggs.DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withMinDocCount + +```jsonnet +bucketAggs.DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withOffset + +```jsonnet +bucketAggs.DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withTimeZone + +```jsonnet +bucketAggs.DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withTrimEdges + +```jsonnet +bucketAggs.DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj bucketAggs.Filters + + +##### fn bucketAggs.Filters.withId + +```jsonnet +bucketAggs.Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Filters.withSettings + +```jsonnet +bucketAggs.Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Filters.withSettingsMixin + +```jsonnet +bucketAggs.Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Filters.withType + +```jsonnet +bucketAggs.Filters.withType() +``` + + + +##### obj bucketAggs.Filters.settings + + +###### fn bucketAggs.Filters.settings.withFilters + +```jsonnet +bucketAggs.Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn bucketAggs.Filters.settings.withFiltersMixin + +```jsonnet +bucketAggs.Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### obj bucketAggs.GeoHashGrid + + +##### fn bucketAggs.GeoHashGrid.withField + +```jsonnet +bucketAggs.GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.GeoHashGrid.withId + +```jsonnet +bucketAggs.GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.GeoHashGrid.withSettings + +```jsonnet +bucketAggs.GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.GeoHashGrid.withSettingsMixin + +```jsonnet +bucketAggs.GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.GeoHashGrid.withType + +```jsonnet +bucketAggs.GeoHashGrid.withType() +``` + + + +##### obj bucketAggs.GeoHashGrid.settings + + +###### fn bucketAggs.GeoHashGrid.settings.withPrecision + +```jsonnet +bucketAggs.GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj bucketAggs.Histogram + + +##### fn bucketAggs.Histogram.withField + +```jsonnet +bucketAggs.Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Histogram.withId + +```jsonnet +bucketAggs.Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Histogram.withSettings + +```jsonnet +bucketAggs.Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Histogram.withSettingsMixin + +```jsonnet +bucketAggs.Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Histogram.withType + +```jsonnet +bucketAggs.Histogram.withType() +``` + + + +##### obj bucketAggs.Histogram.settings + + +###### fn bucketAggs.Histogram.settings.withInterval + +```jsonnet +bucketAggs.Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Histogram.settings.withMinDocCount + +```jsonnet +bucketAggs.Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj bucketAggs.Nested + + +##### fn bucketAggs.Nested.withField + +```jsonnet +bucketAggs.Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Nested.withId + +```jsonnet +bucketAggs.Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Nested.withSettings + +```jsonnet +bucketAggs.Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Nested.withSettingsMixin + +```jsonnet +bucketAggs.Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Nested.withType + +```jsonnet +bucketAggs.Nested.withType() +``` + + + +#### obj bucketAggs.Terms + + +##### fn bucketAggs.Terms.withField + +```jsonnet +bucketAggs.Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Terms.withId + +```jsonnet +bucketAggs.Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Terms.withSettings + +```jsonnet +bucketAggs.Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Terms.withSettingsMixin + +```jsonnet +bucketAggs.Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Terms.withType + +```jsonnet +bucketAggs.Terms.withType() +``` + + + +##### obj bucketAggs.Terms.settings + + +###### fn bucketAggs.Terms.settings.withMinDocCount + +```jsonnet +bucketAggs.Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Terms.settings.withMissing + +```jsonnet +bucketAggs.Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Terms.settings.withOrder + +```jsonnet +bucketAggs.Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +###### fn bucketAggs.Terms.settings.withOrderBy + +```jsonnet +bucketAggs.Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Terms.settings.withSize + +```jsonnet +bucketAggs.Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj metrics + + +#### obj metrics.Count + + +##### fn metrics.Count.withHide + +```jsonnet +metrics.Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn metrics.Count.withId + +```jsonnet +metrics.Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn metrics.Count.withType + +```jsonnet +metrics.Count.withType() +``` + + + +#### obj metrics.MetricAggregationWithSettings + + +##### obj metrics.MetricAggregationWithSettings.Average + + +###### fn metrics.MetricAggregationWithSettings.Average.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Average.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Average.settings + + +####### fn metrics.MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Average.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.BucketScript + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.BucketScript.settings + + +####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.BucketScript.settings.script + + +######## fn metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.CumulativeSum + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.CumulativeSum.settings + + +####### fn metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Derivative + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Derivative.settings + + +####### fn metrics.MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.ExtendedStats + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings.script + + +######## fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Logs + + +###### fn metrics.MetricAggregationWithSettings.Logs.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Logs.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Logs.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Logs.settings + + +####### fn metrics.MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Max + + +###### fn metrics.MetricAggregationWithSettings.Max.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Max.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Max.settings + + +####### fn metrics.MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Max.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Min + + +###### fn metrics.MetricAggregationWithSettings.Min.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Min.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Min.settings + + +####### fn metrics.MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Min.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.MovingAverage + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withType() +``` + + + +##### obj metrics.MetricAggregationWithSettings.MovingFunction + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.MovingFunction.settings + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj metrics.MetricAggregationWithSettings.MovingFunction.settings.script + + +######## fn metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Percentiles + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Percentiles.settings + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Percentiles.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Rate + + +###### fn metrics.MetricAggregationWithSettings.Rate.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Rate.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Rate.settings + + +####### fn metrics.MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.RawData + + +###### fn metrics.MetricAggregationWithSettings.RawData.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.RawData.withId + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawData.withType + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.RawData.settings + + +####### fn metrics.MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.RawDocument + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.RawDocument.settings + + +####### fn metrics.MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.SerialDiff + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.SerialDiff.settings + + +####### fn metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Sum + + +###### fn metrics.MetricAggregationWithSettings.Sum.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Sum.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Sum.settings + + +####### fn metrics.MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Sum.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.TopMetrics + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.TopMetrics.settings + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.UniqueCount + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.UniqueCount.settings + + +####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj metrics.PipelineMetricAggregation + + +##### obj metrics.PipelineMetricAggregation.BucketScript + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withId + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withType + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withType() +``` + + + +###### obj metrics.PipelineMetricAggregation.BucketScript.settings + + +####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.PipelineMetricAggregation.BucketScript.settings.script + + +######## fn metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.PipelineMetricAggregation.CumulativeSum + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withType() +``` + + + +###### obj metrics.PipelineMetricAggregation.CumulativeSum.settings + + +####### fn metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.PipelineMetricAggregation.Derivative + + +###### fn metrics.PipelineMetricAggregation.Derivative.withField + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withHide + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.Derivative.withId + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withType + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withType() +``` + + + +###### obj metrics.PipelineMetricAggregation.Derivative.settings + + +####### fn metrics.PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.PipelineMetricAggregation.MovingAverage + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withType() +``` + + diff --git a/docs/API/query/elasticsearch/metrics/index.md b/docs/API/query/elasticsearch/metrics/index.md deleted file mode 100644 index 60a0291e..00000000 --- a/docs/API/query/elasticsearch/metrics/index.md +++ /dev/null @@ -1,2616 +0,0 @@ -# metrics - - - -## Subpackages - -* [MetricAggregationWithSettings.BucketScript.pipelineVariables](MetricAggregationWithSettings/BucketScript/pipelineVariables.md) -* [PipelineMetricAggregation.BucketScript.pipelineVariables](PipelineMetricAggregation/BucketScript/pipelineVariables.md) - -## Index - -* [`obj Count`](#obj-count) - * [`fn withHide(value=true)`](#fn-countwithhide) - * [`fn withId(value)`](#fn-countwithid) - * [`fn withType(value)`](#fn-countwithtype) -* [`obj MetricAggregationWithSettings`](#obj-metricaggregationwithsettings) - * [`obj Average`](#obj-metricaggregationwithsettingsaverage) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsaveragewithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsaveragewithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsaveragewithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsaveragesettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsaveragesettingswithmissing) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscriptmixin) - * [`obj script`](#obj-metricaggregationwithsettingsaveragesettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingsaveragesettingsscriptwithinline) - * [`obj BucketScript`](#obj-metricaggregationwithsettingsbucketscript) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsbucketscriptwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricaggregationwithsettingsbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricaggregationwithsettingscumulativesum) - * [`fn withField(value)`](#fn-metricaggregationwithsettingscumulativesumwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingscumulativesumwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingscumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingscumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingscumulativesumwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingscumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricaggregationwithsettingscumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricaggregationwithsettingsderivative) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsderivativewithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsderivativewithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsderivativewithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsderivativewithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsderivativesettings) - * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsderivativesettingswithunit) - * [`obj ExtendedStats`](#obj-metricaggregationwithsettingsextendedstats) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsextendedstatswithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsextendedstatswithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsextendedstatswithid) - * [`fn withMeta(value)`](#fn-metricaggregationwithsettingsextendedstatswithmeta) - * [`fn withMetaMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithmetamixin) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsextendedstatswithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsextendedstatssettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithmissing) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscriptmixin) - * [`fn withSigma(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithsigma) - * [`obj script`](#obj-metricaggregationwithsettingsextendedstatssettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingsextendedstatssettingsscriptwithinline) - * [`obj Logs`](#obj-metricaggregationwithsettingslogs) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingslogswithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingslogswithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingslogswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingslogswithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingslogswithtype) - * [`obj settings`](#obj-metricaggregationwithsettingslogssettings) - * [`fn withLimit(value)`](#fn-metricaggregationwithsettingslogssettingswithlimit) - * [`obj Max`](#obj-metricaggregationwithsettingsmax) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsmaxwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmaxwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsmaxwithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmaxwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmaxwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsmaxwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsmaxsettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsmaxsettingswithmissing) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscriptmixin) - * [`obj script`](#obj-metricaggregationwithsettingsmaxsettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmaxsettingsscriptwithinline) - * [`obj Min`](#obj-metricaggregationwithsettingsmin) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsminwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsminwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsminwithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsminwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsminwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsminwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsminsettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsminsettingswithmissing) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingsminsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsminsettingswithscriptmixin) - * [`obj script`](#obj-metricaggregationwithsettingsminsettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingsminsettingsscriptwithinline) - * [`obj MovingAverage`](#obj-metricaggregationwithsettingsmovingaverage) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsmovingaveragewithtype) - * [`obj MovingFunction`](#obj-metricaggregationwithsettingsmovingfunction) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingfunctionwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithid) - * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsmovingfunctionsettings) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) - * [`fn withShift(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithshift) - * [`fn withWindow(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithwindow) - * [`obj script`](#obj-metricaggregationwithsettingsmovingfunctionsettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) - * [`obj Percentiles`](#obj-metricaggregationwithsettingspercentiles) - * [`fn withField(value)`](#fn-metricaggregationwithsettingspercentileswithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingspercentileswithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingspercentileswithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingspercentileswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingspercentileswithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingspercentileswithtype) - * [`obj settings`](#obj-metricaggregationwithsettingspercentilessettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingspercentilessettingswithmissing) - * [`fn withPercents(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercents) - * [`fn withPercentsMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercentsmixin) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscriptmixin) - * [`obj script`](#obj-metricaggregationwithsettingspercentilessettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingspercentilessettingsscriptwithinline) - * [`obj Rate`](#obj-metricaggregationwithsettingsrate) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsratewithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsratewithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsratewithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsratewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsratewithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsratewithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsratesettings) - * [`fn withMode(value)`](#fn-metricaggregationwithsettingsratesettingswithmode) - * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsratesettingswithunit) - * [`obj RawData`](#obj-metricaggregationwithsettingsrawdata) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdatawithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdatawithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdatawithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdatawithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsrawdatawithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsrawdatasettings) - * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdatasettingswithsize) - * [`obj RawDocument`](#obj-metricaggregationwithsettingsrawdocument) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdocumentwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdocumentwithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsrawdocumentwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsrawdocumentsettings) - * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdocumentsettingswithsize) - * [`obj SerialDiff`](#obj-metricaggregationwithsettingsserialdiff) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsserialdiffwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsserialdiffwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsserialdiffwithid) - * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsserialdiffwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsserialdiffwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsserialdiffsettings) - * [`fn withLag(value)`](#fn-metricaggregationwithsettingsserialdiffsettingswithlag) - * [`obj Sum`](#obj-metricaggregationwithsettingssum) - * [`fn withField(value)`](#fn-metricaggregationwithsettingssumwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingssumwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingssumwithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingssumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingssumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingssumwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingssumsettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingssumsettingswithmissing) - * [`fn withScript(value)`](#fn-metricaggregationwithsettingssumsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingssumsettingswithscriptmixin) - * [`obj script`](#obj-metricaggregationwithsettingssumsettingsscript) - * [`fn withInline(value)`](#fn-metricaggregationwithsettingssumsettingsscriptwithinline) - * [`obj TopMetrics`](#obj-metricaggregationwithsettingstopmetrics) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingstopmetricswithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingstopmetricswithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingstopmetricswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingstopmetricswithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingstopmetricswithtype) - * [`obj settings`](#obj-metricaggregationwithsettingstopmetricssettings) - * [`fn withMetrics(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetrics) - * [`fn withMetricsMixin(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetricsmixin) - * [`fn withOrder(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorder) - * [`fn withOrderBy(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorderby) - * [`obj UniqueCount`](#obj-metricaggregationwithsettingsuniquecount) - * [`fn withField(value)`](#fn-metricaggregationwithsettingsuniquecountwithfield) - * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsuniquecountwithhide) - * [`fn withId(value)`](#fn-metricaggregationwithsettingsuniquecountwithid) - * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettingsmixin) - * [`fn withType(value)`](#fn-metricaggregationwithsettingsuniquecountwithtype) - * [`obj settings`](#obj-metricaggregationwithsettingsuniquecountsettings) - * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithmissing) - * [`fn withPrecisionThreshold(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) -* [`obj PipelineMetricAggregation`](#obj-pipelinemetricaggregation) - * [`obj BucketScript`](#obj-pipelinemetricaggregationbucketscript) - * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationbucketscriptwithhide) - * [`fn withId(value)`](#fn-pipelinemetricaggregationbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettingsmixin) - * [`fn withType(value)`](#fn-pipelinemetricaggregationbucketscriptwithtype) - * [`obj settings`](#obj-pipelinemetricaggregationbucketscriptsettings) - * [`fn withScript(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-pipelinemetricaggregationbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-pipelinemetricaggregationbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-pipelinemetricaggregationcumulativesum) - * [`fn withField(value)`](#fn-pipelinemetricaggregationcumulativesumwithfield) - * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationcumulativesumwithhide) - * [`fn withId(value)`](#fn-pipelinemetricaggregationcumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationcumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettingsmixin) - * [`fn withType(value)`](#fn-pipelinemetricaggregationcumulativesumwithtype) - * [`obj settings`](#obj-pipelinemetricaggregationcumulativesumsettings) - * [`fn withFormat(value)`](#fn-pipelinemetricaggregationcumulativesumsettingswithformat) - * [`obj Derivative`](#obj-pipelinemetricaggregationderivative) - * [`fn withField(value)`](#fn-pipelinemetricaggregationderivativewithfield) - * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationderivativewithhide) - * [`fn withId(value)`](#fn-pipelinemetricaggregationderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-pipelinemetricaggregationderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationderivativewithsettingsmixin) - * [`fn withType(value)`](#fn-pipelinemetricaggregationderivativewithtype) - * [`obj settings`](#obj-pipelinemetricaggregationderivativesettings) - * [`fn withUnit(value)`](#fn-pipelinemetricaggregationderivativesettingswithunit) - * [`obj MovingAverage`](#obj-pipelinemetricaggregationmovingaverage) - * [`fn withField(value)`](#fn-pipelinemetricaggregationmovingaveragewithfield) - * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationmovingaveragewithhide) - * [`fn withId(value)`](#fn-pipelinemetricaggregationmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-pipelinemetricaggregationmovingaveragewithtype) - -## Fields - -### obj Count - - -#### fn Count.withHide - -```jsonnet -Count.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -#### fn Count.withId - -```jsonnet -Count.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn Count.withType - -```jsonnet -Count.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj MetricAggregationWithSettings - - -#### obj MetricAggregationWithSettings.Average - - -##### fn MetricAggregationWithSettings.Average.withField - -```jsonnet -MetricAggregationWithSettings.Average.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Average.withHide - -```jsonnet -MetricAggregationWithSettings.Average.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Average.withId - -```jsonnet -MetricAggregationWithSettings.Average.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Average.withSettings - -```jsonnet -MetricAggregationWithSettings.Average.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Average.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Average.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Average.withType - -```jsonnet -MetricAggregationWithSettings.Average.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Average.settings - - -###### fn MetricAggregationWithSettings.Average.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.Average.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.Average.settings.withScript - -```jsonnet -MetricAggregationWithSettings.Average.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.Average.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.Average.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj MetricAggregationWithSettings.Average.settings.script - - -####### fn MetricAggregationWithSettings.Average.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.Average.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.BucketScript - - -##### fn MetricAggregationWithSettings.BucketScript.withHide - -```jsonnet -MetricAggregationWithSettings.BucketScript.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.BucketScript.withId - -```jsonnet -MetricAggregationWithSettings.BucketScript.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariables - -```jsonnet -MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin - -```jsonnet -MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn MetricAggregationWithSettings.BucketScript.withSettings - -```jsonnet -MetricAggregationWithSettings.BucketScript.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.BucketScript.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.BucketScript.withType - -```jsonnet -MetricAggregationWithSettings.BucketScript.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.BucketScript.settings - - -###### fn MetricAggregationWithSettings.BucketScript.settings.withScript - -```jsonnet -MetricAggregationWithSettings.BucketScript.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.BucketScript.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj MetricAggregationWithSettings.BucketScript.settings.script - - -####### fn MetricAggregationWithSettings.BucketScript.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.CumulativeSum - - -##### fn MetricAggregationWithSettings.CumulativeSum.withField - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.CumulativeSum.withHide - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.CumulativeSum.withId - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.CumulativeSum.withPipelineAgg - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.CumulativeSum.withSettings - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.CumulativeSum.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.CumulativeSum.withType - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.CumulativeSum.settings - - -###### fn MetricAggregationWithSettings.CumulativeSum.settings.withFormat - -```jsonnet -MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Derivative - - -##### fn MetricAggregationWithSettings.Derivative.withField - -```jsonnet -MetricAggregationWithSettings.Derivative.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Derivative.withHide - -```jsonnet -MetricAggregationWithSettings.Derivative.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Derivative.withId - -```jsonnet -MetricAggregationWithSettings.Derivative.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Derivative.withPipelineAgg - -```jsonnet -MetricAggregationWithSettings.Derivative.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Derivative.withSettings - -```jsonnet -MetricAggregationWithSettings.Derivative.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Derivative.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Derivative.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Derivative.withType - -```jsonnet -MetricAggregationWithSettings.Derivative.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Derivative.settings - - -###### fn MetricAggregationWithSettings.Derivative.settings.withUnit - -```jsonnet -MetricAggregationWithSettings.Derivative.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.ExtendedStats - - -##### fn MetricAggregationWithSettings.ExtendedStats.withField - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.ExtendedStats.withHide - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.ExtendedStats.withId - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.ExtendedStats.withMeta - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withMeta(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.ExtendedStats.withMetaMixin - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.ExtendedStats.withSettings - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.ExtendedStats.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.ExtendedStats.withType - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.ExtendedStats.settings - - -###### fn MetricAggregationWithSettings.ExtendedStats.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScript - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.ExtendedStats.settings.withSigma - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### obj MetricAggregationWithSettings.ExtendedStats.settings.script - - -####### fn MetricAggregationWithSettings.ExtendedStats.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Logs - - -##### fn MetricAggregationWithSettings.Logs.withHide - -```jsonnet -MetricAggregationWithSettings.Logs.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Logs.withId - -```jsonnet -MetricAggregationWithSettings.Logs.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Logs.withSettings - -```jsonnet -MetricAggregationWithSettings.Logs.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Logs.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Logs.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Logs.withType - -```jsonnet -MetricAggregationWithSettings.Logs.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Logs.settings - - -###### fn MetricAggregationWithSettings.Logs.settings.withLimit - -```jsonnet -MetricAggregationWithSettings.Logs.settings.withLimit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Max - - -##### fn MetricAggregationWithSettings.Max.withField - -```jsonnet -MetricAggregationWithSettings.Max.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Max.withHide - -```jsonnet -MetricAggregationWithSettings.Max.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Max.withId - -```jsonnet -MetricAggregationWithSettings.Max.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Max.withSettings - -```jsonnet -MetricAggregationWithSettings.Max.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Max.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Max.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Max.withType - -```jsonnet -MetricAggregationWithSettings.Max.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Max.settings - - -###### fn MetricAggregationWithSettings.Max.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.Max.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.Max.settings.withScript - -```jsonnet -MetricAggregationWithSettings.Max.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.Max.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.Max.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj MetricAggregationWithSettings.Max.settings.script - - -####### fn MetricAggregationWithSettings.Max.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.Max.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Min - - -##### fn MetricAggregationWithSettings.Min.withField - -```jsonnet -MetricAggregationWithSettings.Min.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Min.withHide - -```jsonnet -MetricAggregationWithSettings.Min.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Min.withId - -```jsonnet -MetricAggregationWithSettings.Min.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Min.withSettings - -```jsonnet -MetricAggregationWithSettings.Min.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Min.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Min.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Min.withType - -```jsonnet -MetricAggregationWithSettings.Min.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Min.settings - - -###### fn MetricAggregationWithSettings.Min.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.Min.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.Min.settings.withScript - -```jsonnet -MetricAggregationWithSettings.Min.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.Min.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.Min.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj MetricAggregationWithSettings.Min.settings.script - - -####### fn MetricAggregationWithSettings.Min.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.Min.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.MovingAverage - - -##### fn MetricAggregationWithSettings.MovingAverage.withField - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.MovingAverage.withHide - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.MovingAverage.withId - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.MovingAverage.withPipelineAgg - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.MovingAverage.withSettings - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.MovingAverage.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.MovingAverage.withType - -```jsonnet -MetricAggregationWithSettings.MovingAverage.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.MovingFunction - - -##### fn MetricAggregationWithSettings.MovingFunction.withField - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.MovingFunction.withHide - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.MovingFunction.withId - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.MovingFunction.withPipelineAgg - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.MovingFunction.withSettings - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.MovingFunction.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.MovingFunction.withType - -```jsonnet -MetricAggregationWithSettings.MovingFunction.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.MovingFunction.settings - - -###### fn MetricAggregationWithSettings.MovingFunction.settings.withScript - -```jsonnet -MetricAggregationWithSettings.MovingFunction.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.MovingFunction.settings.withShift - -```jsonnet -MetricAggregationWithSettings.MovingFunction.settings.withShift(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.MovingFunction.settings.withWindow - -```jsonnet -MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### obj MetricAggregationWithSettings.MovingFunction.settings.script - - -####### fn MetricAggregationWithSettings.MovingFunction.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Percentiles - - -##### fn MetricAggregationWithSettings.Percentiles.withField - -```jsonnet -MetricAggregationWithSettings.Percentiles.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Percentiles.withHide - -```jsonnet -MetricAggregationWithSettings.Percentiles.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Percentiles.withId - -```jsonnet -MetricAggregationWithSettings.Percentiles.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Percentiles.withSettings - -```jsonnet -MetricAggregationWithSettings.Percentiles.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Percentiles.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Percentiles.withType - -```jsonnet -MetricAggregationWithSettings.Percentiles.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Percentiles.settings - - -###### fn MetricAggregationWithSettings.Percentiles.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.Percentiles.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.Percentiles.settings.withPercents - -```jsonnet -MetricAggregationWithSettings.Percentiles.settings.withPercents(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin - -```jsonnet -MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn MetricAggregationWithSettings.Percentiles.settings.withScript - -```jsonnet -MetricAggregationWithSettings.Percentiles.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.Percentiles.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj MetricAggregationWithSettings.Percentiles.settings.script - - -####### fn MetricAggregationWithSettings.Percentiles.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Rate - - -##### fn MetricAggregationWithSettings.Rate.withField - -```jsonnet -MetricAggregationWithSettings.Rate.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Rate.withHide - -```jsonnet -MetricAggregationWithSettings.Rate.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Rate.withId - -```jsonnet -MetricAggregationWithSettings.Rate.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Rate.withSettings - -```jsonnet -MetricAggregationWithSettings.Rate.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Rate.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Rate.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Rate.withType - -```jsonnet -MetricAggregationWithSettings.Rate.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Rate.settings - - -###### fn MetricAggregationWithSettings.Rate.settings.withMode - -```jsonnet -MetricAggregationWithSettings.Rate.settings.withMode(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.Rate.settings.withUnit - -```jsonnet -MetricAggregationWithSettings.Rate.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.RawData - - -##### fn MetricAggregationWithSettings.RawData.withHide - -```jsonnet -MetricAggregationWithSettings.RawData.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.RawData.withId - -```jsonnet -MetricAggregationWithSettings.RawData.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.RawData.withSettings - -```jsonnet -MetricAggregationWithSettings.RawData.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.RawData.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.RawData.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.RawData.withType - -```jsonnet -MetricAggregationWithSettings.RawData.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.RawData.settings - - -###### fn MetricAggregationWithSettings.RawData.settings.withSize - -```jsonnet -MetricAggregationWithSettings.RawData.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.RawDocument - - -##### fn MetricAggregationWithSettings.RawDocument.withHide - -```jsonnet -MetricAggregationWithSettings.RawDocument.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.RawDocument.withId - -```jsonnet -MetricAggregationWithSettings.RawDocument.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.RawDocument.withSettings - -```jsonnet -MetricAggregationWithSettings.RawDocument.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.RawDocument.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.RawDocument.withType - -```jsonnet -MetricAggregationWithSettings.RawDocument.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.RawDocument.settings - - -###### fn MetricAggregationWithSettings.RawDocument.settings.withSize - -```jsonnet -MetricAggregationWithSettings.RawDocument.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.SerialDiff - - -##### fn MetricAggregationWithSettings.SerialDiff.withField - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.SerialDiff.withHide - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.SerialDiff.withId - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.SerialDiff.withPipelineAgg - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.SerialDiff.withSettings - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.SerialDiff.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.SerialDiff.withType - -```jsonnet -MetricAggregationWithSettings.SerialDiff.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.SerialDiff.settings - - -###### fn MetricAggregationWithSettings.SerialDiff.settings.withLag - -```jsonnet -MetricAggregationWithSettings.SerialDiff.settings.withLag(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.Sum - - -##### fn MetricAggregationWithSettings.Sum.withField - -```jsonnet -MetricAggregationWithSettings.Sum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Sum.withHide - -```jsonnet -MetricAggregationWithSettings.Sum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.Sum.withId - -```jsonnet -MetricAggregationWithSettings.Sum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.Sum.withSettings - -```jsonnet -MetricAggregationWithSettings.Sum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Sum.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.Sum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.Sum.withType - -```jsonnet -MetricAggregationWithSettings.Sum.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.Sum.settings - - -###### fn MetricAggregationWithSettings.Sum.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.Sum.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.Sum.settings.withScript - -```jsonnet -MetricAggregationWithSettings.Sum.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn MetricAggregationWithSettings.Sum.settings.withScriptMixin - -```jsonnet -MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj MetricAggregationWithSettings.Sum.settings.script - - -####### fn MetricAggregationWithSettings.Sum.settings.script.withInline - -```jsonnet -MetricAggregationWithSettings.Sum.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.TopMetrics - - -##### fn MetricAggregationWithSettings.TopMetrics.withHide - -```jsonnet -MetricAggregationWithSettings.TopMetrics.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.TopMetrics.withId - -```jsonnet -MetricAggregationWithSettings.TopMetrics.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.TopMetrics.withSettings - -```jsonnet -MetricAggregationWithSettings.TopMetrics.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.TopMetrics.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.TopMetrics.withType - -```jsonnet -MetricAggregationWithSettings.TopMetrics.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.TopMetrics.settings - - -###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetrics - -```jsonnet -MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin - -```jsonnet -MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrder - -```jsonnet -MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrderBy - -```jsonnet -MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj MetricAggregationWithSettings.UniqueCount - - -##### fn MetricAggregationWithSettings.UniqueCount.withField - -```jsonnet -MetricAggregationWithSettings.UniqueCount.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.UniqueCount.withHide - -```jsonnet -MetricAggregationWithSettings.UniqueCount.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn MetricAggregationWithSettings.UniqueCount.withId - -```jsonnet -MetricAggregationWithSettings.UniqueCount.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn MetricAggregationWithSettings.UniqueCount.withSettings - -```jsonnet -MetricAggregationWithSettings.UniqueCount.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.UniqueCount.withSettingsMixin - -```jsonnet -MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn MetricAggregationWithSettings.UniqueCount.withType - -```jsonnet -MetricAggregationWithSettings.UniqueCount.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj MetricAggregationWithSettings.UniqueCount.settings - - -###### fn MetricAggregationWithSettings.UniqueCount.settings.withMissing - -```jsonnet -MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold - -```jsonnet -MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj PipelineMetricAggregation - - -#### obj PipelineMetricAggregation.BucketScript - - -##### fn PipelineMetricAggregation.BucketScript.withHide - -```jsonnet -PipelineMetricAggregation.BucketScript.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn PipelineMetricAggregation.BucketScript.withId - -```jsonnet -PipelineMetricAggregation.BucketScript.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.BucketScript.withPipelineVariables - -```jsonnet -PipelineMetricAggregation.BucketScript.withPipelineVariables(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin - -```jsonnet -PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -##### fn PipelineMetricAggregation.BucketScript.withSettings - -```jsonnet -PipelineMetricAggregation.BucketScript.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.BucketScript.withSettingsMixin - -```jsonnet -PipelineMetricAggregation.BucketScript.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.BucketScript.withType - -```jsonnet -PipelineMetricAggregation.BucketScript.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj PipelineMetricAggregation.BucketScript.settings - - -###### fn PipelineMetricAggregation.BucketScript.settings.withScript - -```jsonnet -PipelineMetricAggregation.BucketScript.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### fn PipelineMetricAggregation.BucketScript.settings.withScriptMixin - -```jsonnet -PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -###### obj PipelineMetricAggregation.BucketScript.settings.script - - -####### fn PipelineMetricAggregation.BucketScript.settings.script.withInline - -```jsonnet -PipelineMetricAggregation.BucketScript.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj PipelineMetricAggregation.CumulativeSum - - -##### fn PipelineMetricAggregation.CumulativeSum.withField - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.CumulativeSum.withHide - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn PipelineMetricAggregation.CumulativeSum.withId - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.CumulativeSum.withPipelineAgg - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.CumulativeSum.withSettings - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.CumulativeSum.withSettingsMixin - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.CumulativeSum.withType - -```jsonnet -PipelineMetricAggregation.CumulativeSum.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj PipelineMetricAggregation.CumulativeSum.settings - - -###### fn PipelineMetricAggregation.CumulativeSum.settings.withFormat - -```jsonnet -PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj PipelineMetricAggregation.Derivative - - -##### fn PipelineMetricAggregation.Derivative.withField - -```jsonnet -PipelineMetricAggregation.Derivative.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.Derivative.withHide - -```jsonnet -PipelineMetricAggregation.Derivative.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn PipelineMetricAggregation.Derivative.withId - -```jsonnet -PipelineMetricAggregation.Derivative.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.Derivative.withPipelineAgg - -```jsonnet -PipelineMetricAggregation.Derivative.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.Derivative.withSettings - -```jsonnet -PipelineMetricAggregation.Derivative.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.Derivative.withSettingsMixin - -```jsonnet -PipelineMetricAggregation.Derivative.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.Derivative.withType - -```jsonnet -PipelineMetricAggregation.Derivative.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj PipelineMetricAggregation.Derivative.settings - - -###### fn PipelineMetricAggregation.Derivative.settings.withUnit - -```jsonnet -PipelineMetricAggregation.Derivative.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj PipelineMetricAggregation.MovingAverage - - -##### fn PipelineMetricAggregation.MovingAverage.withField - -```jsonnet -PipelineMetricAggregation.MovingAverage.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.MovingAverage.withHide - -```jsonnet -PipelineMetricAggregation.MovingAverage.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn PipelineMetricAggregation.MovingAverage.withId - -```jsonnet -PipelineMetricAggregation.MovingAverage.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.MovingAverage.withPipelineAgg - -```jsonnet -PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn PipelineMetricAggregation.MovingAverage.withSettings - -```jsonnet -PipelineMetricAggregation.MovingAverage.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.MovingAverage.withSettingsMixin - -```jsonnet -PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn PipelineMetricAggregation.MovingAverage.withType - -```jsonnet -PipelineMetricAggregation.MovingAverage.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - diff --git a/docs/API/query/googleCloudMonitoring.md b/docs/API/query/googlecloudmonitoring.md similarity index 92% rename from docs/API/query/googleCloudMonitoring.md rename to docs/API/query/googlecloudmonitoring.md index 7b82b664..f670470e 100644 --- a/docs/API/query/googleCloudMonitoring.md +++ b/docs/API/query/googlecloudmonitoring.md @@ -1,11 +1,12 @@ -# googleCloudMonitoring +# googlecloudmonitoring -grafonnet.query.googleCloudMonitoring +grafonnet.query.googlecloudmonitoring ## Index * [`fn withAliasBy(value)`](#fn-withaliasby) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withIntervalMs(value)`](#fn-withintervalms) * [`fn withPromQLQuery(value)`](#fn-withpromqlquery) @@ -53,6 +54,7 @@ grafonnet.query.googleCloudMonitoring * [`fn withView(value)`](#fn-timeserieslistwithview) * [`obj timeSeriesQuery`](#obj-timeseriesquery) * [`fn withGraphPeriod(value)`](#fn-timeseriesquerywithgraphperiod) + * [`fn withGraphPeriodMixin(value)`](#fn-timeseriesquerywithgraphperiodmixin) * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) @@ -77,7 +79,21 @@ withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. @@ -94,9 +110,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withIntervalMs ```jsonnet @@ -574,6 +588,17 @@ PARAMETERS: * **value** (`string`) +To disable the graphPeriod, it should explictly be set to 'disabled'. +#### fn timeSeriesQuery.withGraphPeriodMixin + +```jsonnet +timeSeriesQuery.withGraphPeriodMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + To disable the graphPeriod, it should explictly be set to 'disabled'. #### fn timeSeriesQuery.withProjectName diff --git a/docs/API/query/grafanaPyroscope.md b/docs/API/query/grafanapyroscope.md similarity index 60% rename from docs/API/query/grafanaPyroscope.md rename to docs/API/query/grafanapyroscope.md index 265f6c7a..63a8f7a0 100644 --- a/docs/API/query/grafanaPyroscope.md +++ b/docs/API/query/grafanapyroscope.md @@ -1,10 +1,11 @@ -# grafanaPyroscope +# grafanapyroscope -grafonnet.query.grafanaPyroscope +grafonnet.query.grafanapyroscope ## Index * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withGroupBy(value)`](#fn-withgroupby) * [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) * [`fn withHide(value=true)`](#fn-withhide) @@ -26,12 +27,20 @@ withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null ### fn withGroupBy ```jsonnet @@ -42,7 +51,7 @@ PARAMETERS: * **value** (`array`) -Allows to group the results. + ### fn withGroupByMixin ```jsonnet @@ -53,7 +62,7 @@ PARAMETERS: * **value** (`array`) -Allows to group the results. + ### fn withHide ```jsonnet @@ -65,9 +74,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) + ### fn withLabelSelector ```jsonnet @@ -79,7 +86,7 @@ PARAMETERS: * **value** (`string`) - default value: `"{}"` -Specifies the query label selectors. + ### fn withMaxNodes ```jsonnet @@ -90,7 +97,7 @@ PARAMETERS: * **value** (`integer`) -Sets the maximum number of nodes in the flamegraph. + ### fn withProfileTypeId ```jsonnet @@ -101,7 +108,7 @@ PARAMETERS: * **value** (`string`) -Specifies the type of profile to query. + ### fn withQueryType ```jsonnet @@ -112,8 +119,7 @@ PARAMETERS: * **value** (`string`) -Specify the query flavor -TODO make this required and give it a default + ### fn withRefId ```jsonnet @@ -124,9 +130,7 @@ PARAMETERS: * **value** (`string`) -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. + ### fn withSpanSelector ```jsonnet @@ -137,7 +141,7 @@ PARAMETERS: * **value** (`array`) -Specifies the query span selectors. + ### fn withSpanSelectorMixin ```jsonnet @@ -148,4 +152,3 @@ PARAMETERS: * **value** (`array`) -Specifies the query span selectors. \ No newline at end of file diff --git a/docs/API/query/index.md b/docs/API/query/index.md index c36150f0..270e0a83 100644 --- a/docs/API/query/index.md +++ b/docs/API/query/index.md @@ -4,13 +4,12 @@ grafonnet.query ## Subpackages -* [azureMonitor](azureMonitor/index.md) -* [cloudWatch](cloudWatch/index.md) +* [azuremonitor](azuremonitor/index.md) +* [cloudwatch](cloudwatch/index.md) * [elasticsearch](elasticsearch/index.md) -* [googleCloudMonitoring](googleCloudMonitoring.md) -* [grafanaPyroscope](grafanaPyroscope.md) +* [googlecloudmonitoring](googlecloudmonitoring.md) +* [grafanapyroscope](grafanapyroscope.md) * [loki](loki.md) * [parca](parca.md) * [prometheus](prometheus.md) * [tempo](tempo/index.md) -* [testData](testData/index.md) diff --git a/docs/API/query/loki.md b/docs/API/query/loki.md index 273d5f6f..f0246b80 100644 --- a/docs/API/query/loki.md +++ b/docs/API/query/loki.md @@ -6,6 +6,7 @@ grafonnet.query.loki * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExpr(value)`](#fn-withexpr) * [`fn withHide(value=true)`](#fn-withhide) @@ -43,6 +44,17 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + ### fn withEditorMode ```jsonnet @@ -65,7 +77,7 @@ PARAMETERS: * **value** (`string`) -The LogQL query. + ### fn withHide ```jsonnet @@ -77,9 +89,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) + ### fn withInstant ```jsonnet @@ -91,7 +101,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -@deprecated, now use queryType. + ### fn withLegendFormat ```jsonnet @@ -102,7 +112,7 @@ PARAMETERS: * **value** (`string`) -Used to override the name of the series. + ### fn withMaxLines ```jsonnet @@ -113,7 +123,7 @@ PARAMETERS: * **value** (`integer`) -Used to limit the number of log rows returned. + ### fn withQueryType ```jsonnet @@ -124,8 +134,7 @@ PARAMETERS: * **value** (`string`) -Specify the query flavor -TODO make this required and give it a default + ### fn withRange ```jsonnet @@ -137,7 +146,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -@deprecated, now use queryType. + ### fn withRefId ```jsonnet @@ -148,9 +157,7 @@ PARAMETERS: * **value** (`string`) -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. + ### fn withResolution ```jsonnet @@ -161,7 +168,7 @@ PARAMETERS: * **value** (`integer`) -@deprecated, now use step. + ### fn withStep ```jsonnet @@ -172,4 +179,3 @@ PARAMETERS: * **value** (`string`) -Used to set step value for range queries. \ No newline at end of file diff --git a/docs/API/query/parca.md b/docs/API/query/parca.md index 6edbee5f..562caa77 100644 --- a/docs/API/query/parca.md +++ b/docs/API/query/parca.md @@ -5,6 +5,7 @@ grafonnet.query.parca ## Index * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) @@ -21,12 +22,20 @@ withDatasource(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null ### fn withHide ```jsonnet @@ -38,9 +47,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) + ### fn withLabelSelector ```jsonnet @@ -52,7 +59,7 @@ PARAMETERS: * **value** (`string`) - default value: `"{}"` -Specifies the query label selectors. + ### fn withProfileTypeId ```jsonnet @@ -63,7 +70,7 @@ PARAMETERS: * **value** (`string`) -Specifies the type of profile to query. + ### fn withQueryType ```jsonnet @@ -74,8 +81,7 @@ PARAMETERS: * **value** (`string`) -Specify the query flavor -TODO make this required and give it a default + ### fn withRefId ```jsonnet @@ -86,6 +92,3 @@ PARAMETERS: * **value** (`string`) -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/docs/API/query/prometheus.md b/docs/API/query/prometheus.md index 027be68e..054c00ae 100644 --- a/docs/API/query/prometheus.md +++ b/docs/API/query/prometheus.md @@ -6,21 +6,19 @@ grafonnet.query.prometheus * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExemplar(value=true)`](#fn-withexemplar) * [`fn withExpr(value)`](#fn-withexpr) * [`fn withFormat(value)`](#fn-withformat) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withInterval(value)`](#fn-withinterval) * [`fn withIntervalFactor(value)`](#fn-withintervalfactor) * [`fn withLegendFormat(value)`](#fn-withlegendformat) * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRange(value=true)`](#fn-withrange) * [`fn withRefId(value)`](#fn-withrefid) -* [`fn withScope(value)`](#fn-withscope) -* [`fn withScopeMixin(value)`](#fn-withscopemixin) -* [`obj scope`](#obj-scope) - * [`fn withMatchers(value)`](#fn-scopewithmatchers) ## Fields @@ -47,6 +45,17 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + ### fn withEditorMode ```jsonnet @@ -70,7 +79,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -Execute an additional query to identify interesting raw samples relevant for the given expr + ### fn withExpr ```jsonnet @@ -81,7 +90,7 @@ PARAMETERS: * **value** (`string`) -The actual expression/query that will be evaluated by Prometheus + ### fn withFormat ```jsonnet @@ -105,9 +114,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) + ### fn withInstant ```jsonnet @@ -119,7 +126,19 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -Returns only the latest value that Prometheus has scraped for the requested time series + +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An additional lower limit for the step parameter of the Prometheus query and for the +`$__interval` and `$__rate_interval` variables. ### fn withIntervalFactor ```jsonnet @@ -152,8 +171,7 @@ PARAMETERS: * **value** (`string`) -Specify the query flavor -TODO make this required and give it a default + ### fn withRange ```jsonnet @@ -165,7 +183,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series + ### fn withRefId ```jsonnet @@ -176,41 +194,3 @@ PARAMETERS: * **value** (`string`) -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. -### fn withScope - -```jsonnet -withScope(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withScopeMixin - -```jsonnet -withScopeMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### obj scope - - -#### fn scope.withMatchers - -```jsonnet -scope.withMatchers(value) -``` - -PARAMETERS: - -* **value** (`string`) - diff --git a/docs/API/query/tempo/index.md b/docs/API/query/tempo/index.md index acb5c74d..934fb7b3 100644 --- a/docs/API/query/tempo/index.md +++ b/docs/API/query/tempo/index.md @@ -11,6 +11,7 @@ grafonnet.query.tempo * [`fn new(datasource, query, filters)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withFilters(value)`](#fn-withfilters) * [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) * [`fn withGroupBy(value)`](#fn-withgroupby) @@ -57,6 +58,20 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withFilters ```jsonnet @@ -112,9 +127,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withLimit ```jsonnet @@ -271,6 +284,6 @@ withTableType(value) PARAMETERS: * **value** (`string`) - - valid values: `"traces"`, `"spans"` + - valid values: `"traces"`, `"spans"`, `"raw"` The type of the table that is used to display the search results \ No newline at end of file diff --git a/docs/API/query/testData/csvWave.md b/docs/API/query/testData/csvWave.md deleted file mode 100644 index 8927e1cc..00000000 --- a/docs/API/query/testData/csvWave.md +++ /dev/null @@ -1,56 +0,0 @@ -# csvWave - - - -## Index - -* [`fn withLabels(value)`](#fn-withlabels) -* [`fn withName(value)`](#fn-withname) -* [`fn withTimeStep(value)`](#fn-withtimestep) -* [`fn withValuesCSV(value)`](#fn-withvaluescsv) - -## Fields - -### fn withLabels - -```jsonnet -withLabels(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withName - -```jsonnet -withName(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withTimeStep - -```jsonnet -withTimeStep(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -### fn withValuesCSV - -```jsonnet -withValuesCSV(value) -``` - -PARAMETERS: - -* **value** (`string`) - diff --git a/docs/API/query/testData/index.md b/docs/API/query/testData/index.md deleted file mode 100644 index e1def173..00000000 --- a/docs/API/query/testData/index.md +++ /dev/null @@ -1,797 +0,0 @@ -# testData - -grafonnet.query.testData - -## Subpackages - -* [csvWave](csvWave.md) - -## Index - -* [`fn withAlias(value)`](#fn-withalias) -* [`fn withChannel(value)`](#fn-withchannel) -* [`fn withCsvContent(value)`](#fn-withcsvcontent) -* [`fn withCsvFileName(value)`](#fn-withcsvfilename) -* [`fn withCsvWave(value)`](#fn-withcsvwave) -* [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDropPercent(value)`](#fn-withdroppercent) -* [`fn withErrorType(value)`](#fn-witherrortype) -* [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) -* [`fn withHide(value=true)`](#fn-withhide) -* [`fn withLabels(value)`](#fn-withlabels) -* [`fn withLevelColumn(value=true)`](#fn-withlevelcolumn) -* [`fn withLines(value)`](#fn-withlines) -* [`fn withNodes(value)`](#fn-withnodes) -* [`fn withNodesMixin(value)`](#fn-withnodesmixin) -* [`fn withPoints(value)`](#fn-withpoints) -* [`fn withPointsMixin(value)`](#fn-withpointsmixin) -* [`fn withPulseWave(value)`](#fn-withpulsewave) -* [`fn withPulseWaveMixin(value)`](#fn-withpulsewavemixin) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRawFrameContent(value)`](#fn-withrawframecontent) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withScenarioId(value)`](#fn-withscenarioid) -* [`fn withSeriesCount(value)`](#fn-withseriescount) -* [`fn withSim(value)`](#fn-withsim) -* [`fn withSimMixin(value)`](#fn-withsimmixin) -* [`fn withSpanCount(value)`](#fn-withspancount) -* [`fn withStream(value)`](#fn-withstream) -* [`fn withStreamMixin(value)`](#fn-withstreammixin) -* [`fn withStringInput(value)`](#fn-withstringinput) -* [`fn withUsa(value)`](#fn-withusa) -* [`fn withUsaMixin(value)`](#fn-withusamixin) -* [`obj nodes`](#obj-nodes) - * [`fn withCount(value)`](#fn-nodeswithcount) - * [`fn withSeed(value)`](#fn-nodeswithseed) - * [`fn withType(value)`](#fn-nodeswithtype) -* [`obj pulseWave`](#obj-pulsewave) - * [`fn withOffCount(value)`](#fn-pulsewavewithoffcount) - * [`fn withOffValue(value)`](#fn-pulsewavewithoffvalue) - * [`fn withOnCount(value)`](#fn-pulsewavewithoncount) - * [`fn withOnValue(value)`](#fn-pulsewavewithonvalue) - * [`fn withTimeStep(value)`](#fn-pulsewavewithtimestep) -* [`obj sim`](#obj-sim) - * [`fn withConfig(value)`](#fn-simwithconfig) - * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) - * [`fn withKey(value)`](#fn-simwithkey) - * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) - * [`fn withLast(value=true)`](#fn-simwithlast) - * [`fn withStream(value=true)`](#fn-simwithstream) - * [`obj key`](#obj-simkey) - * [`fn withTick(value)`](#fn-simkeywithtick) - * [`fn withType(value)`](#fn-simkeywithtype) - * [`fn withUid(value)`](#fn-simkeywithuid) -* [`obj stream`](#obj-stream) - * [`fn withBands(value)`](#fn-streamwithbands) - * [`fn withNoise(value)`](#fn-streamwithnoise) - * [`fn withSpeed(value)`](#fn-streamwithspeed) - * [`fn withSpread(value)`](#fn-streamwithspread) - * [`fn withType(value)`](#fn-streamwithtype) - * [`fn withUrl(value)`](#fn-streamwithurl) -* [`obj usa`](#obj-usa) - * [`fn withFields(value)`](#fn-usawithfields) - * [`fn withFieldsMixin(value)`](#fn-usawithfieldsmixin) - * [`fn withMode(value)`](#fn-usawithmode) - * [`fn withPeriod(value)`](#fn-usawithperiod) - * [`fn withStates(value)`](#fn-usawithstates) - * [`fn withStatesMixin(value)`](#fn-usawithstatesmixin) - -## Fields - -### fn withAlias - -```jsonnet -withAlias(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withChannel - -```jsonnet -withChannel(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withCsvContent - -```jsonnet -withCsvContent(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withCsvFileName - -```jsonnet -withCsvFileName(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withCsvWave - -```jsonnet -withCsvWave(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withCsvWaveMixin - -```jsonnet -withCsvWaveMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withDatasource - -```jsonnet -withDatasource(value) -``` - -PARAMETERS: - -* **value** (`string`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDropPercent - -```jsonnet -withDropPercent(value) -``` - -PARAMETERS: - -* **value** (`number`) - -Drop percentage (the chance we will lose a point 0-100) -### fn withErrorType - -```jsonnet -withErrorType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"server_panic"`, `"frontend_exception"`, `"frontend_observable"` - - -### fn withFlamegraphDiff - -```jsonnet -withFlamegraphDiff(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -### fn withHide - -```jsonnet -withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) -### fn withLabels - -```jsonnet -withLabels(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withLevelColumn - -```jsonnet -withLevelColumn(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -### fn withLines - -```jsonnet -withLines(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -### fn withNodes - -```jsonnet -withNodes(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withNodesMixin - -```jsonnet -withNodesMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withPoints - -```jsonnet -withPoints(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withPointsMixin - -```jsonnet -withPointsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -### fn withPulseWave - -```jsonnet -withPulseWave(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withPulseWaveMixin - -```jsonnet -withPulseWaveMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withQueryType - -```jsonnet -withQueryType(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Specify the query flavor -TODO make this required and give it a default -### fn withRawFrameContent - -```jsonnet -withRawFrameContent(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withRefId - -```jsonnet -withRefId(value) -``` - -PARAMETERS: - -* **value** (`string`) - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. -### fn withScenarioId - -```jsonnet -withScenarioId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"random_walk"`, `"slow_query"`, `"random_walk_with_error"`, `"random_walk_table"`, `"exponential_heatmap_bucket_data"`, `"linear_heatmap_bucket_data"`, `"no_data_points"`, `"datapoints_outside_range"`, `"csv_metric_values"`, `"predictable_pulse"`, `"predictable_csv_wave"`, `"streaming_client"`, `"simulation"`, `"usa"`, `"live"`, `"grafana_api"`, `"arrow"`, `"annotations"`, `"table_static"`, `"server_error_500"`, `"logs"`, `"node_graph"`, `"flame_graph"`, `"raw_frame"`, `"csv_file"`, `"csv_content"`, `"trace"`, `"manual_entry"`, `"variables-query"` - - -### fn withSeriesCount - -```jsonnet -withSeriesCount(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -### fn withSim - -```jsonnet -withSim(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withSimMixin - -```jsonnet -withSimMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withSpanCount - -```jsonnet -withSpanCount(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -### fn withStream - -```jsonnet -withStream(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withStreamMixin - -```jsonnet -withStreamMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withStringInput - -```jsonnet -withStringInput(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withUsa - -```jsonnet -withUsa(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withUsaMixin - -```jsonnet -withUsaMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### obj nodes - - -#### fn nodes.withCount - -```jsonnet -nodes.withCount(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn nodes.withSeed - -```jsonnet -nodes.withSeed(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn nodes.withType - -```jsonnet -nodes.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"random"`, `"response_small"`, `"response_medium"`, `"random edges"` - - -### obj pulseWave - - -#### fn pulseWave.withOffCount - -```jsonnet -pulseWave.withOffCount(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn pulseWave.withOffValue - -```jsonnet -pulseWave.withOffValue(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -#### fn pulseWave.withOnCount - -```jsonnet -pulseWave.withOnCount(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn pulseWave.withOnValue - -```jsonnet -pulseWave.withOnValue(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -#### fn pulseWave.withTimeStep - -```jsonnet -pulseWave.withTimeStep(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -### obj sim - - -#### fn sim.withConfig - -```jsonnet -sim.withConfig(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn sim.withConfigMixin - -```jsonnet -sim.withConfigMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn sim.withKey - -```jsonnet -sim.withKey(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn sim.withKeyMixin - -```jsonnet -sim.withKeyMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -#### fn sim.withLast - -```jsonnet -sim.withLast(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -#### fn sim.withStream - -```jsonnet -sim.withStream(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -#### obj sim.key - - -##### fn sim.key.withTick - -```jsonnet -sim.key.withTick(value) -``` - -PARAMETERS: - -* **value** (`number`) - - -##### fn sim.key.withType - -```jsonnet -sim.key.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn sim.key.withUid - -```jsonnet -sim.key.withUid(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj stream - - -#### fn stream.withBands - -```jsonnet -stream.withBands(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn stream.withNoise - -```jsonnet -stream.withNoise(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn stream.withSpeed - -```jsonnet -stream.withSpeed(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn stream.withSpread - -```jsonnet -stream.withSpread(value) -``` - -PARAMETERS: - -* **value** (`integer`) - - -#### fn stream.withType - -```jsonnet -stream.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"signal"`, `"logs"`, `"fetch"`, `"traces"` - - -#### fn stream.withUrl - -```jsonnet -stream.withUrl(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj usa - - -#### fn usa.withFields - -```jsonnet -usa.withFields(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -#### fn usa.withFieldsMixin - -```jsonnet -usa.withFieldsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -#### fn usa.withMode - -```jsonnet -usa.withMode(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn usa.withPeriod - -```jsonnet -usa.withPeriod(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### fn usa.withStates - -```jsonnet -usa.withStates(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -#### fn usa.withStatesMixin - -```jsonnet -usa.withStatesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - diff --git a/docs/API/role.md b/docs/API/role.md index b5b551cc..bb77d199 100644 --- a/docs/API/role.md +++ b/docs/API/role.md @@ -7,7 +7,8 @@ grafonnet.role * [`fn withDescription(value)`](#fn-withdescription) * [`fn withDisplayName(value)`](#fn-withdisplayname) * [`fn withGroupName(value)`](#fn-withgroupname) -* [`fn withHidden(value=true)`](#fn-withhidden) +* [`fn withHidden(value)`](#fn-withhidden) +* [`fn withHiddenMixin(value)`](#fn-withhiddenmixin) * [`fn withName(value)`](#fn-withname) ## Fields @@ -48,13 +49,23 @@ Name of the team. ### fn withHidden ```jsonnet -withHidden(value=true) +withHidden(value) +``` + +PARAMETERS: + +* **value** (`boolean`) + +Do not show this role +### fn withHiddenMixin + +```jsonnet +withHiddenMixin(value) ``` PARAMETERS: * **value** (`boolean`) - - default value: `true` Do not show this role ### fn withName diff --git a/docs/API/rolebinding.md b/docs/API/rolebinding.md index 62357f58..9a1e904b 100644 --- a/docs/API/rolebinding.md +++ b/docs/API/rolebinding.md @@ -14,10 +14,10 @@ grafonnet.rolebinding * [`fn withCustomRoleRef(value)`](#fn-rolewithcustomroleref) * [`fn withCustomRoleRefMixin(value)`](#fn-rolewithcustomrolerefmixin) * [`obj BuiltinRoleRef`](#obj-rolebuiltinroleref) - * [`fn withKind(value)`](#fn-rolebuiltinrolerefwithkind) + * [`fn withKind()`](#fn-rolebuiltinrolerefwithkind) * [`fn withName(value)`](#fn-rolebuiltinrolerefwithname) * [`obj CustomRoleRef`](#obj-rolecustomroleref) - * [`fn withKind(value)`](#fn-rolecustomrolerefwithkind) + * [`fn withKind()`](#fn-rolecustomrolerefwithkind) * [`fn withName(value)`](#fn-rolecustomrolerefwithname) * [`obj subject`](#obj-subject) * [`fn withKind(value)`](#fn-subjectwithkind) @@ -122,13 +122,9 @@ PARAMETERS: ##### fn role.BuiltinRoleRef.withKind ```jsonnet -role.BuiltinRoleRef.withKind(value) +role.BuiltinRoleRef.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"BuiltinRole"` ##### fn role.BuiltinRoleRef.withName @@ -149,13 +145,9 @@ PARAMETERS: ##### fn role.CustomRoleRef.withKind ```jsonnet -role.CustomRoleRef.withKind(value) +role.CustomRoleRef.withKind() ``` -PARAMETERS: - -* **value** (`string`) - - valid values: `"Role"` ##### fn role.CustomRoleRef.withName diff --git a/gen/grafonnet-latest/jsonnetfile.json b/gen/grafonnet-latest/jsonnetfile.json index 525bee59..ea82bcab 100644 --- a/gen/grafonnet-latest/jsonnetfile.json +++ b/gen/grafonnet-latest/jsonnetfile.json @@ -4,7 +4,7 @@ "source": { "git": { "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "gen/grafonnet-v10.4.0" + "subdir": "gen/grafonnet-v11.0.0" } }, "version": "main" diff --git a/gen/grafonnet-latest/main.libsonnet b/gen/grafonnet-latest/main.libsonnet index 33c8df77..f89dcc06 100644 --- a/gen/grafonnet-latest/main.libsonnet +++ b/gen/grafonnet-latest/main.libsonnet @@ -1 +1 @@ -import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet' +import 'github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet' diff --git a/gen/grafonnet-v11.0.0/accesspolicy.libsonnet b/gen/grafonnet-v11.0.0/accesspolicy.libsonnet new file mode 100644 index 00000000..fa095db1 --- /dev/null +++ b/gen/grafonnet-v11.0.0/accesspolicy.libsonnet @@ -0,0 +1,94 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.accesspolicy', name: 'accesspolicy' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRole(value): { + role: value, + }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRoleMixin(value): { + role+: value, + }, + role+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Role', 'BuiltinRole', 'Team', 'User'], name: 'value', type: ['string'] }], help: 'Policies can apply to roles, teams, or users\nApplying policies to individual users is supported, but discouraged' } }, + withKind(value): { + role+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + '#withXname': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withXname(value): { + role+: { + xname: value, + }, + }, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + rules+: + { + '#': { help: '', name: 'rules' }, + '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, + withKind(value): { + kind: value, + }, + '#withKindMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, + withKindMixin(value): { + kind+: value, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific sub-elements like "alert.rules" or "dashboard.permissions"????' } }, + withTarget(value): { + target: value, + }, + '#withVerb': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string', 'string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerb(value): { + verb: value, + }, + '#withVerbMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string', 'string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerbMixin(value): { + verb+: value, + }, + }, + '#withScope': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScope(value): { + scope: value, + }, + '#withScopeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScopeMixin(value): { + scope+: value, + }, + scope+: + { + '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { + scope+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + scope+: { + name: value, + }, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/alerting.libsonnet b/gen/grafonnet-v11.0.0/alerting.libsonnet new file mode 100644 index 00000000..621020b7 --- /dev/null +++ b/gen/grafonnet-v11.0.0/alerting.libsonnet @@ -0,0 +1,9 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting', name: 'alerting' }, + contactPoint: import 'clean/alerting/contactPoint.libsonnet', + notificationPolicy: import 'clean/alerting/notificationPolicy.libsonnet', + muteTiming: import 'clean/alerting/muteTiming.libsonnet', + ruleGroup: import 'clean/alerting/ruleGroup.libsonnet', + messageTemplate: import 'clean/alerting/messageTemplate.libsonnet', +} diff --git a/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet new file mode 100644 index 00000000..13c81df1 --- /dev/null +++ b/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet @@ -0,0 +1,33 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, + '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDisableResolveMessage(value=true): { + disableResolveMessage: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name is used as grouping key in the UI. Contact points with the\nsame name will be grouped in the UI.' } }, + withName(value): { + name: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID is the unique identifier of the contact point. The UID can be\nset by the user.' } }, + withUid(value): { + uid: value, + }, +} ++ (import '../../custom/alerting/contactPoint.libsonnet') diff --git a/gen/grafonnet-v11.0.0/clean/alerting/messageTemplate.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/messageTemplate.libsonnet new file mode 100644 index 00000000..7e9bc9e2 --- /dev/null +++ b/gen/grafonnet-v11.0.0/clean/alerting/messageTemplate.libsonnet @@ -0,0 +1,12 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.messageTemplate', name: 'messageTemplate' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTemplate(value): { + template: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet new file mode 100644 index 00000000..a36d3396 --- /dev/null +++ b/gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet @@ -0,0 +1,135 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.muteTiming', name: 'muteTiming' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + interval+: + { + '#': { help: '', name: 'interval' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + time_intervals+: + { + '#': { help: '', name: 'time_intervals' }, + '#withDaysOfMonth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonth(value): { + days_of_month: + (if std.isArray(value) + then value + else [value]), + }, + '#withDaysOfMonthMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonthMixin(value): { + days_of_month+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withMonths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonths(value): { + months: + (if std.isArray(value) + then value + else [value]), + }, + '#withMonthsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonthsMixin(value): { + months+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimes(value): { + times: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimesMixin(value): { + times+: + (if std.isArray(value) + then value + else [value]), + }, + times+: + { + '#': { help: '', name: 'times' }, + '#withEndTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withEndTime(value): { + end_time: value, + }, + '#withStartTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStartTime(value): { + start_time: value, + }, + }, + '#withWeekdays': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdays(value): { + weekdays: + (if std.isArray(value) + then value + else [value]), + }, + '#withWeekdaysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdaysMixin(value): { + weekdays+: + (if std.isArray(value) + then value + else [value]), + }, + '#withYears': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYears(value): { + years: + (if std.isArray(value) + then value + else [value]), + }, + '#withYearsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYearsMixin(value): { + years+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ (import '../../custom/alerting/muteTiming.libsonnet') diff --git a/gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet new file mode 100644 index 00000000..684b33b2 --- /dev/null +++ b/gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet @@ -0,0 +1,97 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withContinue(value=true): { + continue: value, + }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupInterval(value): { + group_interval: value, + }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupWait(value): { + group_wait: value, + }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRepeatInterval(value): { + repeat_interval: value, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + group_by: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + group_by+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchers(value): { + matchers: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchersMixin(value): { + matchers+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervals(value): { + mute_time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervalsMixin(value): { + mute_time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withReceiver(value): { + receiver: value, + }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutes(value): { + routes: + (if std.isArray(value) + then value + else [value]), + }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutesMixin(value): { + routes+: + (if std.isArray(value) + then value + else [value]), + }, + matcher+: + { + '#': { help: '', name: 'matcher' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + Name: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: 'MatchType is an enum for label matching types.' } }, + withType(value): { + Type: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { + Value: value, + }, + }, +} ++ (import '../../custom/alerting/notificationPolicy.libsonnet') diff --git a/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet new file mode 100644 index 00000000..a7550dae --- /dev/null +++ b/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet @@ -0,0 +1,135 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.ruleGroup', name: 'ruleGroup' }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withInterval(value): { + interval: value, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + rule+: + { + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotations(value): { + annotations: value, + }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotationsMixin(value): { + annotations+: value, + }, + '#withCondition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCondition(value): { + condition: value, + }, + '#withData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withData(value): { + data: + (if std.isArray(value) + then value + else [value]), + }, + '#withDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDataMixin(value): { + data+: + (if std.isArray(value) + then value + else [value]), + }, + '#withExecErrState': { 'function': { args: [{ default: null, enums: ['OK', 'Alerting', 'Error'], name: 'value', type: ['string'] }], help: '' } }, + withExecErrState(value): { + execErrState: value, + }, + '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFor(value): { + 'for': value, + }, + '#withIsPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsPaused(value=true): { + isPaused: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelsMixin(value): { + labels+: value, + }, + '#withNoDataState': { 'function': { args: [{ default: null, enums: ['Alerting', 'NoData', 'OK'], name: 'value', type: ['string'] }], help: '' } }, + withNoDataState(value): { + noDataState: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + data+: + { + '#': { help: '', name: 'data' }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation." } }, + withDatasourceUid(value): { + datasourceUid: value, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModelMixin(value): { + model+: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withRelativeTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRange(value): { + relativeTimeRange: value, + }, + '#withRelativeTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRangeMixin(value): { + relativeTimeRange+: value, + }, + relativeTimeRange+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFrom(value): { + relativeTimeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withTo(value): { + relativeTimeRange+: { + to: value, + }, + }, + }, + }, + }, +} ++ (import '../../custom/alerting/ruleGroup.libsonnet') diff --git a/gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet b/gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet new file mode 100644 index 00000000..4b8bbf0b --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet @@ -0,0 +1,12 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#'+:: { + help+: + ||| + + + **NOTE**: The schemas for all different contact points is under development, this means we can't properly express them in Grafonnet yet. The way this works now may change heavily. + |||, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet b/gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet new file mode 100644 index 00000000..4a2efb36 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet @@ -0,0 +1,8 @@ +{ + '#withTimeIntervals': { ignore: true }, + '#withIntervals': super['#withTimeIntervals'], + withIntervals: super.withTimeIntervals, + '#withTimeIntervalsMixin': { ignore: true }, + '#withIntervalsMixin': super['#withTimeIntervalsMixin'], + withIntervalsMixin: super.withTimeIntervalsMixin, +} diff --git a/gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet b/gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet new file mode 100644 index 00000000..cf9a2b7d --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet @@ -0,0 +1,12 @@ +{ + '#withReceiver': { ignore: true }, + '#withContactPoint': super['#withReceiver'], + withContactPoint: super.withReceiver, + + '#withRoutes': { ignore: true }, + '#withPolicy': super['#withRoutes'], + withPolicy: super.withRoutes, + '#withRoutesMixin': { ignore: true }, + '#withPolicyMixin': super['#withRoutesMixin'], + withPolicyMixin: super.withRoutesMixin, +} diff --git a/gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet b/gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet new file mode 100644 index 00000000..4ed32afb --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet @@ -0,0 +1,13 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + rule+: { + '#':: d.package.newSub('rule', ''), + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet b/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet new file mode 100644 index 00000000..1478f3d3 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet @@ -0,0 +1,64 @@ +local util = import './util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new dashboard with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withSchemaVersion() + + self.withTimezone('utc') + + self.time.withFrom('now-6h') + + self.time.withTo('now'), + + '#withPanels':: d.func.new( + '`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`.', + args=[ + d.arg('panels', d.T.array), + d.arg('setPanelIDs', d.T.bool, default=true), + ] + ), + withPanels(panels, setPanelIDs=true): { + _panels:: if std.isArray(panels) then panels else [panels], + panels: + if setPanelIDs + then util.panel.setPanelIDs(self._panels) + else self._panels, + }, + '#withPanelsMixin':: d.func.new( + '`withPanelsMixin` adds more panels to a dashboard.', + args=[ + d.arg('panels', d.T.array), + d.arg('setPanelIDs', d.T.bool, default=true), + ] + ), + withPanelsMixin(panels, setPanelIDs=true): { + _panels+:: if std.isArray(panels) then panels else [panels], + panels: + if setPanelIDs + then util.panel.setPanelIDs(self._panels) + else self._panels, + }, + + graphTooltip+: { + // 0 - Default + // 1 - Shared crosshair + // 2 - Shared tooltip + '#withSharedCrosshair':: d.func.new( + 'Share crosshair on all panels.', + ), + withSharedCrosshair(): + { graphTooltip: 1 }, + + '#withSharedTooltip':: d.func.new( + 'Share crosshair and tooltip on all panels.', + ), + withSharedTooltip(): + { graphTooltip: 2 }, + }, +} ++ (import './dashboard/annotation.libsonnet') ++ (import './dashboard/link.libsonnet') ++ (import './dashboard/variable.libsonnet') diff --git a/gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet b/gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet new file mode 100644 index 00000000..02892ab3 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet @@ -0,0 +1,36 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#annotation':: {}, + + '#withAnnotations': + d.func.new( + ||| + `withAnnotations` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotations(value): super.annotation.withList(value), + + '#withAnnotationsMixin': + d.func.new( + ||| + `withAnnotationsMixin` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotationsMixin(value): super.annotation.withListMixin(value), + + annotation: + super.annotation.list + + { + '#':: d.package.newSub( + 'annotation', + '', + ), + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet b/gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet new file mode 100644 index 00000000..eb9b2fe9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet @@ -0,0 +1,90 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withLinks':: d.func.new( + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + `withLinks` takes an array of [link objects](./link.md). + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + [d.arg('value', d.T.array)], + ), + '#withLinksMixin':: self['#withLinks'], + + link+: { + '#':: d.package.newSub( + 'link', + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + ), + + dashboards+: { + '#new':: d.func.new( + ||| + Create links to dashboards based on `tags`. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('tags', d.T.array), + ] + ), + new(title, tags): + self.withTitle(title) + + self.withType('dashboards') + + self.withTags(tags), + + '#withTitle':: {}, + '#withType':: {}, + '#withTags':: {}, + }, + + link+: { + '#new':: d.func.new( + ||| + Create link to an arbitrary URL. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('url', d.T.string), + ] + ), + new(title, url): + self.withTitle(title) + + self.withType('link') + + self.withUrl(url), + + '#withTitle':: {}, + '#withType':: {}, + '#withUrl':: {}, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet b/gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet new file mode 100644 index 00000000..91ca33f3 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet @@ -0,0 +1,516 @@ +local util = import '../util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local var = super.variable.list, + + '#withVariables': + d.func.new( + ||| + `withVariables` adds an array of variables to a dashboard + |||, + args=[d.arg('value', d.T.array)] + ), + withVariables(value): super.variable.withList(value), + + '#withVariablesMixin': + d.func.new( + ||| + `withVariablesMixin` adds an array of variables to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withVariablesMixin(value): super.variable.withListMixin(value), + + variable: { + '#':: d.package.newSub( + 'variable', + ||| + Example usage: + + ```jsonnet + local g = import 'g.libsonnet'; + local var = g.dashboard.variable; + + local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + + local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + + g.dashboard.new('my dashboard') + + g.dashboard.withVariables([ + customVar, + queryVar, + ]) + ``` + |||, + ), + + local generalOptions = { + generalOptions+: + { + + '#withName': var['#withName'], + withName: var.withName, + '#withLabel': var['#withLabel'], + withLabel: var.withLabel, + '#withDescription': var['#withDescription'], + withDescription: var.withDescription, + + showOnDashboard: { + '#withLabelAndValue':: d.func.new(''), + withLabelAndValue(): var.withHide(0), + '#withValueOnly':: d.func.new(''), + withValueOnly(): var.withHide(1), + '#withNothing':: d.func.new(''), + withNothing(): var.withHide(2), + }, + + '#withCurrent':: d.func.new( + ||| + `withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + |||, + args=[ + d.arg('key', d.T.any), + d.arg('value', d.T.any, default=''), + ] + ), + withCurrent(key, value=key): { + local multi(v) = + if std.get(self, 'multi', false) + && !std.isArray(v) + then [v] + else v, + current: { + selected: false, + text: multi(key), + value: multi(value), + }, + }, + }, + }, + + local selectionOptions = + { + selectionOptions: + { + '#withMulti':: d.func.new( + 'Enable selecting multiple values.', + args=[ + d.arg('value', d.T.boolean, default=true), + ] + ), + withMulti(value=true): { + multi: value, + }, + + '#withIncludeAll':: d.func.new( + ||| + `withIncludeAll` enables an option to include all variables. + + Optionally you can set a `customAllValue`. + |||, + args=[ + d.arg('value', d.T.boolean, default=true), + d.arg('customAllValue', d.T.string, default=null), + ] + ), + withIncludeAll(value=true, customAllValue=null): { + includeAll: value, + [if customAllValue != null then 'allValue']: customAllValue, + }, + }, + }, + + query: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + Create a query template variable. + + `query` argument is optional, this can also be set with `query.queryTypes`. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('query', d.T.string, default=''), + ] + ), + new(name, query=''): + var.withName(name) + + var.withType('query') + + var.withQuery(query), + + '#withDatasource':: d.func.new( + 'Select a datasource for the variable template query.', + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#withDatasourceFromVariable':: d.func.new( + 'Select the datasource from another template variable.', + args=[ + d.arg('variable', d.T.object), + ] + ), + withDatasourceFromVariable(variable): + if variable.type == 'datasource' + then self.withDatasource(variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + '#withRegex':: d.func.new( + ||| + `withRegex` can extract part of a series name or metric node segment. Named + capture groups can be used to separate the display text and value + ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + + '#withSort':: d.func.new( + ||| + Choose how to sort the values in the dropdown. + + This can be called as `withSort() to use the integer values for each + option. If `i==0` then it will be ignored and the other arguments will take + precedence. + + The numerical values are: + + - 1 - Alphabetical (asc) + - 2 - Alphabetical (desc) + - 3 - Numerical (asc) + - 4 - Numerical (desc) + - 5 - Alphabetical (case-insensitive, asc) + - 6 - Alphabetical (case-insensitive, desc) + |||, + args=[ + d.arg('i', d.T.number, default=0), + d.arg('type', d.T.string, default='alphabetical'), + d.arg('asc', d.T.boolean, default=true), + d.arg('caseInsensitive', d.T.boolean, default=false), + ], + ), + withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): + if i != 0 // provide fallback to numerical value + then { sort: i } + else + { + local mapping = { + alphabetical: + if !caseInsensitive + then + if asc + then 1 + else 2 + else + if asc + then 5 + else 6, + numerical: + if asc + then 3 + else 4, + }, + sort: mapping[type], + }, + + // TODO: Expand with Query types to match GUI + queryTypes: { + '#withLabelValues':: d.func.new( + 'Construct a Prometheus template variable using `label_values()`.', + args=[ + d.arg('label', d.T.string), + d.arg('metric', d.T.string, default=''), + ] + ), + withLabelValues(label, metric=''): + if metric == '' + then var.withQuery('label_values(%s)' % label) + else var.withQuery('label_values(%s, %s)' % [metric, label]), + }, + + // Deliberately undocumented, use `refresh` below + withRefresh(value): { + // 1 - On dashboard load + // 2 - On time range chagne + refresh: value, + }, + + local withRefresh = self.withRefresh, + refresh+: { + '#onLoad':: d.func.new( + 'Refresh label values on dashboard load.' + ), + onLoad(): withRefresh(1), + + '#onTime':: d.func.new( + 'Refresh label values on time range change.' + ), + onTime(): withRefresh(2), + }, + }, + + custom: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + `new` creates a custom template variable. + + The `values` array accepts an object with key/value keys, if it's not an object + then it will be added as a string. + + Example: + ``` + [ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, + ] + |||, + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('custom') + + { + // Make values array available in jsonnet + values:: [ + if !std.isObject(item) + then { + key: std.toString(item), + value: std.toString(item), + } + else item + for item in values + ], + + // Render query from values array + query: + std.join(',', [ + std.join(' : ', [item.key, item.value]) + for item in self.values + ]), + + // Set current/options + current: + util.dashboard.getCurrentFromValues( + self.values, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.values), + }, + + withQuery(query): { + values:: util.dashboard.parseCustomQuery(query), + query: query, + }, + }, + + textbox: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a textbox template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('default', d.T.string, default=''), + ] + ), + new(name, default=''): + var.withName(name) + + var.withType('textbox') + + { + local this = self, + default:: default, + query: self.default, + + // Set current/options + keyvaluedict:: [{ key: this.query, value: this.query }], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + }, + + constant: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a hidden constant template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('value', d.T.string), + ] + ), + new(name, value=''): + var.withName(name) + + var.withType('constant') + + var.withHide(2) + + var.withQuery(value), + }, + + datasource: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + '`new` creates a datasource template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + ] + ), + new(name, type): + var.withName(name) + + var.withType('datasource') + + var.withQuery(type), + + '#withRegex':: d.func.new( + ||| + `withRegex` filter for which data source instances to choose from in the + variable value list. Example: `/^prod/` + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + }, + + interval: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an interval template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('interval') + + { + // Make values array available in jsonnet + values:: values, + // Render query from values array + query: std.join(',', self.values), + + // Set current/options + keyvaluedict:: [ + { + key: item, + value: item, + } + for item in values + ], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + + + '#withAutoOption':: d.func.new( + ||| + `withAutoOption` adds an options to dynamically calculate interval by dividing + time range by the count specified. + + `minInterval' has to be either unit-less or end with one of the following units: + "y, M, w, d, h, m, s, ms". + |||, + args=[ + d.arg('count', d.T.number), + d.arg('minInterval', d.T.string), + ] + ), + withAutoOption(count=30, minInterval='10s'): { + local this = self, + + auto: true, + auto_count: count, + auto_min: minInterval, + + // Add auto item to current/options + keyvaluedict:: + [{ key: 'auto', value: '$__auto_interval_' + this.name }] + + super.keyvaluedict, + }, + }, + + adhoc: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an adhoc template variable for datasource with `type` and `uid`.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + new(name, type, uid): + var.withName(name) + + var.withType('adhoc') + + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#newFromDatasourceVariable':: d.func.new( + 'Same as `new` but selecting the datasource from another template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('variable', d.T.object), + ] + ), + newFromDatasourceVariable(name, variable): + if variable.type == 'datasource' + then self.new(name, variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/panel.libsonnet b/gen/grafonnet-v11.0.0/custom/panel.libsonnet new file mode 100644 index 00000000..240a044c --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/panel.libsonnet @@ -0,0 +1,171 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +// match name/title to reduce diff in docs +local panelNames = { + alertgroups: 'alertGroups', + annolist: 'annotationsList', + barchart: 'barChart', + bargauge: 'barGauge', + dashlist: 'dashboardList', + nodeGraph: 'nodeGraph', + piechart: 'pieChart', + 'state-timeline': 'stateTimeline', + 'status-history': 'statusHistory', + timeseries: 'timeSeries', + xychart: 'xyChart', +}; + +local getPanelName(type) = + std.get(panelNames, type, type); + +{ + '#new':: d.func.new( + 'Creates a new %s panel with a title.' % getPanelName(self.panelOptions.withType().type), + args=[d.arg('title', d.T.string)] + ), + new(title): + self.panelOptions.withTitle(title) + + self.panelOptions.withType() + + self.panelOptions.withPluginVersion() + // Default to Mixed datasource so panels can be datasource agnostic, this + // requires query targets to explicitly set datasource, which is a lot more + // interesting from a reusability standpoint. + + self.queryOptions.withDatasource('datasource', '-- Mixed --'), + + // Backwards compatible entries, ignored in docs + link+: self.panelOptions.link + { '#':: { ignore: true } }, + thresholdStep+: self.standardOptions.threshold.step + { '#':: { ignore: true } }, + transformation+: self.queryOptions.transformation + { '#':: { ignore: true } }, + valueMapping+: self.standardOptions.mapping + { '#':: { ignore: true } }, + fieldOverride+: self.standardOptions.override + { '#':: { ignore: true } }, + + '#gridPos': {}, // use withGridPos instead, a bit more concise. + local gridPos = self.gridPos, + panelOptions+: { + '#withPluginVersion': {}, + + '#withGridPos': d.func.new( + ||| + `withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + + All arguments default to `null`, which means they will remain unchanged or unset. + |||, + args=[ + d.arg('h', d.T.number, default='null'), + d.arg('w', d.T.number, default='null'), + d.arg('x', d.T.number, default='null'), + d.arg('y', d.T.number, default='null'), + ] + ), + withGridPos(h=null, w=null, x=null, y=null): + (if h != null then gridPos.withH(h) else {}) + + (if w != null then gridPos.withW(w) else {}) + + (if x != null then gridPos.withX(x) else {}) + + (if y != null then gridPos.withY(y) else {}), + }, + + '#datasource':: {}, // use withDatasource instead, bit more concise + local datasource = self.datasource, + queryOptions+: { + '#withDatasource':: d.func.new( + ||| + `withDatasource` sets the datasource for all queries in a panel. + + The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + |||, + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + datasource.withType(type) + + datasource.withUid(uid), + }, + + standardOptions+: { + threshold+: { step+: { '#':: d.package.newSub('threshold.step', '') } }, + + local overrides = super.override, + local commonOverrideFunctions = { + '#new':: d.fn( + '`new` creates a new override of type `%s`.' % self.type, + args=[ + d.arg('value', d.T.string), + ] + ), + new(value): + overrides.matcher.withId(self.type) + + overrides.matcher.withOptions(value), + + '#withProperty':: d.fn( + ||| + `withProperty` adds a property that needs to be overridden. This function can + be called multiple time, adding more properties. + |||, + args=[ + d.arg('id', d.T.string), + d.arg('value', d.T.any), + ] + ), + withProperty(id, value): + overrides.withPropertiesMixin([ + overrides.properties.withId(id) + + overrides.properties.withValue(value), + ]), + + '#withPropertiesFromOptions':: d.fn( + ||| + `withPropertiesFromOptions` takes an object with properties that need to be + overridden. See example code above. + |||, + args=[ + d.arg('options', d.T.object), + ] + ), + withPropertiesFromOptions(options): + local infunc(input, path=[]) = + std.foldl( + function(acc, p) + acc + ( + if p == 'custom' + then infunc(input[p], path=path + [p]) + else + overrides.withPropertiesMixin([ + overrides.properties.withId(std.join('.', path + [p])) + + overrides.properties.withValue(input[p]), + ]) + ), + std.objectFields(input), + {} + ); + infunc(options.fieldConfig.defaults), + }, + + override: + { + '#':: d.package.newSub( + 'override', + ||| + Overrides allow you to customize visualization settings for specific fields or + series. This is accomplished by adding an override rule that targets + a particular set of fields and that can each define multiple options. + + ```jsonnet + override.byType.new('number') + + override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') + ) + ``` + ||| + ), + byName: commonOverrideFunctions + { type:: 'byName' }, + byRegexp: commonOverrideFunctions + { type:: 'byRegexp' }, + byType: commonOverrideFunctions + { type:: 'byType' }, + byQuery: commonOverrideFunctions + { type:: 'byFrameRefID' }, + // TODO: byValue takes more complex `options` than string + byValue: commonOverrideFunctions + { type:: 'byValue' }, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet b/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet new file mode 100644 index 00000000..9c19f835 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet @@ -0,0 +1,27 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new loki query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'loki', + uid: value, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet b/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet new file mode 100644 index 00000000..3abe2212 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet @@ -0,0 +1,47 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new prometheus query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withIntervalFactor':: d.func.new( + 'Set the interval factor for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withIntervalFactor(value): { + intervalFactor: value, + }, + + '#withLegendFormat':: d.func.new( + 'Set the legend format for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withLegendFormat(value): { + legendFormat: value, + }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'prometheus', + uid: value, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet b/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet new file mode 100644 index 00000000..debcb73a --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet @@ -0,0 +1,29 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new tempo query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('query', d.T.string), + d.arg('filters', d.T.array), + ] + ), + new(datasource, query, filters): + self.withDatasource(datasource) + + self.withQuery(query) + + self.withFilters(filters), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'tempo', + uid: value, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/custom/row.libsonnet b/gen/grafonnet-v11.0.0/custom/row.libsonnet new file mode 100644 index 00000000..049537e2 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/row.libsonnet @@ -0,0 +1,26 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new row panel with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withType() + + self.withCollapsed(false) + + self.gridPos.withX(0) + + self.gridPos.withH(1) + + self.gridPos.withW(24), + + '#gridPos':: {}, // use withGridPos instead + '#withGridPos':: d.func.new( + '`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values.', + args=[d.arg('y', d.T.number)] + ), + withGridPos(y): + self.gridPos.withX(0) + + self.gridPos.withY(y) + + self.gridPos.withH(1) + + self.gridPos.withW(24), +} diff --git a/gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet b/gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet new file mode 100644 index 00000000..da7b2c8d --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet @@ -0,0 +1,55 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local root = self, + + '#getOptionsForCustomQuery':: d.func.new( + ||| + `getOptionsForCustomQuery` provides values for the `options` and `current` fields. + These are required for template variables of type 'custom'but do not automatically + get populated by Grafana when importing a dashboard from JSON. + + This is a bit of a hack and should always be called on functions that set `type` on + a template variable. Ideally Grafana populates these fields from the `query` value + but this provides a backwards compatible solution. + |||, + args=[d.arg('query', d.T.string)], + ), + getOptionsForCustomQuery(query, multi): { + local values = root.parseCustomQuery(query), + current: root.getCurrentFromValues(values, multi), + options: root.getOptionsFromValues(values), + }, + + getCurrentFromValues(values, multi): { + selected: false, + text: if multi then [values[0].key] else values[0].key, + value: if multi then [values[0].value] else values[0].value, + }, + + getOptionsFromValues(values): + std.mapWithIndex( + function(i, item) { + selected: i == 0, + text: item.key, + value: item.value, + }, + values + ), + + parseCustomQuery(query): + std.map( + function(v) + // Split items into key:value pairs + local split = std.splitLimit(v, ' : ', 1); + { + key: std.stripChars(split[0], ' '), + value: + if std.length(split) == 2 + then std.stripChars(split[1], ' ') + else self.key, + }, + xtd.string.splitEscape(query, ',') // Split query by comma, unless the comma is escaped + ), +} diff --git a/gen/grafonnet-v11.0.0/custom/util/grid.libsonnet b/gen/grafonnet-v11.0.0/custom/util/grid.libsonnet new file mode 100644 index 00000000..90a7ec8b --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/util/grid.libsonnet @@ -0,0 +1,173 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +local panelUtil = import './panel.libsonnet'; + +{ + local root = self, + + local gridWidth = 24, + + '#makeGrid':: d.func.new( + ||| + `makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` + and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, + then all panels below it will be folded into the row. + + This function will use the full grid of 24 columns, setting `panelWidth` to a value + that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) + Other value for `panelWidth` will leave a gap on the far right. + + Optional `startY` can be provided to place generated grid above or below existing panels. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + makeGrid(panels, panelWidth=8, panelHeight=8, startY=0): + local sanitizePanels(ps) = std.map( + function(p) + local sanePanel = panelUtil.sanitizePanel(p); + ( + if p.type == 'row' + then sanePanel + { + panels: sanitizePanels(sanePanel.panels), + } + else sanePanel + { + gridPos+: { + h: panelHeight, + w: panelWidth, + }, + } + ), + ps + ); + + local sanitizedPanels = sanitizePanels(panels); + + local grouped = panelUtil.groupPanelsInRows(sanitizedPanels); + + local panelsBeforeRows = panelUtil.getPanelsBeforeNextRow(grouped); + local rowPanels = + std.filter( + function(p) p.type == 'row', + grouped + ); + + local CalculateXforPanel(index, panel) = + local panelsPerRow = std.floor(gridWidth / panelWidth); + local col = std.mod(index, panelsPerRow); + panel + { gridPos+: { x: panelWidth * col } }; + + local panelsBeforeRowsWithX = std.mapWithIndex(CalculateXforPanel, panelsBeforeRows); + + local rowPanelsWithX = + std.map( + function(row) + row + { panels: std.mapWithIndex(CalculateXforPanel, row.panels) }, + rowPanels + ); + + local uncollapsed = panelUtil.resolveCollapsedFlagOnRows(panelsBeforeRowsWithX + rowPanelsWithX); + + local normalized = panelUtil.normalizeY(uncollapsed); + + std.map(function(p) p + { gridPos+: { y+: startY } }, normalized), + + '#wrapPanels':: d.func.new( + ||| + `wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. + 'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + wrapPanels(panels, panelWidth=8, panelHeight=8, startY=0): + std.foldl( + function(acc, panel) + if panel.type == 'row' + then + // when type=row, start new row immediatly and shift Y of new row by max height recorded + acc + { + panels+: [ + panel + { + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y + acc.cursor.maxH, + w: 0, + h: 1, + }, + }, + ], + cursor:: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH + 1, + maxH: 0, + }, + } + else + // handle regular panel + local gridPos = std.get(panel, 'gridPos', {}); + local width = std.get(gridPos, 'w', panelWidth); + local height = std.get(gridPos, 'h', panelHeight); + if acc.cursor.x + width > gridWidth + then + // start new row as width exceeds gridWidth + acc + { + panels+: [ + panel + { + gridPos+: + { + x: 0, + y: acc.cursor.y + height, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: 0 + width, + y: acc.cursor.y + height, + maxH: if height > super.maxH then height else super.maxH, + }, + } + else + // enough width, place panel on current row + acc + { + panels+: [ + panel + { + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: acc.cursor.x + width, + y: acc.cursor.y, + maxH: if height > super.maxH then height else super.maxH, + }, + }, + panels, + // Initial value for acc + { + panels: [], + cursor:: { + x: 0, + y: startY, + maxH: 0, // max height of current 'row' + }, + } + ).panels, +} diff --git a/gen/grafonnet-v11.0.0/custom/util/main.libsonnet b/gen/grafonnet-v11.0.0/custom/util/main.libsonnet new file mode 100644 index 00000000..78fe95fc --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/util/main.libsonnet @@ -0,0 +1,9 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.package.newSub('util', 'Helper functions that work well with Grafonnet.'), + dashboard: (import './dashboard.libsonnet'), + grid: (import './grid.libsonnet'), + panel: (import './panel.libsonnet'), + string: (import './string.libsonnet'), +} diff --git a/gen/grafonnet-v11.0.0/custom/util/panel.libsonnet b/gen/grafonnet-v11.0.0/custom/util/panel.libsonnet new file mode 100644 index 00000000..8d81cdab --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/util/panel.libsonnet @@ -0,0 +1,321 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local this = self, + + // used in ../dashboard.libsonnet + '#setPanelIDs':: d.func.new( + ||| + `setPanelIDs` ensures that all `panels` have a unique ID, this function is used in `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent experience. + + `overrideExistingIDs` can be set to not replace existing IDs, consider validating the IDs with `validatePanelIDs()` to ensure there are no duplicate IDs. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('overrideExistingIDs', d.T.bool, default=true), + ] + ), + setPanelIDs(panels, overrideExistingIDs=true): + local infunc(panels, start=1) = + std.foldl( + function(acc, panel) + acc + { + index: // Track the index to ensure no duplicates exist. + acc.index + + 1 + + (if panel.type == 'row' + && 'panels' in panel + then std.length(panel.panels) + else 0), + + panels+: [ + panel + + ( + if overrideExistingIDs + || std.get(panel, 'id', null) == null + then { id: acc.index } + else {} + ) + + ( + if panel.type == 'row' + && 'panels' in panel + then { + panels: + infunc( + panel.panels, + acc.index + 1 + ), + } + else {} + ), + ], + }, + panels, + { index: start, panels: [] } + ).panels; + infunc(panels), + + '#getPanelIDs':: d.func.new( + ||| + `getPanelIDs` returns an array with all panel IDs including IDs from panels in rows. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + getPanelIDs(panels): + std.flattenArrays( + std.map( + function(panel) + [panel.id] + + (if panel.type == 'row' + then this.getPanelIDs(std.get(panel, 'panels', [])) + else []), + panels + ) + ), + + '#validatePanelIDs':: d.func.new( + ||| + `validatePanelIDs` validates returns `false` if there are duplicate panel IDs in `panels`. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + validatePanelIDs(panels): + local ids = this.getPanelIDs(panels); + std.set(ids) == std.sort(ids), + + '#sanitizePanel':: d.func.new( + ||| + `sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + + The default values for x,y,h,w are only applied if not already set. + |||, + [ + d.arg('panel', d.T.object), + d.arg('defaultX', d.T.number, default=0), + d.arg('defaultY', d.T.number, default=0), + d.arg('defaultHeight', d.T.number, default=8), + d.arg('defaultWidth', d.T.number, default=8), + ] + ), + sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8): + local infunc(panel) = + panel + + ( + local gridPos = std.get(panel, 'gridPos', {}); + if panel.type == 'row' + then { + collapsed: std.get(panel, 'collapsed', false), + panels: std.map(infunc, std.get(panel, 'panels', [])), + gridPos: { // x, h, w are fixed + x: 0, + y: std.get(gridPos, 'y', defaultY), + h: 1, + w: 24, + }, + } + else { + gridPos: { + x: std.get(gridPos, 'x', defaultX), + y: std.get(gridPos, 'y', defaultY), + h: std.get(gridPos, 'h', defaultHeight), + w: std.get(gridPos, 'w', defaultWidth), + }, + } + ); + infunc(panel), + + '#sortPanelsByXY':: d.func.new( + ||| + `sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + sortPanelsByXY(panels): + std.sort( + std.sort( + panels, + function(panel) + panel.gridPos.x + ), + function(panel) + panel.gridPos.y + ), + + '#sortPanelsInRow':: d.func.new( + ||| + `sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + sortPanelsInRow(rowPanel): + rowPanel + { panels: this.sortPanelsByXY(rowPanel.panels) }, + + '#groupPanelsInRows':: d.func.new( + ||| + `groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + groupPanelsInRows(panels): + // Add panels that come after a row to row.panels + local grouped = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) + p + { + panels+: + this.getPanelsBeforeNextRow(panels[i + 1:]), + }, + panels, + ); + + // Get panels that come before the rowGroups + local panelsBeforeRowGroups = this.getPanelsBeforeNextRow(panels); + + panelsBeforeRowGroups + grouped, + + '#getPanelsBeforeNextRow':: d.func.new( + ||| + `getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + getPanelsBeforeNextRow(panels): + local rowIndexes = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) i, + panels, + ); + if std.length(rowIndexes) != 0 + then panels[0:rowIndexes[0]] + else panels[0:], // if no row panels found, return all remaining panels + + '#resolveCollapsedFlagOnRows':: d.func.new( + ||| + `resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + resolveCollapsedFlagOnRows(panels): + std.foldl( + function(acc, panel) + acc + ( + if panel.type == 'row' + && !panel.collapsed + then // If not collapsed, then move panels to main array below the row panel + [panel + { panels: [] }] + + panel.panels + else [panel] + ), + panels, + [], + ), + + '#normalizeY':: d.func.new( + ||| + `normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + + This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + normalizeY(panels): + std.foldl( + function(acc, i) + acc + [ + panels[i] + { + gridPos+: { + y: this.calculateLowestYforPanel(panels[i], acc), + }, + }, + ], + std.range(0, std.length(panels) - 1), + [] + ), + + '#calculateLowestYforPanel':: d.func.new( + ||| + `calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + |||, + [ + d.arg('panel', d.T.object), + d.arg('panels', d.T.array), + ] + ), + calculateLowestYforPanel(panel, panels): + xtd.number.maxInArray( // the new position is highest value (max) on the Y-scale + std.filterMap( + function(p) // find panels that overlap on X-scale + local v1 = panel.gridPos.x; + local v2 = panel.gridPos.x + panel.gridPos.w; + local x1 = p.gridPos.x; + local x2 = p.gridPos.x + p.gridPos.w; + (v1 >= x1 && v1 < x2) + || (v2 >= x1 && v2 < x2), + function(p) // return new position on Y-scale + p.gridPos.y + p.gridPos.h, + panels, + ), + ), + + '#normalizeYInRow':: d.func.new( + ||| + `normalizeYInRow` applies `normalizeY` to the panels in a row panel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + normalizeYInRow(rowPanel): + rowPanel + { + panels: + std.map( + function(p) + p + { + gridPos+: { + y: // Increase panel Y with the row Y to put them below the row when not collapsed. + p.gridPos.y + + rowPanel.gridPos.y + + rowPanel.gridPos.h, + }, + }, + this.normalizeY(rowPanel.panels) + ), + }, + + '#mapToRows':: d.func.new( + ||| + `mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + |||, + [ + d.arg('func', d.T.func), + d.arg('panels', d.T.array), + ] + ), + mapToRows(func, panels): + std.map( + function(p) + if p.type == 'row' + then func(p) + else p, + panels + ), +} diff --git a/gen/grafonnet-v11.0.0/custom/util/string.libsonnet b/gen/grafonnet-v11.0.0/custom/util/string.libsonnet new file mode 100644 index 00000000..ec5a66e4 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/util/string.libsonnet @@ -0,0 +1,27 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + '#slugify':: d.func.new( + ||| + `slugify` will create a simple slug from `string`, keeping only alphanumeric + characters and replacing spaces with dashes. + |||, + args=[d.arg('string', d.T.string)] + ), + slugify(string): + std.strReplace( + std.asciiLower( + std.join('', [ + string[i] + for i in std.range(0, std.length(string) - 1) + if xtd.ascii.isUpper(string[i]) + || xtd.ascii.isLower(string[i]) + || xtd.ascii.isNumber(string[i]) + || string[i] == ' ' + ]) + ), + ' ', + '-', + ), +} diff --git a/gen/grafonnet-v11.0.0/dashboard.libsonnet b/gen/grafonnet-v11.0.0/dashboard.libsonnet new file mode 100644 index 00000000..03d41ec6 --- /dev/null +++ b/gen/grafonnet-v11.0.0/dashboard.libsonnet @@ -0,0 +1,580 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.dashboard', name: 'dashboard' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of dashboard.' } }, + withDescription(value): { + description: value, + }, + '#withEditable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether a dashboard is editable or not.' } }, + withEditable(value=true): { + editable: value, + }, + '#withFiscalYearStartMonth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'The month that the fiscal year starts on. 0 = January, 11 = December' } }, + withFiscalYearStartMonth(value=0): { + fiscalYearStartMonth: value, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinks(value): { + links: + (if std.isArray(value) + then value + else [value]), + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinksMixin(value): { + links+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLiveNow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data "moving left" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data' } }, + withLiveNow(value=true): { + liveNow: value, + }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { + panels: + (if std.isArray(value) + then value + else [value]), + }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { + panels+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRefresh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefresh(value): { + refresh: value, + }, + '#withSchemaVersion': { 'function': { args: [{ default: 36, enums: null, name: 'value', type: ['integer'] }], help: 'Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.' } }, + withSchemaVersion(value=36): { + schemaVersion: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTemplating': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplating(value): { + templating: value, + }, + '#withTemplatingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplatingMixin(value): { + templating+: value, + }, + '#withTimezone': { 'function': { args: [{ default: 'browser', enums: null, name: 'value', type: ['string'] }], help: 'Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc".' } }, + withTimezone(value='browser'): { + timezone: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title of dashboard.' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique dashboard identifier that can be generated by anyone. string (8-40)' } }, + withUid(value): { + uid: value, + }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday".' } }, + withWeekStart(value): { + weekStart: value, + }, + time+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value='now-6h'): { + time+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value='now'): { + time+: { + to: value, + }, + }, + }, + timepicker+: + { + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is visible or not.' } }, + withHidden(value=true): { + timepicker+: { + hidden: value, + }, + }, + '#withNowDelay': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values.' } }, + withNowDelay(value): { + timepicker+: { + nowDelay: value, + }, + }, + '#withRefreshIntervals': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervals(value): { + timepicker+: { + refresh_intervals: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withRefreshIntervalsMixin': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervalsMixin(value): { + timepicker+: { + refresh_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeOptions': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptions(value): { + timepicker+: { + time_options: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeOptionsMixin': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptionsMixin(value): { + timepicker+: { + time_options+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + link+: + { + dashboards+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + }, + }, + link+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + }, + }, + }, + annotation+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withList(value): { + annotations+: { + list: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withListMixin(value): { + annotations+: { + list+: + (if std.isArray(value) + then value + else [value]), + }, + }, + list+: + { + '#': { help: '', name: 'list' }, + '#withBuiltIn': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Set to 1 for the standard annotation query all dashboards have by default.' } }, + withBuiltIn(value=0): { + builtIn: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEnable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled the annotation query is issued with every dashboard refresh' } }, + withEnable(value=true): { + enable: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withExclude': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Should the specified panels be included or excluded' } }, + withExclude(value=true): { + filter+: { + exclude: value, + }, + }, + '#withIds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIds(value): { + filter+: { + ids: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withIdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIdsMixin(value): { + filter+: { + ids+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.' } }, + withHide(value=true): { + hide: value, + }, + '#withIconColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color to use for the annotation event markers' } }, + withIconColor(value): { + iconColor: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of annotation.' } }, + withName(value): { + name: value, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTarget(value): { + target: value, + }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTargetMixin(value): { + target+: value, + }, + target+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withLimit(value): { + target+: { + limit: value, + }, + }, + '#withMatchAny': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withMatchAny(value=true): { + target+: { + matchAny: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTags(value): { + target+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTagsMixin(value): { + target+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withType(value): { + target+: { + type: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO -- this should not exist here, it is based on the --grafana-- datasource' } }, + withType(value): { + type: value, + }, + }, + }, + variable+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withList(value): { + templating+: { + list: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withListMixin(value): { + templating+: { + list+: + (if std.isArray(value) + then value + else [value]), + }, + }, + list+: + { + '#': { help: '', name: 'list' }, + '#withAllValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom all value' } }, + withAllValue(value): { + allValue: value, + }, + '#withCurrent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrent(value): { + current: value, + }, + '#withCurrentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrentMixin(value): { + current+: value, + }, + current+: + { + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { + current+: { + selected: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { + current+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { + current+: { + text+: value, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { + current+: { + value: value, + }, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { + current+: { + value+: value, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of variable. It can be defined but `null`.' } }, + withDescription(value): { + description: value, + }, + '#withHide': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: 'Determine if the variable shows on dashboard\nAccepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).' } }, + withHide(value): { + hide: value, + }, + '#withIncludeAll': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether all value option is available or not' } }, + withIncludeAll(value=true): { + includeAll: value, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display name' } }, + withLabel(value): { + label: value, + }, + '#withMulti': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether multiple values can be selected or not from variable value list' } }, + withMulti(value=true): { + multi: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of variable' } }, + withName(value): { + name: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptions(value): { + options: + (if std.isArray(value) + then value + else [value]), + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptionsMixin(value): { + options+: + (if std.isArray(value) + then value + else [value]), + }, + options+: + { + '#': { help: '', name: 'options' }, + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { + selected: value, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { + text: value, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { + text+: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { + value+: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQuery(value): { + query: value, + }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQueryMixin(value): { + query+: value, + }, + '#withRefresh': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: 'Options to config when to refresh a variable\n`0`: Never refresh the variable\n`1`: Queries the data source every time the dashboard loads.\n`2`: Queries the data source when the dashboard time range changes.' } }, + withRefresh(value): { + refresh: value, + }, + '#withRegex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional field, if you want to extract part of a series name or metric node segment.\nNamed capture groups can be used to separate the display text and value.' } }, + withRegex(value): { + regex: value, + }, + '#withSkipUrlSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the variable value should be managed by URL query params or not' } }, + withSkipUrlSync(value=true): { + skipUrlSync: value, + }, + '#withSort': { 'function': { args: [{ default: null, enums: [0, 1, 2, 3, 4, 5, 6, 7, 8], name: 'value', type: ['string'] }], help: 'Sort variable options\nAccepted values are:\n`0`: No sorting\n`1`: Alphabetical ASC\n`2`: Alphabetical DESC\n`3`: Numerical ASC\n`4`: Numerical DESC\n`5`: Alphabetical Case Insensitive ASC\n`6`: Alphabetical Case Insensitive DESC\n`7`: Natural ASC\n`8`: Natural DESC' } }, + withSort(value): { + sort: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['query', 'adhoc', 'groupby', 'constant', 'datasource', 'interval', 'textbox', 'custom', 'system'], name: 'value', type: ['string'] }], help: 'Dashboard variable type\n`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.\n`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).\n`constant`: \tDefine a hidden constant.\n`datasource`: Quickly change the data source for an entire dashboard.\n`interval`: Interval variables represent time spans.\n`textbox`: Display a free text input field with an optional default value.\n`custom`: Define the variable options manually using a comma-separated list.\n`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables' } }, + withType(value): { + type: value, + }, + }, + }, +} ++ (import 'custom/dashboard.libsonnet') diff --git a/gen/grafonnet-v11.0.0/docs/README.md b/gen/grafonnet-v11.0.0/docs/README.md new file mode 100644 index 00000000..17958966 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/README.md @@ -0,0 +1,31 @@ +# grafonnet + +Jsonnet library for rendering Grafana resources +## Install + +``` +jb install github.com/grafana/grafonnet/gen/grafonnet-v11.0.0@main +``` + +## Usage + +```jsonnet +local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet" +``` + + +## Subpackages + +* [accesspolicy](accesspolicy/index.md) +* [alerting](alerting/index.md) +* [dashboard](dashboard/index.md) +* [folder](folder.md) +* [librarypanel](librarypanel/index.md) +* [panel](panel/index.md) +* [preferences](preferences.md) +* [publicdashboard](publicdashboard.md) +* [query](query/index.md) +* [role](role.md) +* [rolebinding](rolebinding.md) +* [team](team.md) +* [util](util.md) diff --git a/gen/grafonnet-v11.0.0/docs/accesspolicy/index.md b/gen/grafonnet-v11.0.0/docs/accesspolicy/index.md new file mode 100644 index 00000000..ff3dcfc8 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/accesspolicy/index.md @@ -0,0 +1,156 @@ +# accesspolicy + +grafonnet.accesspolicy + +## Subpackages + +* [rules](rules.md) + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withScopeMixin(value)`](#fn-withscopemixin) +* [`obj role`](#obj-role) + * [`fn withKind(value)`](#fn-rolewithkind) + * [`fn withName(value)`](#fn-rolewithname) + * [`fn withXname(value)`](#fn-rolewithxname) +* [`obj scope`](#obj-scope) + * [`fn withKind(value)`](#fn-scopewithkind) + * [`fn withName(value)`](#fn-scopewithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScopeMixin + +```jsonnet +withScopeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj role + + +#### fn role.withKind + +```jsonnet +role.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Role"`, `"BuiltinRole"`, `"Team"`, `"User"` + +Policies can apply to roles, teams, or users +Applying policies to individual users is supported, but discouraged +#### fn role.withName + +```jsonnet +role.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn role.withXname + +```jsonnet +role.withXname(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj scope + + +#### fn scope.withKind + +```jsonnet +scope.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn scope.withName + +```jsonnet +scope.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md b/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md new file mode 100644 index 00000000..86de7c06 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md @@ -0,0 +1,71 @@ +# rules + + + +## Index + +* [`fn withKind(value)`](#fn-withkind) +* [`fn withKindMixin(value)`](#fn-withkindmixin) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withVerb(value)`](#fn-withverb) +* [`fn withVerbMixin(value)`](#fn-withverbmixin) + +## Fields + +### fn withKind + +```jsonnet +withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The kind this rule applies to (dashboards, alert, etc) +### fn withKindMixin + +```jsonnet +withKindMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The kind this rule applies to (dashboards, alert, etc) +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific sub-elements like "alert.rules" or "dashboard.permissions"???? +### fn withVerb + +```jsonnet +withVerb(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" +### fn withVerbMixin + +```jsonnet +withVerbMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md b/gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md new file mode 100644 index 00000000..b796b0c1 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md @@ -0,0 +1,100 @@ +# contactPoint + +grafonnet.alerting.contactPoint + +**NOTE**: The schemas for all different contact points is under development, this means we can't properly express them in Grafonnet yet. The way this works now may change heavily. + + +## Index + +* [`fn withDisableResolveMessage(value=true)`](#fn-withdisableresolvemessage) +* [`fn withName(value)`](#fn-withname) +* [`fn withProvenance(value)`](#fn-withprovenance) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withDisableResolveMessage + +```jsonnet +withDisableResolveMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name is used as grouping key in the UI. Contact points with the +same name will be grouped in the UI. +### fn withProvenance + +```jsonnet +withProvenance(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` + + +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID is the unique identifier of the contact point. The UID can be +set by the user. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/alerting/index.md b/gen/grafonnet-v11.0.0/docs/alerting/index.md new file mode 100644 index 00000000..b77a82d0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/index.md @@ -0,0 +1,11 @@ +# alerting + +grafonnet.alerting + +## Subpackages + +* [contactPoint](contactPoint.md) +* [messageTemplate](messageTemplate.md) +* [muteTiming](muteTiming/index.md) +* [notificationPolicy](notificationPolicy/index.md) +* [ruleGroup](ruleGroup/index.md) diff --git a/gen/grafonnet-v11.0.0/docs/alerting/messageTemplate.md b/gen/grafonnet-v11.0.0/docs/alerting/messageTemplate.md new file mode 100644 index 00000000..df7c2333 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/messageTemplate.md @@ -0,0 +1,32 @@ +# messageTemplate + +grafonnet.alerting.messageTemplate + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withTemplate(value)`](#fn-withtemplate) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTemplate + +```jsonnet +withTemplate(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md new file mode 100644 index 00000000..3aee846b --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md @@ -0,0 +1,48 @@ +# muteTiming + +grafonnet.alerting.muteTiming + +## Subpackages + +* [interval](interval/index.md) + +## Index + +* [`fn withIntervals(value)`](#fn-withintervals) +* [`fn withIntervalsMixin(value)`](#fn-withintervalsmixin) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withIntervals + +```jsonnet +withIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withIntervalsMixin + +```jsonnet +withIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md new file mode 100644 index 00000000..18021fc9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md @@ -0,0 +1,48 @@ +# interval + + + +## Subpackages + +* [time_intervals](time_intervals/index.md) + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeIntervals(value)`](#fn-withtimeintervals) +* [`fn withTimeIntervalsMixin(value)`](#fn-withtimeintervalsmixin) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeIntervals + +```jsonnet +withTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimeIntervalsMixin + +```jsonnet +withTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md new file mode 100644 index 00000000..e649ec25 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md @@ -0,0 +1,144 @@ +# time_intervals + + + +## Subpackages + +* [times](times.md) + +## Index + +* [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) +* [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withMonths(value)`](#fn-withmonths) +* [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) +* [`fn withTimes(value)`](#fn-withtimes) +* [`fn withTimesMixin(value)`](#fn-withtimesmixin) +* [`fn withWeekdays(value)`](#fn-withweekdays) +* [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) +* [`fn withYears(value)`](#fn-withyears) +* [`fn withYearsMixin(value)`](#fn-withyearsmixin) + +## Fields + +### fn withDaysOfMonth + +```jsonnet +withDaysOfMonth(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDaysOfMonthMixin + +```jsonnet +withDaysOfMonthMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMonths + +```jsonnet +withMonths(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMonthsMixin + +```jsonnet +withMonthsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimes + +```jsonnet +withTimes(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimesMixin + +```jsonnet +withTimesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdays + +```jsonnet +withWeekdays(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdaysMixin + +```jsonnet +withWeekdaysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYears + +```jsonnet +withYears(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYearsMixin + +```jsonnet +withYearsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md new file mode 100644 index 00000000..8304969e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md @@ -0,0 +1,32 @@ +# times + + + +## Index + +* [`fn withEndTime(value)`](#fn-withendtime) +* [`fn withStartTime(value)`](#fn-withstarttime) + +## Fields + +### fn withEndTime + +```jsonnet +withEndTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withStartTime + +```jsonnet +withStartTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md b/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md new file mode 100644 index 00000000..cb4aa0a9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md @@ -0,0 +1,173 @@ +# notificationPolicy + +grafonnet.alerting.notificationPolicy + +## Subpackages + +* [matcher](matcher.md) + +## Index + +* [`fn withContactPoint(value)`](#fn-withcontactpoint) +* [`fn withContinue(value=true)`](#fn-withcontinue) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withGroupInterval(value)`](#fn-withgroupinterval) +* [`fn withGroupWait(value)`](#fn-withgroupwait) +* [`fn withMatchers(value)`](#fn-withmatchers) +* [`fn withMatchersMixin(value)`](#fn-withmatchersmixin) +* [`fn withMuteTimeIntervals(value)`](#fn-withmutetimeintervals) +* [`fn withMuteTimeIntervalsMixin(value)`](#fn-withmutetimeintervalsmixin) +* [`fn withPolicy(value)`](#fn-withpolicy) +* [`fn withPolicyMixin(value)`](#fn-withpolicymixin) +* [`fn withRepeatInterval(value)`](#fn-withrepeatinterval) + +## Fields + +### fn withContactPoint + +```jsonnet +withContactPoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withContinue + +```jsonnet +withContinue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupInterval + +```jsonnet +withGroupInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withGroupWait + +```jsonnet +withGroupWait(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMatchers + +```jsonnet +withMatchers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMatchersMixin + +```jsonnet +withMatchersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMuteTimeIntervals + +```jsonnet +withMuteTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMuteTimeIntervalsMixin + +```jsonnet +withMuteTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPolicy + +```jsonnet +withPolicy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPolicyMixin + +```jsonnet +withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRepeatInterval + +```jsonnet +withRepeatInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md b/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md new file mode 100644 index 00000000..f31b1d85 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md @@ -0,0 +1,45 @@ +# matcher + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"="`, `"!="`, `"=~"`, `"!~"` + +MatchType is an enum for label matching types. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md new file mode 100644 index 00000000..21d94b5f --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md @@ -0,0 +1,72 @@ +# ruleGroup + +grafonnet.alerting.ruleGroup + +## Subpackages + +* [rule](rule/index.md) + +## Index + +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withName(value)`](#fn-withname) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) + +## Fields + +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md new file mode 100644 index 00000000..0c605200 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md @@ -0,0 +1,128 @@ +# data + + + +## Index + +* [`fn withDatasourceUid(value)`](#fn-withdatasourceuid) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRelativeTimeRange(value)`](#fn-withrelativetimerange) +* [`fn withRelativeTimeRangeMixin(value)`](#fn-withrelativetimerangemixin) +* [`obj relativeTimeRange`](#obj-relativetimerange) + * [`fn withFrom(value)`](#fn-relativetimerangewithfrom) + * [`fn withTo(value)`](#fn-relativetimerangewithto) + +## Fields + +### fn withDatasourceUid + +```jsonnet +withDatasourceUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +JSON is the raw JSON query and includes the above properties as well as custom properties. +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +JSON is the raw JSON query and includes the above properties as well as custom properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withRelativeTimeRange + +```jsonnet +withRelativeTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### fn withRelativeTimeRangeMixin + +```jsonnet +withRelativeTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### obj relativeTimeRange + + +#### fn relativeTimeRange.withFrom + +```jsonnet +relativeTimeRange.withFrom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +A Duration represents the elapsed time between two instants +as an int64 nanosecond count. The representation limits the +largest representable duration to approximately 290 years. +#### fn relativeTimeRange.withTo + +```jsonnet +relativeTimeRange.withTo(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +A Duration represents the elapsed time between two instants +as an int64 nanosecond count. The representation limits the +largest representable duration to approximately 290 years. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md new file mode 100644 index 00000000..e93787c0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md @@ -0,0 +1,161 @@ +# rule + + + +## Subpackages + +* [data](data.md) + +## Index + +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withCondition(value)`](#fn-withcondition) +* [`fn withData(value)`](#fn-withdata) +* [`fn withDataMixin(value)`](#fn-withdatamixin) +* [`fn withExecErrState(value)`](#fn-withexecerrstate) +* [`fn withFor(value)`](#fn-withfor) +* [`fn withIsPaused(value=true)`](#fn-withispaused) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLabelsMixin(value)`](#fn-withlabelsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withNoDataState(value)`](#fn-withnodatastate) + +## Fields + +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCondition + +```jsonnet +withCondition(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withData + +```jsonnet +withData(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDataMixin + +```jsonnet +withDataMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withExecErrState + +```jsonnet +withExecErrState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"OK"`, `"Alerting"`, `"Error"` + + +### fn withFor + +```jsonnet +withFor(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +A Duration represents the elapsed time between two instants +as an int64 nanosecond count. The representation limits the +largest representable duration to approximately 290 years. +### fn withIsPaused + +```jsonnet +withIsPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelsMixin + +```jsonnet +withLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withNoDataState + +```jsonnet +withNoDataState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Alerting"`, `"NoData"`, `"OK"` + diff --git a/gen/grafonnet-v11.0.0/docs/dashboard/annotation.md b/gen/grafonnet-v11.0.0/docs/dashboard/annotation.md new file mode 100644 index 00000000..73955299 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/dashboard/annotation.md @@ -0,0 +1,298 @@ +# annotation + + + +## Index + +* [`fn withBuiltIn(value=0)`](#fn-withbuiltin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEnable(value=true)`](#fn-withenable) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIconColor(value)`](#fn-withiconcolor) +* [`fn withName(value)`](#fn-withname) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj filter`](#obj-filter) + * [`fn withExclude(value=true)`](#fn-filterwithexclude) + * [`fn withIds(value)`](#fn-filterwithids) + * [`fn withIdsMixin(value)`](#fn-filterwithidsmixin) +* [`obj target`](#obj-target) + * [`fn withLimit(value)`](#fn-targetwithlimit) + * [`fn withMatchAny(value=true)`](#fn-targetwithmatchany) + * [`fn withTags(value)`](#fn-targetwithtags) + * [`fn withTagsMixin(value)`](#fn-targetwithtagsmixin) + * [`fn withType(value)`](#fn-targetwithtype) + +## Fields + +### fn withBuiltIn + +```jsonnet +withBuiltIn(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Set to 1 for the standard annotation query all dashboards have by default. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withEnable + +```jsonnet +withEnable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled the annotation query is issued with every dashboard refresh +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Annotation queries can be toggled on or off at the top of the dashboard. +When hide is true, the toggle is not shown in the dashboard. +### fn withIconColor + +```jsonnet +withIconColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color to use for the annotation event markers +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of annotation. +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: this should be a regular DataQuery that depends on the selected dashboard +these match the properties of the "grafana" datasouce that is default in most dashboards +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: this should be a regular DataQuery that depends on the selected dashboard +these match the properties of the "grafana" datasouce that is default in most dashboards +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TODO -- this should not exist here, it is based on the --grafana-- datasource +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj filter + + +#### fn filter.withExclude + +```jsonnet +filter.withExclude(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Should the specified panels be included or excluded +#### fn filter.withIds + +```jsonnet +filter.withIds(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel IDs that should be included or excluded +#### fn filter.withIdsMixin + +```jsonnet +filter.withIdsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel IDs that should be included or excluded +### obj target + + +#### fn target.withLimit + +```jsonnet +target.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withMatchAny + +```jsonnet +target.withMatchAny(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withTags + +```jsonnet +target.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withTagsMixin + +```jsonnet +target.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withType + +```jsonnet +target.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/dashboard/index.md b/gen/grafonnet-v11.0.0/docs/dashboard/index.md new file mode 100644 index 00000000..7cbee639 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/dashboard/index.md @@ -0,0 +1,480 @@ +# dashboard + +grafonnet.dashboard + +## Subpackages + +* [annotation](annotation.md) +* [link](link.md) +* [variable](variable.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withEditable(value=true)`](#fn-witheditable) +* [`fn withFiscalYearStartMonth(value=0)`](#fn-withfiscalyearstartmonth) +* [`fn withLinks(value)`](#fn-withlinks) +* [`fn withLinksMixin(value)`](#fn-withlinksmixin) +* [`fn withLiveNow(value=true)`](#fn-withlivenow) +* [`fn withPanels(panels, setPanelIDs=true)`](#fn-withpanels) +* [`fn withPanelsMixin(panels, setPanelIDs=true)`](#fn-withpanelsmixin) +* [`fn withRefresh(value)`](#fn-withrefresh) +* [`fn withSchemaVersion(value=36)`](#fn-withschemaversion) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTemplating(value)`](#fn-withtemplating) +* [`fn withTemplatingMixin(value)`](#fn-withtemplatingmixin) +* [`fn withTimezone(value="browser")`](#fn-withtimezone) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVariables(value)`](#fn-withvariables) +* [`fn withVariablesMixin(value)`](#fn-withvariablesmixin) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj graphTooltip`](#obj-graphtooltip) + * [`fn withSharedCrosshair()`](#fn-graphtooltipwithsharedcrosshair) + * [`fn withSharedTooltip()`](#fn-graphtooltipwithsharedtooltip) +* [`obj time`](#obj-time) + * [`fn withFrom(value="now-6h")`](#fn-timewithfrom) + * [`fn withTo(value="now")`](#fn-timewithto) +* [`obj timepicker`](#obj-timepicker) + * [`fn withHidden(value=true)`](#fn-timepickerwithhidden) + * [`fn withNowDelay(value)`](#fn-timepickerwithnowdelay) + * [`fn withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervals) + * [`fn withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervalsmixin) + * [`fn withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptions) + * [`fn withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptionsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboard with a title. +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withAnnotations` adds an array of annotations to a dashboard. + +This function appends passed data to existing values + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withAnnotationsMixin` adds an array of annotations to a dashboard. + +This function appends passed data to existing values + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of dashboard. +### fn withEditable + +```jsonnet +withEditable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether a dashboard is editable or not. +### fn withFiscalYearStartMonth + +```jsonnet +withFiscalYearStartMonth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +The month that the fiscal year starts on. 0 = January, 11 = December +### fn withLinks + +```jsonnet +withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + +### fn withLinksMixin + +```jsonnet +withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + +### fn withLiveNow + +```jsonnet +withLiveNow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When set to true, the dashboard will redraw panels at an interval matching the pixel width. +This will keep data "moving left" regardless of the query refresh rate. This setting helps +avoid dashboards presenting stale live data +### fn withPanels + +```jsonnet +withPanels(panels, setPanelIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **setPanelIDs** (`bool`) + - default value: `true` + +`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`. +### fn withPanelsMixin + +```jsonnet +withPanelsMixin(panels, setPanelIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **setPanelIDs** (`bool`) + - default value: `true` + +`withPanelsMixin` adds more panels to a dashboard. +### fn withRefresh + +```jsonnet +withRefresh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value=36) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `36` + +Version of the JSON schema, incremented each time a Grafana update brings +changes to said schema. +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Tags associated with dashboard. +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Tags associated with dashboard. +### fn withTemplating + +```jsonnet +withTemplating(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configured template variables +### fn withTemplatingMixin + +```jsonnet +withTemplatingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configured template variables +### fn withTimezone + +```jsonnet +withTimezone(value="browser") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"browser"` + +Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc". +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title of dashboard. +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique dashboard identifier that can be generated by anyone. string (8-40) +### fn withVariables + +```jsonnet +withVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withVariables` adds an array of variables to a dashboard + +### fn withVariablesMixin + +```jsonnet +withVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withVariablesMixin` adds an array of variables to a dashboard. + +This function appends passed data to existing values + +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday". +### obj graphTooltip + + +#### fn graphTooltip.withSharedCrosshair + +```jsonnet +graphTooltip.withSharedCrosshair() +``` + + +Share crosshair on all panels. +#### fn graphTooltip.withSharedTooltip + +```jsonnet +graphTooltip.withSharedTooltip() +``` + + +Share crosshair and tooltip on all panels. +### obj time + + +#### fn time.withFrom + +```jsonnet +time.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + + +#### fn time.withTo + +```jsonnet +time.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + + +### obj timepicker + + +#### fn timepicker.withHidden + +```jsonnet +timepicker.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether timepicker is visible or not. +#### fn timepicker.withNowDelay + +```jsonnet +timepicker.withNowDelay(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values. +#### fn timepicker.withRefreshIntervals + +```jsonnet +timepicker.withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. +#### fn timepicker.withRefreshIntervalsMixin + +```jsonnet +timepicker.withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. +#### fn timepicker.withTimeOptions + +```jsonnet +timepicker.withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. +#### fn timepicker.withTimeOptionsMixin + +```jsonnet +timepicker.withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/dashboard/link.md b/gen/grafonnet-v11.0.0/docs/dashboard/link.md new file mode 100644 index 00000000..421e0c00 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/dashboard/link.md @@ -0,0 +1,196 @@ +# link + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + + +## Index + +* [`obj dashboards`](#obj-dashboards) + * [`fn new(title, tags)`](#fn-dashboardsnew) + * [`obj options`](#obj-dashboardsoptions) + * [`fn withAsDropdown(value=true)`](#fn-dashboardsoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-dashboardsoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-dashboardsoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-dashboardsoptionswithtargetblank) +* [`obj link`](#obj-link) + * [`fn new(title, url)`](#fn-linknew) + * [`fn withIcon(value)`](#fn-linkwithicon) + * [`fn withTooltip(value)`](#fn-linkwithtooltip) + * [`obj options`](#obj-linkoptions) + * [`fn withAsDropdown(value=true)`](#fn-linkoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-linkoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-linkoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-linkoptionswithtargetblank) + +## Fields + +### obj dashboards + + +#### fn dashboards.new + +```jsonnet +dashboards.new(title, tags) +``` + +PARAMETERS: + +* **title** (`string`) +* **tags** (`array`) + +Create links to dashboards based on `tags`. + +#### obj dashboards.options + + +##### fn dashboards.options.withAsDropdown + +```jsonnet +dashboards.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +##### fn dashboards.options.withIncludeVars + +```jsonnet +dashboards.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn dashboards.options.withKeepTime + +```jsonnet +dashboards.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn dashboards.options.withTargetBlank + +```jsonnet +dashboards.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### obj link + + +#### fn link.new + +```jsonnet +link.new(title, url) +``` + +PARAMETERS: + +* **title** (`string`) +* **url** (`string`) + +Create link to an arbitrary URL. + +#### fn link.withIcon + +```jsonnet +link.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +#### fn link.withTooltip + +```jsonnet +link.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +#### obj link.options + + +##### fn link.options.withAsDropdown + +```jsonnet +link.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +##### fn link.options.withIncludeVars + +```jsonnet +link.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn link.options.withKeepTime + +```jsonnet +link.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn link.options.withTargetBlank + +```jsonnet +link.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/dashboard/variable.md b/gen/grafonnet-v11.0.0/docs/dashboard/variable.md new file mode 100644 index 00000000..d12cdd9c --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/dashboard/variable.md @@ -0,0 +1,1042 @@ +# variable + +Example usage: + +```jsonnet +local g = import 'g.libsonnet'; +local var = g.dashboard.variable; + +local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + +local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + +g.dashboard.new('my dashboard') ++ g.dashboard.withVariables([ + customVar, + queryVar, +]) +``` + + +## Index + +* [`obj adhoc`](#obj-adhoc) + * [`fn new(name, type, uid)`](#fn-adhocnew) + * [`fn newFromDatasourceVariable(name, variable)`](#fn-adhocnewfromdatasourcevariable) + * [`obj generalOptions`](#obj-adhocgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-adhocgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-adhocgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-adhocgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-adhocgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-adhocgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-adhocgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-adhocgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-adhocgeneraloptionsshowondashboardwithvalueonly) +* [`obj constant`](#obj-constant) + * [`fn new(name, value)`](#fn-constantnew) + * [`obj generalOptions`](#obj-constantgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-constantgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-constantgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-constantgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-constantgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-constantgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-constantgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-constantgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-constantgeneraloptionsshowondashboardwithvalueonly) +* [`obj custom`](#obj-custom) + * [`fn new(name, values)`](#fn-customnew) + * [`obj generalOptions`](#obj-customgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-customgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-customgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-customgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-customgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-customgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-customgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-customgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-customgeneraloptionsshowondashboardwithvalueonly) + * [`obj selectionOptions`](#obj-customselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-customselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-customselectionoptionswithmulti) +* [`obj datasource`](#obj-datasource) + * [`fn new(name, type)`](#fn-datasourcenew) + * [`fn withRegex(value)`](#fn-datasourcewithregex) + * [`obj generalOptions`](#obj-datasourcegeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-datasourcegeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-datasourcegeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-datasourcegeneraloptionswithlabel) + * [`fn withName(value)`](#fn-datasourcegeneraloptionswithname) + * [`obj showOnDashboard`](#obj-datasourcegeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-datasourcegeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-datasourcegeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-datasourcegeneraloptionsshowondashboardwithvalueonly) + * [`obj selectionOptions`](#obj-datasourceselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-datasourceselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-datasourceselectionoptionswithmulti) +* [`obj interval`](#obj-interval) + * [`fn new(name, values)`](#fn-intervalnew) + * [`fn withAutoOption(count, minInterval)`](#fn-intervalwithautooption) + * [`obj generalOptions`](#obj-intervalgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-intervalgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-intervalgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-intervalgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-intervalgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-intervalgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-intervalgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-intervalgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-intervalgeneraloptionsshowondashboardwithvalueonly) +* [`obj query`](#obj-query) + * [`fn new(name, query="")`](#fn-querynew) + * [`fn withDatasource(type, uid)`](#fn-querywithdatasource) + * [`fn withDatasourceFromVariable(variable)`](#fn-querywithdatasourcefromvariable) + * [`fn withRegex(value)`](#fn-querywithregex) + * [`fn withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false)`](#fn-querywithsort) + * [`obj generalOptions`](#obj-querygeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-querygeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-querygeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-querygeneraloptionswithlabel) + * [`fn withName(value)`](#fn-querygeneraloptionswithname) + * [`obj showOnDashboard`](#obj-querygeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-querygeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-querygeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-querygeneraloptionsshowondashboardwithvalueonly) + * [`obj queryTypes`](#obj-queryquerytypes) + * [`fn withLabelValues(label, metric="")`](#fn-queryquerytypeswithlabelvalues) + * [`obj refresh`](#obj-queryrefresh) + * [`fn onLoad()`](#fn-queryrefreshonload) + * [`fn onTime()`](#fn-queryrefreshontime) + * [`obj selectionOptions`](#obj-queryselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-queryselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-queryselectionoptionswithmulti) +* [`obj textbox`](#obj-textbox) + * [`fn new(name, default="")`](#fn-textboxnew) + * [`obj generalOptions`](#obj-textboxgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-textboxgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-textboxgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-textboxgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-textboxgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-textboxgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-textboxgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-textboxgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-textboxgeneraloptionsshowondashboardwithvalueonly) + +## Fields + +### obj adhoc + + +#### fn adhoc.new + +```jsonnet +adhoc.new(name, type, uid) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **uid** (`string`) + +`new` creates an adhoc template variable for datasource with `type` and `uid`. +#### fn adhoc.newFromDatasourceVariable + +```jsonnet +adhoc.newFromDatasourceVariable(name, variable) +``` + +PARAMETERS: + +* **name** (`string`) +* **variable** (`object`) + +Same as `new` but selecting the datasource from another template variable. +#### obj adhoc.generalOptions + + +##### fn adhoc.generalOptions.withCurrent + +```jsonnet +adhoc.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn adhoc.generalOptions.withDescription + +```jsonnet +adhoc.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn adhoc.generalOptions.withLabel + +```jsonnet +adhoc.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn adhoc.generalOptions.withName + +```jsonnet +adhoc.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj adhoc.generalOptions.showOnDashboard + + +###### fn adhoc.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +adhoc.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn adhoc.generalOptions.showOnDashboard.withNothing + +```jsonnet +adhoc.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn adhoc.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +adhoc.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj constant + + +#### fn constant.new + +```jsonnet +constant.new(name, value) +``` + +PARAMETERS: + +* **name** (`string`) +* **value** (`string`) + +`new` creates a hidden constant template variable. +#### obj constant.generalOptions + + +##### fn constant.generalOptions.withCurrent + +```jsonnet +constant.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn constant.generalOptions.withDescription + +```jsonnet +constant.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn constant.generalOptions.withLabel + +```jsonnet +constant.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn constant.generalOptions.withName + +```jsonnet +constant.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj constant.generalOptions.showOnDashboard + + +###### fn constant.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +constant.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn constant.generalOptions.showOnDashboard.withNothing + +```jsonnet +constant.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn constant.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +constant.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj custom + + +#### fn custom.new + +```jsonnet +custom.new(name, values) +``` + +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + +`new` creates a custom template variable. + +The `values` array accepts an object with key/value keys, if it's not an object +then it will be added as a string. + +Example: +``` +[ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, +] + +#### obj custom.generalOptions + + +##### fn custom.generalOptions.withCurrent + +```jsonnet +custom.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn custom.generalOptions.withDescription + +```jsonnet +custom.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn custom.generalOptions.withLabel + +```jsonnet +custom.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn custom.generalOptions.withName + +```jsonnet +custom.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj custom.generalOptions.showOnDashboard + + +###### fn custom.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +custom.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn custom.generalOptions.showOnDashboard.withNothing + +```jsonnet +custom.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn custom.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +custom.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj custom.selectionOptions + + +##### fn custom.selectionOptions.withIncludeAll + +```jsonnet +custom.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn custom.selectionOptions.withMulti + +```jsonnet +custom.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj datasource + + +#### fn datasource.new + +```jsonnet +datasource.new(name, type) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) + +`new` creates a datasource template variable. +#### fn datasource.withRegex + +```jsonnet +datasource.withRegex(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`withRegex` filter for which data source instances to choose from in the +variable value list. Example: `/^prod/` + +#### obj datasource.generalOptions + + +##### fn datasource.generalOptions.withCurrent + +```jsonnet +datasource.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn datasource.generalOptions.withDescription + +```jsonnet +datasource.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn datasource.generalOptions.withLabel + +```jsonnet +datasource.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn datasource.generalOptions.withName + +```jsonnet +datasource.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj datasource.generalOptions.showOnDashboard + + +###### fn datasource.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +datasource.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn datasource.generalOptions.showOnDashboard.withNothing + +```jsonnet +datasource.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn datasource.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +datasource.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj datasource.selectionOptions + + +##### fn datasource.selectionOptions.withIncludeAll + +```jsonnet +datasource.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn datasource.selectionOptions.withMulti + +```jsonnet +datasource.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj interval + + +#### fn interval.new + +```jsonnet +interval.new(name, values) +``` + +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + +`new` creates an interval template variable. +#### fn interval.withAutoOption + +```jsonnet +interval.withAutoOption(count, minInterval) +``` + +PARAMETERS: + +* **count** (`number`) +* **minInterval** (`string`) + +`withAutoOption` adds an options to dynamically calculate interval by dividing +time range by the count specified. + +`minInterval' has to be either unit-less or end with one of the following units: +"y, M, w, d, h, m, s, ms". + +#### obj interval.generalOptions + + +##### fn interval.generalOptions.withCurrent + +```jsonnet +interval.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn interval.generalOptions.withDescription + +```jsonnet +interval.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn interval.generalOptions.withLabel + +```jsonnet +interval.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn interval.generalOptions.withName + +```jsonnet +interval.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj interval.generalOptions.showOnDashboard + + +###### fn interval.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +interval.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn interval.generalOptions.showOnDashboard.withNothing + +```jsonnet +interval.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn interval.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +interval.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj query + + +#### fn query.new + +```jsonnet +query.new(name, query="") +``` + +PARAMETERS: + +* **name** (`string`) +* **query** (`string`) + - default value: `""` + +Create a query template variable. + +`query` argument is optional, this can also be set with `query.queryTypes`. + +#### fn query.withDatasource + +```jsonnet +query.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +Select a datasource for the variable template query. +#### fn query.withDatasourceFromVariable + +```jsonnet +query.withDatasourceFromVariable(variable) +``` + +PARAMETERS: + +* **variable** (`object`) + +Select the datasource from another template variable. +#### fn query.withRegex + +```jsonnet +query.withRegex(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`withRegex` can extract part of a series name or metric node segment. Named +capture groups can be used to separate the display text and value +([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + +#### fn query.withSort + +```jsonnet +query.withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false) +``` + +PARAMETERS: + +* **i** (`number`) + - default value: `0` +* **type** (`string`) + - default value: `"alphabetical"` +* **asc** (`bool`) + - default value: `true` +* **caseInsensitive** (`bool`) + - default value: `false` + +Choose how to sort the values in the dropdown. + +This can be called as `withSort() to use the integer values for each +option. If `i==0` then it will be ignored and the other arguments will take +precedence. + +The numerical values are: + +- 1 - Alphabetical (asc) +- 2 - Alphabetical (desc) +- 3 - Numerical (asc) +- 4 - Numerical (desc) +- 5 - Alphabetical (case-insensitive, asc) +- 6 - Alphabetical (case-insensitive, desc) + +#### obj query.generalOptions + + +##### fn query.generalOptions.withCurrent + +```jsonnet +query.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn query.generalOptions.withDescription + +```jsonnet +query.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn query.generalOptions.withLabel + +```jsonnet +query.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn query.generalOptions.withName + +```jsonnet +query.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj query.generalOptions.showOnDashboard + + +###### fn query.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +query.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn query.generalOptions.showOnDashboard.withNothing + +```jsonnet +query.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn query.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +query.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj query.queryTypes + + +##### fn query.queryTypes.withLabelValues + +```jsonnet +query.queryTypes.withLabelValues(label, metric="") +``` + +PARAMETERS: + +* **label** (`string`) +* **metric** (`string`) + - default value: `""` + +Construct a Prometheus template variable using `label_values()`. +#### obj query.refresh + + +##### fn query.refresh.onLoad + +```jsonnet +query.refresh.onLoad() +``` + + +Refresh label values on dashboard load. +##### fn query.refresh.onTime + +```jsonnet +query.refresh.onTime() +``` + + +Refresh label values on time range change. +#### obj query.selectionOptions + + +##### fn query.selectionOptions.withIncludeAll + +```jsonnet +query.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn query.selectionOptions.withMulti + +```jsonnet +query.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj textbox + + +#### fn textbox.new + +```jsonnet +textbox.new(name, default="") +``` + +PARAMETERS: + +* **name** (`string`) +* **default** (`string`) + - default value: `""` + +`new` creates a textbox template variable. +#### obj textbox.generalOptions + + +##### fn textbox.generalOptions.withCurrent + +```jsonnet +textbox.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn textbox.generalOptions.withDescription + +```jsonnet +textbox.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn textbox.generalOptions.withLabel + +```jsonnet +textbox.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn textbox.generalOptions.withName + +```jsonnet +textbox.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj textbox.generalOptions.showOnDashboard + + +###### fn textbox.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +textbox.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn textbox.generalOptions.showOnDashboard.withNothing + +```jsonnet +textbox.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn textbox.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +textbox.generalOptions.showOnDashboard.withValueOnly() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/folder.md b/gen/grafonnet-v11.0.0/docs/folder.md new file mode 100644 index 00000000..ffab0376 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/folder.md @@ -0,0 +1,45 @@ +# folder + +grafonnet.folder + +## Index + +* [`fn withParentUid(value)`](#fn-withparentuid) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withParentUid + +```jsonnet +withParentUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +only used if nested folders are enabled +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder title +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique folder id \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/librarypanel/index.md b/gen/grafonnet-v11.0.0/docs/librarypanel/index.md new file mode 100644 index 00000000..0592b470 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/librarypanel/index.md @@ -0,0 +1,1599 @@ +# librarypanel + +grafonnet.librarypanel + +## Subpackages + +* [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md) +* [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md) +* [model.links](model/links.md) +* [model.transformations](model/transformations.md) + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withMeta(value)`](#fn-withmeta) +* [`fn withMetaMixin(value)`](#fn-withmetamixin) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withSchemaVersion(value)`](#fn-withschemaversion) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVersion(value)`](#fn-withversion) +* [`obj meta`](#obj-meta) + * [`fn withConnectedDashboards(value)`](#fn-metawithconnecteddashboards) + * [`fn withCreated(value)`](#fn-metawithcreated) + * [`fn withCreatedBy(value)`](#fn-metawithcreatedby) + * [`fn withCreatedByMixin(value)`](#fn-metawithcreatedbymixin) + * [`fn withFolderName(value)`](#fn-metawithfoldername) + * [`fn withFolderUid(value)`](#fn-metawithfolderuid) + * [`fn withUpdated(value)`](#fn-metawithupdated) + * [`fn withUpdatedBy(value)`](#fn-metawithupdatedby) + * [`fn withUpdatedByMixin(value)`](#fn-metawithupdatedbymixin) + * [`obj createdBy`](#obj-metacreatedby) + * [`fn withAvatarUrl(value)`](#fn-metacreatedbywithavatarurl) + * [`fn withId(value)`](#fn-metacreatedbywithid) + * [`fn withName(value)`](#fn-metacreatedbywithname) + * [`obj updatedBy`](#obj-metaupdatedby) + * [`fn withAvatarUrl(value)`](#fn-metaupdatedbywithavatarurl) + * [`fn withId(value)`](#fn-metaupdatedbywithid) + * [`fn withName(value)`](#fn-metaupdatedbywithname) +* [`obj model`](#obj-model) + * [`fn withCacheTimeout(value)`](#fn-modelwithcachetimeout) + * [`fn withDatasource(value)`](#fn-modelwithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-modelwithdatasourcemixin) + * [`fn withDescription(value)`](#fn-modelwithdescription) + * [`fn withFieldConfig(value)`](#fn-modelwithfieldconfig) + * [`fn withFieldConfigMixin(value)`](#fn-modelwithfieldconfigmixin) + * [`fn withHideTimeOverride(value=true)`](#fn-modelwithhidetimeoverride) + * [`fn withInterval(value)`](#fn-modelwithinterval) + * [`fn withLinks(value)`](#fn-modelwithlinks) + * [`fn withLinksMixin(value)`](#fn-modelwithlinksmixin) + * [`fn withMaxDataPoints(value)`](#fn-modelwithmaxdatapoints) + * [`fn withMaxPerRow(value)`](#fn-modelwithmaxperrow) + * [`fn withOptions(value)`](#fn-modelwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelwithoptionsmixin) + * [`fn withPluginVersion(value)`](#fn-modelwithpluginversion) + * [`fn withQueryCachingTTL(value)`](#fn-modelwithquerycachingttl) + * [`fn withRepeat(value)`](#fn-modelwithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-modelwithrepeatdirection) + * [`fn withTargets(value)`](#fn-modelwithtargets) + * [`fn withTargetsMixin(value)`](#fn-modelwithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-modelwithtimefrom) + * [`fn withTimeShift(value)`](#fn-modelwithtimeshift) + * [`fn withTitle(value)`](#fn-modelwithtitle) + * [`fn withTransformations(value)`](#fn-modelwithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-modelwithtransformationsmixin) + * [`fn withTransparent(value=true)`](#fn-modelwithtransparent) + * [`fn withType(value)`](#fn-modelwithtype) + * [`obj datasource`](#obj-modeldatasource) + * [`fn withType(value)`](#fn-modeldatasourcewithtype) + * [`fn withUid(value)`](#fn-modeldatasourcewithuid) + * [`obj fieldConfig`](#obj-modelfieldconfig) + * [`fn withDefaults(value)`](#fn-modelfieldconfigwithdefaults) + * [`fn withDefaultsMixin(value)`](#fn-modelfieldconfigwithdefaultsmixin) + * [`fn withOverrides(value)`](#fn-modelfieldconfigwithoverrides) + * [`fn withOverridesMixin(value)`](#fn-modelfieldconfigwithoverridesmixin) + * [`obj defaults`](#obj-modelfieldconfigdefaults) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultswithcolor) + * [`fn withColorMixin(value)`](#fn-modelfieldconfigdefaultswithcolormixin) + * [`fn withCustom(value)`](#fn-modelfieldconfigdefaultswithcustom) + * [`fn withCustomMixin(value)`](#fn-modelfieldconfigdefaultswithcustommixin) + * [`fn withDecimals(value)`](#fn-modelfieldconfigdefaultswithdecimals) + * [`fn withDescription(value)`](#fn-modelfieldconfigdefaultswithdescription) + * [`fn withDisplayName(value)`](#fn-modelfieldconfigdefaultswithdisplayname) + * [`fn withDisplayNameFromDS(value)`](#fn-modelfieldconfigdefaultswithdisplaynamefromds) + * [`fn withFilterable(value=true)`](#fn-modelfieldconfigdefaultswithfilterable) + * [`fn withLinks(value)`](#fn-modelfieldconfigdefaultswithlinks) + * [`fn withLinksMixin(value)`](#fn-modelfieldconfigdefaultswithlinksmixin) + * [`fn withMappings(value)`](#fn-modelfieldconfigdefaultswithmappings) + * [`fn withMappingsMixin(value)`](#fn-modelfieldconfigdefaultswithmappingsmixin) + * [`fn withMax(value)`](#fn-modelfieldconfigdefaultswithmax) + * [`fn withMin(value)`](#fn-modelfieldconfigdefaultswithmin) + * [`fn withNoValue(value)`](#fn-modelfieldconfigdefaultswithnovalue) + * [`fn withPath(value)`](#fn-modelfieldconfigdefaultswithpath) + * [`fn withThresholds(value)`](#fn-modelfieldconfigdefaultswiththresholds) + * [`fn withThresholdsMixin(value)`](#fn-modelfieldconfigdefaultswiththresholdsmixin) + * [`fn withUnit(value)`](#fn-modelfieldconfigdefaultswithunit) + * [`fn withWriteable(value=true)`](#fn-modelfieldconfigdefaultswithwriteable) + * [`obj color`](#obj-modelfieldconfigdefaultscolor) + * [`fn withFixedColor(value)`](#fn-modelfieldconfigdefaultscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-modelfieldconfigdefaultscolorwithseriesby) + * [`obj mappings`](#obj-modelfieldconfigdefaultsmappings) + * [`obj RangeMap`](#obj-modelfieldconfigdefaultsmappingsrangemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsrangemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsrangemapoptions) + * [`fn withFrom(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithto) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsrangemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithtext) + * [`obj RegexMap`](#obj-modelfieldconfigdefaultsmappingsregexmap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsregexmapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsregexmapoptions) + * [`fn withPattern(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsregexmapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithtext) + * [`obj SpecialValueMap`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptions) + * [`fn withMatch(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithtext) + * [`obj ValueMap`](#obj-modelfieldconfigdefaultsmappingsvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithtype) + * [`obj thresholds`](#obj-modelfieldconfigdefaultsthresholds) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultsthresholdswithmode) + * [`fn withSteps(value)`](#fn-modelfieldconfigdefaultsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-modelfieldconfigdefaultsthresholdswithstepsmixin) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder UID +### fn withMeta + +```jsonnet +withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withMetaMixin + +```jsonnet +withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: should be the same panel schema defined in dashboard +Typescript: Omit; +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: should be the same panel schema defined in dashboard +Typescript: Omit; +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel name (also saved in the model) +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Dashboard version when this was saved (zero if unknown) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel type (from inside the model) +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library element UID +### fn withVersion + +```jsonnet +withVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +panel version, incremented each time the dashboard is updated. +### obj meta + + +#### fn meta.withConnectedDashboards + +```jsonnet +meta.withConnectedDashboards(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn meta.withCreated + +```jsonnet +meta.withCreated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withCreatedBy + +```jsonnet +meta.withCreatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withCreatedByMixin + +```jsonnet +meta.withCreatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withFolderName + +```jsonnet +meta.withFolderName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withFolderUid + +```jsonnet +meta.withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdated + +```jsonnet +meta.withUpdated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdatedBy + +```jsonnet +meta.withUpdatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withUpdatedByMixin + +```jsonnet +meta.withUpdatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj meta.createdBy + + +##### fn meta.createdBy.withAvatarUrl + +```jsonnet +meta.createdBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.createdBy.withId + +```jsonnet +meta.createdBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.createdBy.withName + +```jsonnet +meta.createdBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj meta.updatedBy + + +##### fn meta.updatedBy.withAvatarUrl + +```jsonnet +meta.updatedBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.updatedBy.withId + +```jsonnet +meta.updatedBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.updatedBy.withName + +```jsonnet +meta.updatedBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj model + + +#### fn model.withCacheTimeout + +```jsonnet +model.withCacheTimeout(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets panel queries cache timeout. +#### fn model.withDatasource + +```jsonnet +model.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDatasourceMixin + +```jsonnet +model.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDescription + +```jsonnet +model.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn model.withFieldConfig + +```jsonnet +model.withFieldConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withFieldConfigMixin + +```jsonnet +model.withFieldConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withHideTimeOverride + +```jsonnet +model.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn model.withInterval + +```jsonnet +model.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withLinks + +```jsonnet +model.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withLinksMixin + +```jsonnet +model.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withMaxDataPoints + +```jsonnet +model.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn model.withMaxPerRow + +```jsonnet +model.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn model.withOptions + +```jsonnet +model.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withOptionsMixin + +```jsonnet +model.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withPluginVersion + +```jsonnet +model.withPluginVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs. +#### fn model.withQueryCachingTTL + +```jsonnet +model.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn model.withRepeat + +```jsonnet +model.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn model.withRepeatDirection + +```jsonnet +model.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn model.withTargets + +```jsonnet +model.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTargetsMixin + +```jsonnet +model.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTimeFrom + +```jsonnet +model.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTimeShift + +```jsonnet +model.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTitle + +```jsonnet +model.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn model.withTransformations + +```jsonnet +model.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransformationsMixin + +```jsonnet +model.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransparent + +```jsonnet +model.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +#### fn model.withType + +```jsonnet +model.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel plugin type id. This is used to find the plugin to display the panel. +#### obj model.datasource + + +##### fn model.datasource.withType + +```jsonnet +model.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn model.datasource.withUid + +```jsonnet +model.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +#### obj model.fieldConfig + + +##### fn model.fieldConfig.withDefaults + +```jsonnet +model.fieldConfig.withDefaults(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withDefaultsMixin + +```jsonnet +model.fieldConfig.withDefaultsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withOverrides + +```jsonnet +model.fieldConfig.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### fn model.fieldConfig.withOverridesMixin + +```jsonnet +model.fieldConfig.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### obj model.fieldConfig.defaults + + +###### fn model.fieldConfig.defaults.withColor + +```jsonnet +model.fieldConfig.defaults.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withColorMixin + +```jsonnet +model.fieldConfig.defaults.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withCustom + +```jsonnet +model.fieldConfig.defaults.withCustom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withCustomMixin + +```jsonnet +model.fieldConfig.defaults.withCustomMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withDecimals + +```jsonnet +model.fieldConfig.defaults.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +###### fn model.fieldConfig.defaults.withDescription + +```jsonnet +model.fieldConfig.defaults.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Human readable field metadata +###### fn model.fieldConfig.defaults.withDisplayName + +```jsonnet +model.fieldConfig.defaults.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +###### fn model.fieldConfig.defaults.withDisplayNameFromDS + +```jsonnet +model.fieldConfig.defaults.withDisplayNameFromDS(value) +``` + +PARAMETERS: + +* **value** (`string`) + +This can be used by data sources that return and explicit naming structure for values and labels +When this property is configured, this value is used rather than the default naming strategy. +###### fn model.fieldConfig.defaults.withFilterable + +```jsonnet +model.fieldConfig.defaults.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +###### fn model.fieldConfig.defaults.withLinks + +```jsonnet +model.fieldConfig.defaults.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withLinksMixin + +```jsonnet +model.fieldConfig.defaults.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withMappings + +```jsonnet +model.fieldConfig.defaults.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMappingsMixin + +```jsonnet +model.fieldConfig.defaults.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMax + +```jsonnet +model.fieldConfig.defaults.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withMin + +```jsonnet +model.fieldConfig.defaults.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withNoValue + +```jsonnet +model.fieldConfig.defaults.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +###### fn model.fieldConfig.defaults.withPath + +```jsonnet +model.fieldConfig.defaults.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +###### fn model.fieldConfig.defaults.withThresholds + +```jsonnet +model.fieldConfig.defaults.withThresholds(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withThresholdsMixin + +```jsonnet +model.fieldConfig.defaults.withThresholdsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withUnit + +```jsonnet +model.fieldConfig.defaults.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +###### fn model.fieldConfig.defaults.withWriteable + +```jsonnet +model.fieldConfig.defaults.withWriteable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source can write a value to the path. Auth/authz are supported separately +###### obj model.fieldConfig.defaults.color + + +####### fn model.fieldConfig.defaults.color.withFixedColor + +```jsonnet +model.fieldConfig.defaults.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +####### fn model.fieldConfig.defaults.color.withMode + +```jsonnet +model.fieldConfig.defaults.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +####### fn model.fieldConfig.defaults.color.withSeriesBy + +```jsonnet +model.fieldConfig.defaults.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +###### obj model.fieldConfig.defaults.mappings + + +####### obj model.fieldConfig.defaults.mappings.RangeMap + + +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RangeMap.options + + +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withFrom + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withTo + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +######### obj model.fieldConfig.defaults.mappings.RangeMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.RegexMap + + +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RegexMap.options + + +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withPattern + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.RegexMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.SpecialValueMap + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.SpecialValueMap.options + + +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.SpecialValueMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.ValueMap + + +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withType() +``` + + + +###### obj model.fieldConfig.defaults.thresholds + + +####### fn model.fieldConfig.defaults.thresholds.withMode + +```jsonnet +model.fieldConfig.defaults.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +####### fn model.fieldConfig.defaults.thresholds.withSteps + +```jsonnet +model.fieldConfig.defaults.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +####### fn model.fieldConfig.defaults.thresholds.withStepsMixin + +```jsonnet +model.fieldConfig.defaults.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md b/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md new file mode 100644 index 00000000..79d0a171 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md @@ -0,0 +1,34 @@ +# steps + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md b/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md new file mode 100644 index 00000000..35b01d5e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md @@ -0,0 +1,104 @@ +# overrides + + + +## Subpackages + +* [properties](properties.md) + +## Index + +* [`fn withMatcher(value)`](#fn-withmatcher) +* [`fn withMatcherMixin(value)`](#fn-withmatchermixin) +* [`fn withProperties(value)`](#fn-withproperties) +* [`fn withPropertiesMixin(value)`](#fn-withpropertiesmixin) +* [`obj matcher`](#obj-matcher) + * [`fn withId(value="")`](#fn-matcherwithid) + * [`fn withOptions(value)`](#fn-matcherwithoptions) + * [`fn withOptionsMixin(value)`](#fn-matcherwithoptionsmixin) + +## Fields + +### fn withMatcher + +```jsonnet +withMatcher(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withMatcherMixin + +```jsonnet +withMatcherMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withProperties + +```jsonnet +withProperties(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPropertiesMixin + +```jsonnet +withPropertiesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj matcher + + +#### fn matcher.withId + +```jsonnet +matcher.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn matcher.withOptions + +```jsonnet +matcher.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn matcher.withOptionsMixin + +```jsonnet +matcher.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md b/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md new file mode 100644 index 00000000..766e1987 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md @@ -0,0 +1,45 @@ +# properties + + + +## Index + +* [`fn withId(value="")`](#fn-withid) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) + +## Fields + +### fn withId + +```jsonnet +withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + diff --git a/gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md b/gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md new file mode 100644 index 00000000..fcc060a9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md b/gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md new file mode 100644 index 00000000..df55608e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md @@ -0,0 +1,140 @@ +# transformations + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md new file mode 100644 index 00000000..66807e33 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md @@ -0,0 +1,605 @@ +# alertList + +grafonnet.panel.alertList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new alertlist panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/docs/API/panel/alertGroups/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/panelOptions/link.md similarity index 100% rename from docs/API/panel/alertGroups/panelOptions/link.md rename to gen/grafonnet-v11.0.0/docs/panel/alertList/panelOptions/link.md diff --git a/docs/API/panel/alertGroups/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/queryOptions/transformation.md similarity index 80% rename from docs/API/panel/alertGroups/queryOptions/transformation.md rename to gen/grafonnet-v11.0.0/docs/panel/alertList/queryOptions/transformation.md index 17a3d458..69dda9ac 100644 --- a/docs/API/panel/alertGroups/queryOptions/transformation.md +++ b/gen/grafonnet-v11.0.0/docs/panel/alertList/queryOptions/transformation.md @@ -9,10 +9,12 @@ * [`fn withFilterMixin(value)`](#fn-withfiltermixin) * [`fn withId(value)`](#fn-withid) * [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) * [`fn withTopic(value)`](#fn-withtopic) * [`obj filter`](#obj-filter) * [`fn withId(value="")`](#fn-filterwithid) * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) ## Fields @@ -71,7 +73,19 @@ withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) Options to be passed to the transformer Valid options depend on the transformer id @@ -110,6 +124,17 @@ filter.withOptions(value) PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/docs/API/panel/alertGroups/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/mapping.md similarity index 94% rename from docs/API/panel/alertGroups/standardOptions/mapping.md rename to gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/mapping.md index 7f10cedb..196c7692 100644 --- a/docs/API/panel/alertGroups/standardOptions/mapping.md +++ b/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/mapping.md @@ -7,7 +7,7 @@ * [`obj RangeMap`](#obj-rangemap) * [`fn withOptions(value)`](#fn-rangemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) + * [`fn withType()`](#fn-rangemapwithtype) * [`obj options`](#obj-rangemapoptions) * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) * [`fn withResult(value)`](#fn-rangemapoptionswithresult) @@ -21,7 +21,7 @@ * [`obj RegexMap`](#obj-regexmap) * [`fn withOptions(value)`](#fn-regexmapwithoptions) * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) + * [`fn withType()`](#fn-regexmapwithtype) * [`obj options`](#obj-regexmapoptions) * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) * [`fn withResult(value)`](#fn-regexmapoptionswithresult) @@ -34,7 +34,7 @@ * [`obj SpecialValueMap`](#obj-specialvaluemap) * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) + * [`fn withType()`](#fn-specialvaluemapwithtype) * [`obj options`](#obj-specialvaluemapoptions) * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) @@ -47,7 +47,7 @@ * [`obj ValueMap`](#obj-valuemap) * [`fn withOptions(value)`](#fn-valuemapwithoptions) * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) + * [`fn withType()`](#fn-valuemapwithtype) ## Fields @@ -79,12 +79,9 @@ Range to match against and the result to apply when the value is within the rang #### fn RangeMap.withType ```jsonnet -RangeMap.withType(value) +RangeMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RangeMap.options @@ -98,7 +95,7 @@ RangeMap.options.withFrom(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Min value of the range. It can be null which means -Infinity ##### fn RangeMap.options.withResult @@ -131,7 +128,7 @@ RangeMap.options.withTo(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Max value of the range. It can be null which means +Infinity ##### obj RangeMap.options.result @@ -209,12 +206,9 @@ Regular expression to match against and the result to apply when the value match #### fn RegexMap.withType ```jsonnet -RegexMap.withType(value) +RegexMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj RegexMap.options @@ -328,12 +322,9 @@ PARAMETERS: #### fn SpecialValueMap.withType ```jsonnet -SpecialValueMap.withType(value) +SpecialValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) #### obj SpecialValueMap.options @@ -448,10 +439,7 @@ Map with : ValueMappingResult. For example: { "10": { text: "Per #### fn ValueMap.withType ```jsonnet -ValueMap.withType(value) +ValueMap.withType() ``` -PARAMETERS: - -* **value** (`string`) diff --git a/docs/API/panel/alertGroups/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/override.md similarity index 100% rename from docs/API/panel/alertGroups/standardOptions/override.md rename to gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/override.md diff --git a/docs/API/panel/alertGroups/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/threshold/step.md similarity index 95% rename from docs/API/panel/alertGroups/standardOptions/threshold/step.md rename to gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/threshold/step.md index 5212a216..62c49ab0 100644 --- a/docs/API/panel/alertGroups/standardOptions/threshold/step.md +++ b/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/threshold/step.md @@ -28,7 +28,7 @@ withValue(value) PARAMETERS: -* **value** (`null`,`number`) +* **value** (`number`) Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md new file mode 100644 index 00000000..d2471a58 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md @@ -0,0 +1,750 @@ +# annotationsList + +grafonnet.panel.annotationsList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLimit(value=10)`](#fn-optionswithlimit) + * [`fn withNavigateAfter(value="10m")`](#fn-optionswithnavigateafter) + * [`fn withNavigateBefore(value="10m")`](#fn-optionswithnavigatebefore) + * [`fn withNavigateToPanel(value=true)`](#fn-optionswithnavigatetopanel) + * [`fn withOnlyFromThisDashboard(value=true)`](#fn-optionswithonlyfromthisdashboard) + * [`fn withOnlyInTimeRange(value=true)`](#fn-optionswithonlyintimerange) + * [`fn withShowTags(value=true)`](#fn-optionswithshowtags) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withShowUser(value=true)`](#fn-optionswithshowuser) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new annotationsList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLimit + +```jsonnet +options.withLimit(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withNavigateAfter + +```jsonnet +options.withNavigateAfter(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateBefore + +```jsonnet +options.withNavigateBefore(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateToPanel + +```jsonnet +options.withNavigateToPanel(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyFromThisDashboard + +```jsonnet +options.withOnlyFromThisDashboard(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyInTimeRange + +```jsonnet +options.withOnlyInTimeRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTags + +```jsonnet +options.withShowTags(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowUser + +```jsonnet +options.withShowUser(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md new file mode 100644 index 00000000..caf3c7f8 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md @@ -0,0 +1,1386 @@ +# barChart + +grafonnet.panel.barChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBarRadius(value=0)`](#fn-optionswithbarradius) + * [`fn withBarWidth(value=0.97)`](#fn-optionswithbarwidth) + * [`fn withColorByField(value)`](#fn-optionswithcolorbyfield) + * [`fn withFullHighlight(value=true)`](#fn-optionswithfullhighlight) + * [`fn withGroupWidth(value=0.7)`](#fn-optionswithgroupwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withStacking(value)`](#fn-optionswithstacking) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`fn withXTickLabelMaxLength(value)`](#fn-optionswithxticklabelmaxlength) + * [`fn withXTickLabelRotation(value=0)`](#fn-optionswithxticklabelrotation) + * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBarRadius + +```jsonnet +options.withBarRadius(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Controls the radius of each bar. +#### fn options.withBarWidth + +```jsonnet +options.withBarWidth(value=0.97) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.97` + +Controls the width of bars. 1 = Max width, 0 = Min width. +#### fn options.withColorByField + +```jsonnet +options.withColorByField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use the color value for a sibling field to color each bar value. +#### fn options.withFullHighlight + +```jsonnet +options.withFullHighlight(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enables mode which highlights the entire bar area and shows tooltip when cursor +hovers over highlighted area +#### fn options.withGroupWidth + +```jsonnet +options.withGroupWidth(value=0.7) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.7` + +Controls the width of groups. 1 = max with, 0 = min width. +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withStacking + +```jsonnet +options.withStacking(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Manually select which field from the dataset to represent the x field. +#### fn options.withXTickLabelMaxLength + +```jsonnet +options.withXTickLabelMaxLength(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Sets the max length that a label can have before it is truncated. +#### fn options.withXTickLabelRotation + +```jsonnet +options.withXTickLabelRotation(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the rotation of the x axis labels. +#### fn options.withXTickLabelSpacing + +```jsonnet +options.withXTickLabelSpacing(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the spacing between x axis labels. +negative values indicate backwards skipping behavior +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md new file mode 100644 index 00000000..109cf349 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md @@ -0,0 +1,868 @@ +# barGauge + +grafonnet.panel.barGauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayMode(value)`](#fn-optionswithdisplaymode) + * [`fn withMaxVizHeight(value=300)`](#fn-optionswithmaxvizheight) + * [`fn withMinVizHeight(value=16)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=8)`](#fn-optionswithminvizwidth) + * [`fn withNamePlacement(value)`](#fn-optionswithnameplacement) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled) + * [`fn withSizing(value)`](#fn-optionswithsizing) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withValueMode(value)`](#fn-optionswithvaluemode) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barGauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayMode + +```jsonnet +options.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +#### fn options.withMaxVizHeight + +```jsonnet +options.withMaxVizHeight(value=300) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `300` + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=16) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `16` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=8) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `8` + + +#### fn options.withNamePlacement + +```jsonnet +options.withNamePlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"left"` + +Allows for the bar gauge name to be placed explicitly +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowUnfilled + +```jsonnet +options.withShowUnfilled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSizing + +```jsonnet +options.withSizing(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Allows for the bar gauge size to be set explicitly +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withValueMode + +```jsonnet +options.withValueMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md new file mode 100644 index 00000000..ab1accee --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md @@ -0,0 +1,1691 @@ +# candlestick + +grafonnet.panel.candlestick + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCandleStyle(value)`](#fn-optionswithcandlestyle) + * [`fn withColorStrategy(value)`](#fn-optionswithcolorstrategy) + * [`fn withColors(value)`](#fn-optionswithcolors) + * [`fn withColorsMixin(value)`](#fn-optionswithcolorsmixin) + * [`fn withFields(value)`](#fn-optionswithfields) + * [`fn withFieldsMixin(value)`](#fn-optionswithfieldsmixin) + * [`fn withIncludeAllFields(value=true)`](#fn-optionswithincludeallfields) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj colors`](#obj-optionscolors) + * [`fn withDown(value="red")`](#fn-optionscolorswithdown) + * [`fn withFlat(value="gray")`](#fn-optionscolorswithflat) + * [`fn withUp(value="green")`](#fn-optionscolorswithup) + * [`obj fields`](#obj-optionsfields) + * [`fn withClose(value)`](#fn-optionsfieldswithclose) + * [`fn withHigh(value)`](#fn-optionsfieldswithhigh) + * [`fn withLow(value)`](#fn-optionsfieldswithlow) + * [`fn withOpen(value)`](#fn-optionsfieldswithopen) + * [`fn withVolume(value)`](#fn-optionsfieldswithvolume) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new candlestick panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCandleStyle + +```jsonnet +options.withCandleStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"candles"`, `"ohlcbars"` + + +#### fn options.withColorStrategy + +```jsonnet +options.withColorStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"open-close"`, `"close-close"` + + +#### fn options.withColors + +```jsonnet +options.withColors(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withColorsMixin + +```jsonnet +options.withColorsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withFields + +```jsonnet +options.withFields(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withFieldsMixin + +```jsonnet +options.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withIncludeAllFields + +```jsonnet +options.withIncludeAllFields(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled, all fields will be sent to the graph +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"candles+volume"`, `"candles"`, `"volume"` + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.colors + + +##### fn options.colors.withDown + +```jsonnet +options.colors.withDown(value="red") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"red"` + + +##### fn options.colors.withFlat + +```jsonnet +options.colors.withFlat(value="gray") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"gray"` + + +##### fn options.colors.withUp + +```jsonnet +options.colors.withUp(value="green") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"green"` + + +#### obj options.fields + + +##### fn options.fields.withClose + +```jsonnet +options.fields.withClose(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the final (end) value of the given period +##### fn options.fields.withHigh + +```jsonnet +options.fields.withHigh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the highest value of the given period +##### fn options.fields.withLow + +```jsonnet +options.fields.withLow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the lowest value of the given period +##### fn options.fields.withOpen + +```jsonnet +options.fields.withOpen(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the starting value of the given period +##### fn options.fields.withVolume + +```jsonnet +options.fields.withVolume(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the sample count in the given period. (e.g. number of trades) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md new file mode 100644 index 00000000..5d8a9652 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md @@ -0,0 +1,737 @@ +# canvas + +grafonnet.panel.canvas + +## Subpackages + +* [options.root.elements](options/root/elements/index.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withInfinitePan(value=true)`](#fn-optionswithinfinitepan) + * [`fn withInlineEditing(value=true)`](#fn-optionswithinlineediting) + * [`fn withPanZoom(value=true)`](#fn-optionswithpanzoom) + * [`fn withRoot(value)`](#fn-optionswithroot) + * [`fn withRootMixin(value)`](#fn-optionswithrootmixin) + * [`fn withShowAdvancedTypes(value=true)`](#fn-optionswithshowadvancedtypes) + * [`obj root`](#obj-optionsroot) + * [`fn withElements(value)`](#fn-optionsrootwithelements) + * [`fn withElementsMixin(value)`](#fn-optionsrootwithelementsmixin) + * [`fn withName(value)`](#fn-optionsrootwithname) + * [`fn withType()`](#fn-optionsrootwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new canvas panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withInfinitePan + +```jsonnet +options.withInfinitePan(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable infinite pan +#### fn options.withInlineEditing + +```jsonnet +options.withInlineEditing(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable inline editing +#### fn options.withPanZoom + +```jsonnet +options.withPanZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable pan and zoom +#### fn options.withRoot + +```jsonnet +options.withRoot(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withRootMixin + +```jsonnet +options.withRootMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withShowAdvancedTypes + +```jsonnet +options.withShowAdvancedTypes(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show all available element types +#### obj options.root + + +##### fn options.root.withElements + +```jsonnet +options.root.withElements(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withElementsMixin + +```jsonnet +options.root.withElementsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withName + +```jsonnet +options.root.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the root element +##### fn options.root.withType + +```jsonnet +options.root.withType() +``` + + +Type of root element (frame) +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md new file mode 100644 index 00000000..f1571587 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md @@ -0,0 +1,410 @@ +# connections + + + +## Subpackages + +* [vertices](vertices.md) + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withColorMixin(value)`](#fn-withcolormixin) +* [`fn withPath(value)`](#fn-withpath) +* [`fn withSize(value)`](#fn-withsize) +* [`fn withSizeMixin(value)`](#fn-withsizemixin) +* [`fn withSource(value)`](#fn-withsource) +* [`fn withSourceMixin(value)`](#fn-withsourcemixin) +* [`fn withSourceOriginal(value)`](#fn-withsourceoriginal) +* [`fn withSourceOriginalMixin(value)`](#fn-withsourceoriginalmixin) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withTargetName(value)`](#fn-withtargetname) +* [`fn withTargetOriginal(value)`](#fn-withtargetoriginal) +* [`fn withTargetOriginalMixin(value)`](#fn-withtargetoriginalmixin) +* [`fn withVertices(value)`](#fn-withvertices) +* [`fn withVerticesMixin(value)`](#fn-withverticesmixin) +* [`obj color`](#obj-color) + * [`fn withField(value)`](#fn-colorwithfield) + * [`fn withFixed(value)`](#fn-colorwithfixed) +* [`obj size`](#obj-size) + * [`fn withField(value)`](#fn-sizewithfield) + * [`fn withFixed(value)`](#fn-sizewithfixed) + * [`fn withMax(value)`](#fn-sizewithmax) + * [`fn withMin(value)`](#fn-sizewithmin) + * [`fn withMode(value)`](#fn-sizewithmode) +* [`obj source`](#obj-source) + * [`fn withX(value)`](#fn-sourcewithx) + * [`fn withY(value)`](#fn-sourcewithy) +* [`obj sourceOriginal`](#obj-sourceoriginal) + * [`fn withX(value)`](#fn-sourceoriginalwithx) + * [`fn withY(value)`](#fn-sourceoriginalwithy) +* [`obj target`](#obj-target) + * [`fn withX(value)`](#fn-targetwithx) + * [`fn withY(value)`](#fn-targetwithy) +* [`obj targetOriginal`](#obj-targetoriginal) + * [`fn withX(value)`](#fn-targetoriginalwithx) + * [`fn withY(value)`](#fn-targetoriginalwithy) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withColorMixin + +```jsonnet +withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPath + +```jsonnet +withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"straight"` + + +### fn withSize + +```jsonnet +withSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSizeMixin + +```jsonnet +withSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSource + +```jsonnet +withSource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceMixin + +```jsonnet +withSourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginal + +```jsonnet +withSourceOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginalMixin + +```jsonnet +withSourceOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetName + +```jsonnet +withTargetName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTargetOriginal + +```jsonnet +withTargetOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetOriginalMixin + +```jsonnet +withTargetOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withVertices + +```jsonnet +withVertices(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withVerticesMixin + +```jsonnet +withVerticesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj color + + +#### fn color.withField + +```jsonnet +color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn color.withFixed + +```jsonnet +color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj size + + +#### fn size.withField + +```jsonnet +size.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn size.withFixed + +```jsonnet +size.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMax + +```jsonnet +size.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMin + +```jsonnet +size.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMode + +```jsonnet +size.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +### obj source + + +#### fn source.withX + +```jsonnet +source.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn source.withY + +```jsonnet +source.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj sourceOriginal + + +#### fn sourceOriginal.withX + +```jsonnet +sourceOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn sourceOriginal.withY + +```jsonnet +sourceOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj target + + +#### fn target.withX + +```jsonnet +target.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn target.withY + +```jsonnet +target.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj targetOriginal + + +#### fn targetOriginal.withX + +```jsonnet +targetOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn targetOriginal.withY + +```jsonnet +targetOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md new file mode 100644 index 00000000..70f44a38 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md @@ -0,0 +1,32 @@ +# vertices + + + +## Index + +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) + +## Fields + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md new file mode 100644 index 00000000..73f5b6ea --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md @@ -0,0 +1,512 @@ +# elements + + + +## Subpackages + +* [connections](connections/index.md) + +## Index + +* [`fn withBackground(value)`](#fn-withbackground) +* [`fn withBackgroundMixin(value)`](#fn-withbackgroundmixin) +* [`fn withBorder(value)`](#fn-withborder) +* [`fn withBorderMixin(value)`](#fn-withbordermixin) +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withConnections(value)`](#fn-withconnections) +* [`fn withConnectionsMixin(value)`](#fn-withconnectionsmixin) +* [`fn withConstraint(value)`](#fn-withconstraint) +* [`fn withConstraintMixin(value)`](#fn-withconstraintmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withPlacement(value)`](#fn-withplacement) +* [`fn withPlacementMixin(value)`](#fn-withplacementmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj background`](#obj-background) + * [`fn withColor(value)`](#fn-backgroundwithcolor) + * [`fn withColorMixin(value)`](#fn-backgroundwithcolormixin) + * [`fn withImage(value)`](#fn-backgroundwithimage) + * [`fn withImageMixin(value)`](#fn-backgroundwithimagemixin) + * [`fn withSize(value)`](#fn-backgroundwithsize) + * [`obj color`](#obj-backgroundcolor) + * [`fn withField(value)`](#fn-backgroundcolorwithfield) + * [`fn withFixed(value)`](#fn-backgroundcolorwithfixed) + * [`obj image`](#obj-backgroundimage) + * [`fn withField(value)`](#fn-backgroundimagewithfield) + * [`fn withFixed(value)`](#fn-backgroundimagewithfixed) + * [`fn withMode(value)`](#fn-backgroundimagewithmode) +* [`obj border`](#obj-border) + * [`fn withColor(value)`](#fn-borderwithcolor) + * [`fn withColorMixin(value)`](#fn-borderwithcolormixin) + * [`fn withRadius(value)`](#fn-borderwithradius) + * [`fn withWidth(value)`](#fn-borderwithwidth) + * [`obj color`](#obj-bordercolor) + * [`fn withField(value)`](#fn-bordercolorwithfield) + * [`fn withFixed(value)`](#fn-bordercolorwithfixed) +* [`obj constraint`](#obj-constraint) + * [`fn withHorizontal(value)`](#fn-constraintwithhorizontal) + * [`fn withVertical(value)`](#fn-constraintwithvertical) +* [`obj placement`](#obj-placement) + * [`fn withBottom(value)`](#fn-placementwithbottom) + * [`fn withHeight(value)`](#fn-placementwithheight) + * [`fn withLeft(value)`](#fn-placementwithleft) + * [`fn withRight(value)`](#fn-placementwithright) + * [`fn withRotation(value)`](#fn-placementwithrotation) + * [`fn withTop(value)`](#fn-placementwithtop) + * [`fn withWidth(value)`](#fn-placementwithwidth) + +## Fields + +### fn withBackground + +```jsonnet +withBackground(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBackgroundMixin + +```jsonnet +withBackgroundMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorder + +```jsonnet +withBorder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorderMixin + +```jsonnet +withBorderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConnections + +```jsonnet +withConnections(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConnectionsMixin + +```jsonnet +withConnectionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConstraint + +```jsonnet +withConstraint(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConstraintMixin + +```jsonnet +withConstraintMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPlacement + +```jsonnet +withPlacement(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPlacementMixin + +```jsonnet +withPlacementMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj background + + +#### fn background.withColor + +```jsonnet +background.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withColorMixin + +```jsonnet +background.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withImage + +```jsonnet +background.withImage(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withImageMixin + +```jsonnet +background.withImageMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withSize + +```jsonnet +background.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"original"`, `"contain"`, `"cover"`, `"fill"`, `"tile"` + + +#### obj background.color + + +##### fn background.color.withField + +```jsonnet +background.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.color.withFixed + +```jsonnet +background.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +#### obj background.image + + +##### fn background.image.withField + +```jsonnet +background.image.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.image.withFixed + +```jsonnet +background.image.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn background.image.withMode + +```jsonnet +background.image.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"mapping"` + + +### obj border + + +#### fn border.withColor + +```jsonnet +border.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withColorMixin + +```jsonnet +border.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withRadius + +```jsonnet +border.withRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn border.withWidth + +```jsonnet +border.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj border.color + + +##### fn border.color.withField + +```jsonnet +border.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn border.color.withFixed + +```jsonnet +border.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj constraint + + +#### fn constraint.withHorizontal + +```jsonnet +constraint.withHorizontal(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"left"`, `"right"`, `"leftright"`, `"center"`, `"scale"` + + +#### fn constraint.withVertical + +```jsonnet +constraint.withVertical(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"top"`, `"bottom"`, `"topbottom"`, `"center"`, `"scale"` + + +### obj placement + + +#### fn placement.withBottom + +```jsonnet +placement.withBottom(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withHeight + +```jsonnet +placement.withHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withLeft + +```jsonnet +placement.withLeft(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRight + +```jsonnet +placement.withRight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRotation + +```jsonnet +placement.withRotation(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withTop + +```jsonnet +placement.withTop(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withWidth + +```jsonnet +placement.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md new file mode 100644 index 00000000..a5139210 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md @@ -0,0 +1,761 @@ +# dashboardList + +grafonnet.panel.dashboardList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFolderId(value)`](#fn-optionswithfolderid) + * [`fn withFolderUID(value)`](#fn-optionswithfolderuid) + * [`fn withIncludeVars(value=true)`](#fn-optionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) + * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) + * [`fn withQuery(value="")`](#fn-optionswithquery) + * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) + * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) + * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) + * [`fn withShowStarred(value=true)`](#fn-optionswithshowstarred) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboardList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFolderId + +```jsonnet +options.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +folderId is deprecated, and migrated to folderUid on panel init +#### fn options.withFolderUID + +```jsonnet +options.withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn options.withIncludeVars + +```jsonnet +options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withKeepTime + +```jsonnet +options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withMaxItems + +```jsonnet +options.withMaxItems(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withQuery + +```jsonnet +options.withQuery(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +#### fn options.withShowHeadings + +```jsonnet +options.withShowHeadings(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowRecentlyViewed + +```jsonnet +options.withShowRecentlyViewed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowSearch + +```jsonnet +options.withShowSearch(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowStarred + +```jsonnet +options.withShowStarred(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md new file mode 100644 index 00000000..85b34082 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md @@ -0,0 +1,622 @@ +# datagrid + +grafonnet.panel.datagrid + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withSelectedSeries(value=0)`](#fn-optionswithselectedseries) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new datagrid panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withSelectedSeries + +```jsonnet +options.withSelectedSeries(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/index.md b/gen/grafonnet-v11.0.0/docs/panel/debug/index.md new file mode 100644 index 00000000..25d472c5 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/index.md @@ -0,0 +1,689 @@ +# debug + +grafonnet.panel.debug + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCounters(value)`](#fn-optionswithcounters) + * [`fn withCountersMixin(value)`](#fn-optionswithcountersmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj counters`](#obj-optionscounters) + * [`fn withDataChanged(value=true)`](#fn-optionscounterswithdatachanged) + * [`fn withRender(value=true)`](#fn-optionscounterswithrender) + * [`fn withSchemaChanged(value=true)`](#fn-optionscounterswithschemachanged) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new debug panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCounters + +```jsonnet +options.withCounters(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCountersMixin + +```jsonnet +options.withCountersMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"render"`, `"events"`, `"cursor"`, `"State"`, `"ThrowError"` + + +#### obj options.counters + + +##### fn options.counters.withDataChanged + +```jsonnet +options.counters.withDataChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withRender + +```jsonnet +options.counters.withRender(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withSchemaChanged + +```jsonnet +options.counters.withSchemaChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md new file mode 100644 index 00000000..2781e4ff --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md @@ -0,0 +1,828 @@ +# gauge + +grafonnet.panel.gauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withMinVizHeight(value=75)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=75)`](#fn-optionswithminvizwidth) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowThresholdLabels(value=true)`](#fn-optionswithshowthresholdlabels) + * [`fn withShowThresholdMarkers(value=true)`](#fn-optionswithshowthresholdmarkers) + * [`fn withSizing(value)`](#fn-optionswithsizing) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new gauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowThresholdLabels + +```jsonnet +options.withShowThresholdLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowThresholdMarkers + +```jsonnet +options.withShowThresholdMarkers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSizing + +```jsonnet +options.withSizing(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Allows for the bar gauge size to be set explicitly +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md new file mode 100644 index 00000000..c1a2e05e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md @@ -0,0 +1,1188 @@ +# geomap + +grafonnet.panel.geomap + +## Subpackages + +* [options.layers](options/layers.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBasemap(value)`](#fn-optionswithbasemap) + * [`fn withBasemapMixin(value)`](#fn-optionswithbasemapmixin) + * [`fn withControls(value)`](#fn-optionswithcontrols) + * [`fn withControlsMixin(value)`](#fn-optionswithcontrolsmixin) + * [`fn withLayers(value)`](#fn-optionswithlayers) + * [`fn withLayersMixin(value)`](#fn-optionswithlayersmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withView(value)`](#fn-optionswithview) + * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) + * [`obj basemap`](#obj-optionsbasemap) + * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) + * [`fn withConfigMixin(value)`](#fn-optionsbasemapwithconfigmixin) + * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) + * [`fn withFilterDataMixin(value)`](#fn-optionsbasemapwithfilterdatamixin) + * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) + * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) + * [`fn withName(value)`](#fn-optionsbasemapwithname) + * [`fn withOpacity(value)`](#fn-optionsbasemapwithopacity) + * [`fn withTooltip(value=true)`](#fn-optionsbasemapwithtooltip) + * [`fn withType(value)`](#fn-optionsbasemapwithtype) + * [`obj location`](#obj-optionsbasemaplocation) + * [`fn withGazetteer(value)`](#fn-optionsbasemaplocationwithgazetteer) + * [`fn withGeohash(value)`](#fn-optionsbasemaplocationwithgeohash) + * [`fn withLatitude(value)`](#fn-optionsbasemaplocationwithlatitude) + * [`fn withLongitude(value)`](#fn-optionsbasemaplocationwithlongitude) + * [`fn withLookup(value)`](#fn-optionsbasemaplocationwithlookup) + * [`fn withMode(value)`](#fn-optionsbasemaplocationwithmode) + * [`fn withWkt(value)`](#fn-optionsbasemaplocationwithwkt) + * [`obj controls`](#obj-optionscontrols) + * [`fn withMouseWheelZoom(value=true)`](#fn-optionscontrolswithmousewheelzoom) + * [`fn withShowAttribution(value=true)`](#fn-optionscontrolswithshowattribution) + * [`fn withShowDebug(value=true)`](#fn-optionscontrolswithshowdebug) + * [`fn withShowMeasure(value=true)`](#fn-optionscontrolswithshowmeasure) + * [`fn withShowScale(value=true)`](#fn-optionscontrolswithshowscale) + * [`fn withShowZoom(value=true)`](#fn-optionscontrolswithshowzoom) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`obj view`](#obj-optionsview) + * [`fn withAllLayers(value=true)`](#fn-optionsviewwithalllayers) + * [`fn withId(value="zero")`](#fn-optionsviewwithid) + * [`fn withLastOnly(value=true)`](#fn-optionsviewwithlastonly) + * [`fn withLat(value=0)`](#fn-optionsviewwithlat) + * [`fn withLayer(value)`](#fn-optionsviewwithlayer) + * [`fn withLon(value=0)`](#fn-optionsviewwithlon) + * [`fn withMaxZoom(value)`](#fn-optionsviewwithmaxzoom) + * [`fn withMinZoom(value)`](#fn-optionsviewwithminzoom) + * [`fn withPadding(value)`](#fn-optionsviewwithpadding) + * [`fn withShared(value=true)`](#fn-optionsviewwithshared) + * [`fn withZoom(value=1)`](#fn-optionsviewwithzoom) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new geomap panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBasemap + +```jsonnet +options.withBasemap(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withBasemapMixin + +```jsonnet +options.withBasemapMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControls + +```jsonnet +options.withControls(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControlsMixin + +```jsonnet +options.withControlsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLayers + +```jsonnet +options.withLayers(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLayersMixin + +```jsonnet +options.withLayersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withView + +```jsonnet +options.withView(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withViewMixin + +```jsonnet +options.withViewMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.basemap + + +##### fn options.basemap.withConfig + +```jsonnet +options.basemap.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withConfigMixin + +```jsonnet +options.basemap.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withFilterData + +```jsonnet +options.basemap.withFilterData(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withFilterDataMixin + +```jsonnet +options.basemap.withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withLocation + +```jsonnet +options.basemap.withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.basemap.withLocationMixin + +```jsonnet +options.basemap.withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.basemap.withName + +```jsonnet +options.basemap.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +##### fn options.basemap.withOpacity + +```jsonnet +options.basemap.withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +##### fn options.basemap.withTooltip + +```jsonnet +options.basemap.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +##### fn options.basemap.withType + +```jsonnet +options.basemap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.basemap.location + + +###### fn options.basemap.location.withGazetteer + +```jsonnet +options.basemap.location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +###### fn options.basemap.location.withGeohash + +```jsonnet +options.basemap.location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +###### fn options.basemap.location.withLatitude + +```jsonnet +options.basemap.location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLongitude + +```jsonnet +options.basemap.location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLookup + +```jsonnet +options.basemap.location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withMode + +```jsonnet +options.basemap.location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +###### fn options.basemap.location.withWkt + +```jsonnet +options.basemap.location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.controls + + +##### fn options.controls.withMouseWheelZoom + +```jsonnet +options.controls.withMouseWheelZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +let the mouse wheel zoom +##### fn options.controls.withShowAttribution + +```jsonnet +options.controls.withShowAttribution(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Lower right +##### fn options.controls.withShowDebug + +```jsonnet +options.controls.withShowDebug(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show debug +##### fn options.controls.withShowMeasure + +```jsonnet +options.controls.withShowMeasure(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show measure +##### fn options.controls.withShowScale + +```jsonnet +options.controls.withShowScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Scale options +##### fn options.controls.withShowZoom + +```jsonnet +options.controls.withShowZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Zoom (upper left) +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"details"` + + +#### obj options.view + + +##### fn options.view.withAllLayers + +```jsonnet +options.view.withAllLayers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withId + +```jsonnet +options.view.withId(value="zero") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"zero"` + + +##### fn options.view.withLastOnly + +```jsonnet +options.view.withLastOnly(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withLat + +```jsonnet +options.view.withLat(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withLayer + +```jsonnet +options.view.withLayer(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.view.withLon + +```jsonnet +options.view.withLon(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withMaxZoom + +```jsonnet +options.view.withMaxZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withMinZoom + +```jsonnet +options.view.withMinZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withPadding + +```jsonnet +options.view.withPadding(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withShared + +```jsonnet +options.view.withShared(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withZoom + +```jsonnet +options.view.withZoom(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md new file mode 100644 index 00000000..cf4881df --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md @@ -0,0 +1,220 @@ +# layers + + + +## Index + +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withFilterData(value)`](#fn-withfilterdata) +* [`fn withFilterDataMixin(value)`](#fn-withfilterdatamixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withLocationMixin(value)`](#fn-withlocationmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOpacity(value)`](#fn-withopacity) +* [`fn withTooltip(value=true)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`obj location`](#obj-location) + * [`fn withGazetteer(value)`](#fn-locationwithgazetteer) + * [`fn withGeohash(value)`](#fn-locationwithgeohash) + * [`fn withLatitude(value)`](#fn-locationwithlatitude) + * [`fn withLongitude(value)`](#fn-locationwithlongitude) + * [`fn withLookup(value)`](#fn-locationwithlookup) + * [`fn withMode(value)`](#fn-locationwithmode) + * [`fn withWkt(value)`](#fn-locationwithwkt) + +## Fields + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +### fn withFilterData + +```jsonnet +withFilterData(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withFilterDataMixin + +```jsonnet +withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLocationMixin + +```jsonnet +withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +### fn withOpacity + +```jsonnet +withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +### fn withTooltip + +```jsonnet +withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj location + + +#### fn location.withGazetteer + +```jsonnet +location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +#### fn location.withGeohash + +```jsonnet +location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +#### fn location.withLatitude + +```jsonnet +location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLongitude + +```jsonnet +location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLookup + +```jsonnet +location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withMode + +```jsonnet +location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +#### fn location.withWkt + +```jsonnet +location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md new file mode 100644 index 00000000..336c823d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md @@ -0,0 +1,1803 @@ +# heatmap + +grafonnet.panel.heatmap + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCalculate(value=true)`](#fn-optionswithcalculate) + * [`fn withCalculation(value)`](#fn-optionswithcalculation) + * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) + * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) + * [`fn withCellRadius(value)`](#fn-optionswithcellradius) + * [`fn withCellValues(value)`](#fn-optionswithcellvalues) + * [`fn withCellValuesMixin(value)`](#fn-optionswithcellvaluesmixin) + * [`fn withColor(value)`](#fn-optionswithcolor) + * [`fn withColorMixin(value)`](#fn-optionswithcolormixin) + * [`fn withExemplars(value)`](#fn-optionswithexemplars) + * [`fn withExemplarsMixin(value)`](#fn-optionswithexemplarsmixin) + * [`fn withFilterValues(value)`](#fn-optionswithfiltervalues) + * [`fn withFilterValuesMixin(value)`](#fn-optionswithfiltervaluesmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) + * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withYAxis(value)`](#fn-optionswithyaxis) + * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) + * [`obj calculation`](#obj-optionscalculation) + * [`fn withXBuckets(value)`](#fn-optionscalculationwithxbuckets) + * [`fn withXBucketsMixin(value)`](#fn-optionscalculationwithxbucketsmixin) + * [`fn withYBuckets(value)`](#fn-optionscalculationwithybuckets) + * [`fn withYBucketsMixin(value)`](#fn-optionscalculationwithybucketsmixin) + * [`obj xBuckets`](#obj-optionscalculationxbuckets) + * [`fn withMode(value)`](#fn-optionscalculationxbucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationxbucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationxbucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationxbucketswithvalue) + * [`obj scale`](#obj-optionscalculationxbucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationxbucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationxbucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationxbucketsscalewithtype) + * [`obj yBuckets`](#obj-optionscalculationybuckets) + * [`fn withMode(value)`](#fn-optionscalculationybucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationybucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationybucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationybucketswithvalue) + * [`obj scale`](#obj-optionscalculationybucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationybucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) + * [`obj cellValues`](#obj-optionscellvalues) + * [`fn withDecimals(value)`](#fn-optionscellvalueswithdecimals) + * [`fn withUnit(value)`](#fn-optionscellvalueswithunit) + * [`obj color`](#obj-optionscolor) + * [`fn withExponent(value)`](#fn-optionscolorwithexponent) + * [`fn withFill(value)`](#fn-optionscolorwithfill) + * [`fn withMax(value)`](#fn-optionscolorwithmax) + * [`fn withMin(value)`](#fn-optionscolorwithmin) + * [`fn withMode(value)`](#fn-optionscolorwithmode) + * [`fn withReverse(value=true)`](#fn-optionscolorwithreverse) + * [`fn withScale(value)`](#fn-optionscolorwithscale) + * [`fn withScheme(value)`](#fn-optionscolorwithscheme) + * [`fn withSteps(value)`](#fn-optionscolorwithsteps) + * [`obj exemplars`](#obj-optionsexemplars) + * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) + * [`obj filterValues`](#obj-optionsfiltervalues) + * [`fn withGe(value)`](#fn-optionsfiltervalueswithge) + * [`fn withLe(value)`](#fn-optionsfiltervalueswithle) + * [`obj legend`](#obj-optionslegend) + * [`fn withShow(value=true)`](#fn-optionslegendwithshow) + * [`obj rowsFrame`](#obj-optionsrowsframe) + * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) + * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withShowColorScale(value=true)`](#fn-optionstooltipwithshowcolorscale) + * [`fn withYHistogram(value=true)`](#fn-optionstooltipwithyhistogram) + * [`obj yAxis`](#obj-optionsyaxis) + * [`fn withAxisBorderShow(value=true)`](#fn-optionsyaxiswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-optionsyaxiswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-optionsyaxiswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-optionsyaxiswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-optionsyaxiswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-optionsyaxiswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-optionsyaxiswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-optionsyaxiswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-optionsyaxiswithaxiswidth) + * [`fn withDecimals(value)`](#fn-optionsyaxiswithdecimals) + * [`fn withMax(value)`](#fn-optionsyaxiswithmax) + * [`fn withMin(value)`](#fn-optionsyaxiswithmin) + * [`fn withReverse(value=true)`](#fn-optionsyaxiswithreverse) + * [`fn withScaleDistribution(value)`](#fn-optionsyaxiswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-optionsyaxiswithscaledistributionmixin) + * [`fn withUnit(value)`](#fn-optionsyaxiswithunit) + * [`obj scaleDistribution`](#obj-optionsyaxisscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-optionsyaxisscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-optionsyaxisscaledistributionwithlog) + * [`fn withType(value)`](#fn-optionsyaxisscaledistributionwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new heatmap panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCalculate + +```jsonnet +options.withCalculate(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the heatmap should be calculated from data +#### fn options.withCalculation + +```jsonnet +options.withCalculation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCalculationMixin + +```jsonnet +options.withCalculationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCellGap + +```jsonnet +options.withCellGap(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls gap between cells +#### fn options.withCellRadius + +```jsonnet +options.withCellRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls cell radius +#### fn options.withCellValues + +```jsonnet +options.withCellValues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +#### fn options.withCellValuesMixin + +```jsonnet +options.withCellValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +#### fn options.withColor + +```jsonnet +options.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls various color options +#### fn options.withColorMixin + +```jsonnet +options.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls various color options +#### fn options.withExemplars + +```jsonnet +options.withExemplars(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls exemplar options +#### fn options.withExemplarsMixin + +```jsonnet +options.withExemplarsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls exemplar options +#### fn options.withFilterValues + +```jsonnet +options.withFilterValues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls the value filter range +#### fn options.withFilterValuesMixin + +```jsonnet +options.withFilterValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls the value filter range +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls legend options +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls legend options +#### fn options.withRowsFrame + +```jsonnet +options.withRowsFrame(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withRowsFrameMixin + +```jsonnet +options.withRowsFrameMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withYAxis + +```jsonnet +options.withYAxis(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### fn options.withYAxisMixin + +```jsonnet +options.withYAxisMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### obj options.calculation + + +##### fn options.calculation.withXBuckets + +```jsonnet +options.calculation.withXBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withXBucketsMixin + +```jsonnet +options.calculation.withXBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withYBuckets + +```jsonnet +options.calculation.withYBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withYBucketsMixin + +```jsonnet +options.calculation.withYBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### obj options.calculation.xBuckets + + +###### fn options.calculation.xBuckets.withMode + +```jsonnet +options.calculation.xBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + + +###### fn options.calculation.xBuckets.withScale + +```jsonnet +options.calculation.xBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withScaleMixin + +```jsonnet +options.calculation.xBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withValue + +```jsonnet +options.calculation.xBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.xBuckets.scale + + +####### fn options.calculation.xBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.xBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withLog + +```jsonnet +options.calculation.xBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withType + +```jsonnet +options.calculation.xBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +##### obj options.calculation.yBuckets + + +###### fn options.calculation.yBuckets.withMode + +```jsonnet +options.calculation.yBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + + +###### fn options.calculation.yBuckets.withScale + +```jsonnet +options.calculation.yBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withScaleMixin + +```jsonnet +options.calculation.yBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withValue + +```jsonnet +options.calculation.yBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.yBuckets.scale + + +####### fn options.calculation.yBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.yBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withLog + +```jsonnet +options.calculation.yBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withType + +```jsonnet +options.calculation.yBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +#### obj options.cellValues + + +##### fn options.cellValues.withDecimals + +```jsonnet +options.cellValues.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for cell values +##### fn options.cellValues.withUnit + +```jsonnet +options.cellValues.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the cell value unit +#### obj options.color + + +##### fn options.color.withExponent + +```jsonnet +options.color.withExponent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the exponent when scale is set to exponential +##### fn options.color.withFill + +```jsonnet +options.color.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color fill when in opacity mode +##### fn options.color.withMax + +```jsonnet +options.color.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the color scale +##### fn options.color.withMin + +```jsonnet +options.color.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the color scale +##### fn options.color.withMode + +```jsonnet +options.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"opacity"`, `"scheme"` + +Controls the color mode of the heatmap +##### fn options.color.withReverse + +```jsonnet +options.color.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the color scheme +##### fn options.color.withScale + +```jsonnet +options.color.withScale(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"exponential"` + +Controls the color scale of the heatmap +##### fn options.color.withScheme + +```jsonnet +options.color.withScheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color scheme used +##### fn options.color.withSteps + +```jsonnet +options.color.withSteps(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Controls the number of color steps +#### obj options.exemplars + + +##### fn options.exemplars.withColor + +```jsonnet +options.exemplars.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the color of the exemplar markers +#### obj options.filterValues + + +##### fn options.filterValues.withGe + +```jsonnet +options.filterValues.withGe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values greater than or equal to the given value +##### fn options.filterValues.withLe + +```jsonnet +options.filterValues.withLe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values less than or equal to the given value +#### obj options.legend + + +##### fn options.legend.withShow + +```jsonnet +options.legend.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the legend is shown +#### obj options.rowsFrame + + +##### fn options.rowsFrame.withLayout + +```jsonnet +options.rowsFrame.withLayout(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"le"`, `"ge"`, `"unknown"`, `"auto"` + + +##### fn options.rowsFrame.withValue + +```jsonnet +options.rowsFrame.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the name of the cell when not calculating from data +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withShowColorScale + +```jsonnet +options.tooltip.withShowColorScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a color scale in header +##### fn options.tooltip.withYHistogram + +```jsonnet +options.tooltip.withYHistogram(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a histogram of the y-axis values +#### obj options.yAxis + + +##### fn options.yAxis.withAxisBorderShow + +```jsonnet +options.yAxis.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisCenteredZero + +```jsonnet +options.yAxis.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisColorMode + +```jsonnet +options.yAxis.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +##### fn options.yAxis.withAxisGridShow + +```jsonnet +options.yAxis.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisLabel + +```jsonnet +options.yAxis.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.yAxis.withAxisPlacement + +```jsonnet +options.yAxis.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +##### fn options.yAxis.withAxisSoftMax + +```jsonnet +options.yAxis.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisSoftMin + +```jsonnet +options.yAxis.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisWidth + +```jsonnet +options.yAxis.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withDecimals + +```jsonnet +options.yAxis.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for yAxis values +##### fn options.yAxis.withMax + +```jsonnet +options.yAxis.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the yAxis +##### fn options.yAxis.withMin + +```jsonnet +options.yAxis.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the yAxis +##### fn options.yAxis.withReverse + +```jsonnet +options.yAxis.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the yAxis +##### fn options.yAxis.withScaleDistribution + +```jsonnet +options.yAxis.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withScaleDistributionMixin + +```jsonnet +options.yAxis.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withUnit + +```jsonnet +options.yAxis.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the yAxis unit +##### obj options.yAxis.scaleDistribution + + +###### fn options.yAxis.scaleDistribution.withLinearThreshold + +```jsonnet +options.yAxis.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withLog + +```jsonnet +options.yAxis.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withType + +```jsonnet +options.yAxis.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md new file mode 100644 index 00000000..0d098f74 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md @@ -0,0 +1,1242 @@ +# histogram + +grafonnet.panel.histogram + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBucketCount(value=30)`](#fn-optionswithbucketcount) + * [`fn withBucketOffset(value=0)`](#fn-optionswithbucketoffset) + * [`fn withBucketSize(value)`](#fn-optionswithbucketsize) + * [`fn withCombine(value=true)`](#fn-optionswithcombine) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new histogram panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBucketCount + +```jsonnet +options.withBucketCount(value=30) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `30` + +Bucket count (approx) +#### fn options.withBucketOffset + +```jsonnet +options.withBucketOffset(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Offset buckets by this amount +#### fn options.withBucketSize + +```jsonnet +options.withBucketSize(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Size of each bucket +#### fn options.withCombine + +```jsonnet +options.withCombine(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Combines multiple series into a single histogram +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/index.md b/gen/grafonnet-v11.0.0/docs/panel/index.md new file mode 100644 index 00000000..3111a61d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/index.md @@ -0,0 +1,32 @@ +# panel + +grafonnet.panel + +## Subpackages + +* [alertList](alertList/index.md) +* [annotationsList](annotationsList/index.md) +* [barChart](barChart/index.md) +* [barGauge](barGauge/index.md) +* [candlestick](candlestick/index.md) +* [canvas](canvas/index.md) +* [dashboardList](dashboardList/index.md) +* [datagrid](datagrid/index.md) +* [debug](debug/index.md) +* [gauge](gauge/index.md) +* [geomap](geomap/index.md) +* [heatmap](heatmap/index.md) +* [histogram](histogram/index.md) +* [logs](logs/index.md) +* [news](news/index.md) +* [nodeGraph](nodeGraph/index.md) +* [pieChart](pieChart/index.md) +* [row](row.md) +* [stat](stat/index.md) +* [stateTimeline](stateTimeline/index.md) +* [statusHistory](statusHistory/index.md) +* [table](table/index.md) +* [text](text/index.md) +* [timeSeries](timeSeries/index.md) +* [trend](trend/index.md) +* [xyChart](xyChart/index.md) diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/index.md b/gen/grafonnet-v11.0.0/docs/panel/logs/index.md new file mode 100644 index 00000000..3aef7888 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/index.md @@ -0,0 +1,726 @@ +# logs + +grafonnet.panel.logs + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDedupStrategy(value)`](#fn-optionswithdedupstrategy) + * [`fn withEnableLogDetails(value=true)`](#fn-optionswithenablelogdetails) + * [`fn withPrettifyLogMessage(value=true)`](#fn-optionswithprettifylogmessage) + * [`fn withShowCommonLabels(value=true)`](#fn-optionswithshowcommonlabels) + * [`fn withShowLabels(value=true)`](#fn-optionswithshowlabels) + * [`fn withShowLogContextToggle(value=true)`](#fn-optionswithshowlogcontexttoggle) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withSortOrder(value)`](#fn-optionswithsortorder) + * [`fn withWrapLogMessage(value=true)`](#fn-optionswithwraplogmessage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new logs panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDedupStrategy + +```jsonnet +options.withDedupStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"exact"`, `"numbers"`, `"signature"` + + +#### fn options.withEnableLogDetails + +```jsonnet +options.withEnableLogDetails(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withPrettifyLogMessage + +```jsonnet +options.withPrettifyLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowCommonLabels + +```jsonnet +options.withShowCommonLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLabels + +```jsonnet +options.withShowLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLogContextToggle + +```jsonnet +options.withShowLogContextToggle(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSortOrder + +```jsonnet +options.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Descending"`, `"Ascending"` + + +#### fn options.withWrapLogMessage + +```jsonnet +options.withWrapLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/docs/API/panel/alertGroups/index.md b/gen/grafonnet-v11.0.0/docs/panel/news/index.md similarity index 96% rename from docs/API/panel/alertGroups/index.md rename to gen/grafonnet-v11.0.0/docs/panel/news/index.md index 41e6f0d7..3790c6ee 100644 --- a/docs/API/panel/alertGroups/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/news/index.md @@ -1,6 +1,6 @@ -# alertGroups +# news -grafonnet.panel.alertGroups +grafonnet.panel.news ## Subpackages @@ -17,9 +17,8 @@ grafonnet.panel.alertGroups * [`fn withName(value)`](#fn-librarypanelwithname) * [`fn withUid(value)`](#fn-librarypanelwithuid) * [`obj options`](#obj-options) - * [`fn withAlertmanager(value)`](#fn-optionswithalertmanager) - * [`fn withExpandAll(value=true)`](#fn-optionswithexpandall) - * [`fn withLabels(value)`](#fn-optionswithlabels) + * [`fn withFeedUrl(value)`](#fn-optionswithfeedurl) + * [`fn withShowImage(value=true)`](#fn-optionswithshowimage) * [`obj panelOptions`](#obj-paneloptions) * [`fn withDescription(value)`](#fn-paneloptionswithdescription) * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) @@ -76,7 +75,7 @@ PARAMETERS: * **title** (`string`) -Creates a new alertGroups panel with a title. +Creates a new news panel with a title. ### obj libraryPanel @@ -105,21 +104,21 @@ Library panel uid ### obj options -#### fn options.withAlertmanager +#### fn options.withFeedUrl ```jsonnet -options.withAlertmanager(value) +options.withFeedUrl(value) ``` PARAMETERS: * **value** (`string`) -Name of the alertmanager used as a source for alerts -#### fn options.withExpandAll +empty/missing will default to grafana blog +#### fn options.withShowImage ```jsonnet -options.withExpandAll(value=true) +options.withShowImage(value=true) ``` PARAMETERS: @@ -127,18 +126,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -Expand all alert groups by default -#### fn options.withLabels -```jsonnet -options.withLabels(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Comma-separated list of values used to filter alert results ### obj panelOptions diff --git a/gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md new file mode 100644 index 00000000..c9ed6b66 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md @@ -0,0 +1,738 @@ +# nodeGraph + +grafonnet.panel.nodeGraph + +## Subpackages + +* [options.nodes.arcs](options/nodes/arcs.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withEdges(value)`](#fn-optionswithedges) + * [`fn withEdgesMixin(value)`](#fn-optionswithedgesmixin) + * [`fn withNodes(value)`](#fn-optionswithnodes) + * [`fn withNodesMixin(value)`](#fn-optionswithnodesmixin) + * [`obj edges`](#obj-optionsedges) + * [`fn withMainStatUnit(value)`](#fn-optionsedgeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsedgeswithsecondarystatunit) + * [`obj nodes`](#obj-optionsnodes) + * [`fn withArcs(value)`](#fn-optionsnodeswitharcs) + * [`fn withArcsMixin(value)`](#fn-optionsnodeswitharcsmixin) + * [`fn withMainStatUnit(value)`](#fn-optionsnodeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsnodeswithsecondarystatunit) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new nodeGraph panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withEdges + +```jsonnet +options.withEdges(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withEdgesMixin + +```jsonnet +options.withEdgesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodes + +```jsonnet +options.withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodesMixin + +```jsonnet +options.withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.edges + + +##### fn options.edges.withMainStatUnit + +```jsonnet +options.edges.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.edges.withSecondaryStatUnit + +```jsonnet +options.edges.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +#### obj options.nodes + + +##### fn options.nodes.withArcs + +```jsonnet +options.nodes.withArcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withArcsMixin + +```jsonnet +options.nodes.withArcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withMainStatUnit + +```jsonnet +options.nodes.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.nodes.withSecondaryStatUnit + +```jsonnet +options.nodes.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md new file mode 100644 index 00000000..f80fe241 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md @@ -0,0 +1,33 @@ +# arcs + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withField(value)`](#fn-withfield) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The color of the arc. +### fn withField + +```jsonnet +withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field from which to get the value. Values should be less than 1, representing fraction of a circle. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md new file mode 100644 index 00000000..c299041f --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md @@ -0,0 +1,1136 @@ +# pieChart + +grafonnet.panel.pieChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayLabels(value)`](#fn-optionswithdisplaylabels) + * [`fn withDisplayLabelsMixin(value)`](#fn-optionswithdisplaylabelsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withPieType(value)`](#fn-optionswithpietype) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withValues(value)`](#fn-optionslegendwithvalues) + * [`fn withValuesMixin(value)`](#fn-optionslegendwithvaluesmixin) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new pieChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayLabels + +```jsonnet +options.withDisplayLabels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withDisplayLabelsMixin + +```jsonnet +options.withDisplayLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withPieType + +```jsonnet +options.withPieType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pie"`, `"donut"` + +Select the pie chart display style. +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withValues + +```jsonnet +options.legend.withValues(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withValuesMixin + +```jsonnet +options.legend.withValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/row.md b/gen/grafonnet-v11.0.0/docs/panel/row.md new file mode 100644 index 00000000..0541b040 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/row.md @@ -0,0 +1,179 @@ +# row + +grafonnet.panel.row + +## Index + +* [`fn new(title)`](#fn-new) +* [`fn withCollapsed(value=true)`](#fn-withcollapsed) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withGridPos(y)`](#fn-withgridpos) +* [`fn withGridPosMixin(value)`](#fn-withgridposmixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withPanels(value)`](#fn-withpanels) +* [`fn withPanelsMixin(value)`](#fn-withpanelsmixin) +* [`fn withRepeat(value)`](#fn-withrepeat) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new row panel with a title. +### fn withCollapsed + +```jsonnet +withCollapsed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether this row should be collapsed or not. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withGridPos + +```jsonnet +withGridPos(y) +``` + +PARAMETERS: + +* **y** (`number`) + +`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values. +### fn withGridPosMixin + +```jsonnet +withGridPosMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Position and dimensions of a panel in the grid +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. +### fn withPanels + +```jsonnet +withPanels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPanelsMixin + +```jsonnet +withPanelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRepeat + +```jsonnet +withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Row title +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/index.md b/gen/grafonnet-v11.0.0/docs/panel/stat/index.md new file mode 100644 index 00000000..75d91558 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/index.md @@ -0,0 +1,841 @@ +# stat + +grafonnet.panel.stat + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColorMode(value)`](#fn-optionswithcolormode) + * [`fn withGraphMode(value)`](#fn-optionswithgraphmode) + * [`fn withJustifyMode(value)`](#fn-optionswithjustifymode) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowPercentChange(value=true)`](#fn-optionswithshowpercentchange) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTextMode(value)`](#fn-optionswithtextmode) + * [`fn withWideLayout(value=true)`](#fn-optionswithwidelayout) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stat panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColorMode + +```jsonnet +options.withColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"value"`, `"background"`, `"background_solid"`, `"none"` + +TODO docs +#### fn options.withGraphMode + +```jsonnet +options.withGraphMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"line"`, `"area"` + +TODO docs +#### fn options.withJustifyMode + +```jsonnet +options.withJustifyMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"center"` + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowPercentChange + +```jsonnet +options.withShowPercentChange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMode + +```jsonnet +options.withTextMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"value"`, `"value_and_name"`, `"name"`, `"none"` + +TODO docs +#### fn options.withWideLayout + +```jsonnet +options.withWideLayout(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md new file mode 100644 index 00000000..e04563e7 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md @@ -0,0 +1,1045 @@ +# stateTimeline + +grafonnet.panel.stateTimeline + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=0)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlignValue(value)`](#fn-optionswithalignvalue) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMergeValues(value=true)`](#fn-optionswithmergevalues) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stateTimeline panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlignValue + +```jsonnet +options.withAlignValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"center"`, `"left"`, `"right"` + +Controls the value alignment in the TimelineChart component +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMergeValues + +```jsonnet +options.withMergeValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Merge equal consecutive values +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the row height +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md new file mode 100644 index 00000000..0d31d6a1 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md @@ -0,0 +1,1032 @@ +# statusHistory + +grafonnet.panel.statusHistory + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColWidth(value=0.9)`](#fn-optionswithcolwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new statusHistory panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColWidth + +```jsonnet +options.withColWidth(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the column width +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Set the height of the rows +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/index.md b/gen/grafonnet-v11.0.0/docs/panel/table/index.md new file mode 100644 index 00000000..d5c25b8b --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/index.md @@ -0,0 +1,1943 @@ +# table + +grafonnet.panel.table + +## Subpackages + +* [options.sortBy](options/sortBy.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAlign(value)`](#fn-fieldconfigdefaultscustomwithalign) + * [`fn withCellOptions(value)`](#fn-fieldconfigdefaultscustomwithcelloptions) + * [`fn withCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomwithcelloptionsmixin) + * [`fn withDisplayMode(value)`](#fn-fieldconfigdefaultscustomwithdisplaymode) + * [`fn withFilterable(value=true)`](#fn-fieldconfigdefaultscustomwithfilterable) + * [`fn withHidden(value=true)`](#fn-fieldconfigdefaultscustomwithhidden) + * [`fn withHideHeader(value=true)`](#fn-fieldconfigdefaultscustomwithhideheader) + * [`fn withInspect(value=true)`](#fn-fieldconfigdefaultscustomwithinspect) + * [`fn withMinWidth(value)`](#fn-fieldconfigdefaultscustomwithminwidth) + * [`fn withWidth(value)`](#fn-fieldconfigdefaultscustomwithwidth) + * [`obj cellOptions`](#obj-fieldconfigdefaultscustomcelloptions) + * [`fn withTableAutoCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptions) + * [`fn withTableAutoCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptionsmixin) + * [`fn withTableBarGaugeCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptions) + * [`fn withTableBarGaugeCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptionsmixin) + * [`fn withTableColorTextCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptions) + * [`fn withTableColorTextCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptionsmixin) + * [`fn withTableColoredBackgroundCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptions) + * [`fn withTableColoredBackgroundCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptionsmixin) + * [`fn withTableDataLinksCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtabledatalinkscelloptions) + * [`fn withTableDataLinksCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtabledatalinkscelloptionsmixin) + * [`fn withTableImageCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptions) + * [`fn withTableImageCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptionsmixin) + * [`fn withTableJsonViewCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptions) + * [`fn withTableJsonViewCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptionsmixin) + * [`fn withTableSparklineCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptions) + * [`fn withTableSparklineCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptionsmixin) + * [`obj TableAutoCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableautocelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithtype) + * [`obj TableBarGaugeCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablebargaugecelloptions) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithmode) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithtype) + * [`fn withValueDisplayMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithvaluedisplaymode) + * [`obj TableColorTextCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecolortextcelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithtype) + * [`obj TableColoredBackgroundCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptions) + * [`fn withApplyToRow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithapplytorow) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithmode) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithtype) + * [`obj TableDataLinksCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptionswithtype) + * [`obj TableImageCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableimagecelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtype) + * [`obj TableJsonViewCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptionswithtype) + * [`obj TableSparklineCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptions) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) + * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtransform) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtype) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCellHeight(value)`](#fn-optionswithcellheight) + * [`fn withFooter(value)`](#fn-optionswithfooter) + * [`fn withFooterMixin(value)`](#fn-optionswithfootermixin) + * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) + * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) + * [`fn withShowTypeIcons(value=true)`](#fn-optionswithshowtypeicons) + * [`fn withSortBy(value)`](#fn-optionswithsortby) + * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) + * [`obj footer`](#obj-optionsfooter) + * [`fn withCountRows(value=true)`](#fn-optionsfooterwithcountrows) + * [`fn withEnablePagination(value=true)`](#fn-optionsfooterwithenablepagination) + * [`fn withFields(value)`](#fn-optionsfooterwithfields) + * [`fn withFieldsMixin(value)`](#fn-optionsfooterwithfieldsmixin) + * [`fn withReducer(value)`](#fn-optionsfooterwithreducer) + * [`fn withReducerMixin(value)`](#fn-optionsfooterwithreducermixin) + * [`fn withShow(value=true)`](#fn-optionsfooterwithshow) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new table panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAlign + +```jsonnet +fieldConfig.defaults.custom.withAlign(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"left"`, `"right"`, `"center"` + +TODO -- should not be table specific! +TODO docs +###### fn fieldConfig.defaults.custom.withCellOptions + +```jsonnet +fieldConfig.defaults.custom.withCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.withCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withDisplayMode + +```jsonnet +fieldConfig.defaults.custom.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"color-text"`, `"color-background"`, `"color-background-solid"`, `"gradient-gauge"`, `"lcd-gauge"`, `"json-view"`, `"basic"`, `"image"`, `"gauge"`, `"sparkline"`, `"data-links"`, `"custom"` + +Internally, this is the "type" of cell that's being displayed +in the table such as colored text, JSON, gauge, etc. +The color-background-solid, gradient-gauge, and lcd-gauge +modes are deprecated in favor of new cell subOptions +###### fn fieldConfig.defaults.custom.withFilterable + +```jsonnet +fieldConfig.defaults.custom.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withHidden + +```jsonnet +fieldConfig.defaults.custom.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +?? default is missing or false ?? +###### fn fieldConfig.defaults.custom.withHideHeader + +```jsonnet +fieldConfig.defaults.custom.withHideHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Hides any header for a column, useful for columns that show some static content or buttons. +###### fn fieldConfig.defaults.custom.withInspect + +```jsonnet +fieldConfig.defaults.custom.withInspect(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withMinWidth + +```jsonnet +fieldConfig.defaults.custom.withMinWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withWidth + +```jsonnet +fieldConfig.defaults.custom.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### obj fieldConfig.defaults.custom.cellOptions + + +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Show data links in the cell +####### fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Show data links in the cell +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### obj fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType() +``` + + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +####### obj fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"gradient"` + +Display mode to the "Colored Background" display +mode for table cells. Either displays a solid color (basic mode) +or a gradient. +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableImageCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType() +``` + + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCellHeight + +```jsonnet +options.withCellHeight(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sm"`, `"md"`, `"lg"` + +Height of a table cell +#### fn options.withFooter + +```jsonnet +options.withFooter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Footer options +#### fn options.withFooterMixin + +```jsonnet +options.withFooterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Footer options +#### fn options.withFrameIndex + +```jsonnet +options.withFrameIndex(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Represents the index of the selected frame +#### fn options.withShowHeader + +```jsonnet +options.withShowHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the panel should show the header +#### fn options.withShowTypeIcons + +```jsonnet +options.withShowTypeIcons(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the header should show icons for the column types +#### fn options.withSortBy + +```jsonnet +options.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### fn options.withSortByMixin + +```jsonnet +options.withSortByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### obj options.footer + + +##### fn options.footer.withCountRows + +```jsonnet +options.footer.withCountRows(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.footer.withEnablePagination + +```jsonnet +options.footer.withEnablePagination(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.footer.withFields + +```jsonnet +options.footer.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.footer.withFieldsMixin + +```jsonnet +options.footer.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.footer.withReducer + +```jsonnet +options.footer.withReducer(value) +``` + +PARAMETERS: + +* **value** (`array`) + +actually 1 value +##### fn options.footer.withReducerMixin + +```jsonnet +options.footer.withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +actually 1 value +##### fn options.footer.withShow + +```jsonnet +options.footer.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md b/gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md new file mode 100644 index 00000000..20748dc8 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md @@ -0,0 +1,34 @@ +# sortBy + + + +## Index + +* [`fn withDesc(value=true)`](#fn-withdesc) +* [`fn withDisplayName(value)`](#fn-withdisplayname) + +## Fields + +### fn withDesc + +```jsonnet +withDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag used to indicate descending sort order +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the display name of the field to sort by \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/index.md b/gen/grafonnet-v11.0.0/docs/panel/text/index.md new file mode 100644 index 00000000..82e0a100 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/text/index.md @@ -0,0 +1,702 @@ +# text + +grafonnet.panel.text + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCode(value)`](#fn-optionswithcode) + * [`fn withCodeMixin(value)`](#fn-optionswithcodemixin) + * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj code`](#obj-optionscode) + * [`fn withLanguage(value)`](#fn-optionscodewithlanguage) + * [`fn withShowLineNumbers(value=true)`](#fn-optionscodewithshowlinenumbers) + * [`fn withShowMiniMap(value=true)`](#fn-optionscodewithshowminimap) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new text panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCode + +```jsonnet +options.withCode(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCodeMixin + +```jsonnet +options.withCodeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withContent + +```jsonnet +options.withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)"` + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"html"`, `"markdown"`, `"code"` + + +#### obj options.code + + +##### fn options.code.withLanguage + +```jsonnet +options.code.withLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"json"`, `"yaml"`, `"xml"`, `"typescript"`, `"sql"`, `"go"`, `"markdown"`, `"html"`, `"plaintext"` + + +##### fn options.code.withShowLineNumbers + +```jsonnet +options.code.withShowLineNumbers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.code.withShowMiniMap + +```jsonnet +options.code.withShowMiniMap(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md new file mode 100644 index 00000000..0868e660 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md @@ -0,0 +1,1543 @@ +# timeSeries + +grafonnet.panel.timeSeries + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new timeSeries panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md new file mode 100644 index 00000000..9a3dfabb --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md @@ -0,0 +1,1496 @@ +# trend + +grafonnet.panel.trend + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new trend panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the x field to use (defaults to first number) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md new file mode 100644 index 00000000..12137f35 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md @@ -0,0 +1,1574 @@ +# xyChart + +grafonnet.panel.xyChart + +## Subpackages + +* [options.series](options/series.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLabel(value)`](#fn-fieldconfigdefaultscustomwithlabel) + * [`fn withLabelValue(value)`](#fn-fieldconfigdefaultscustomwithlabelvalue) + * [`fn withLabelValueMixin(value)`](#fn-fieldconfigdefaultscustomwithlabelvaluemixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineColorMixin(value)`](#fn-fieldconfigdefaultscustomwithlinecolormixin) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointColorMixin(value)`](#fn-fieldconfigdefaultscustomwithpointcolormixin) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSizeMixin(value)`](#fn-fieldconfigdefaultscustomwithpointsizemixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShow(value)`](#fn-fieldconfigdefaultscustomwithshow) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj labelValue`](#obj-fieldconfigdefaultscustomlabelvalue) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfixed) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithmode) + * [`obj lineColor`](#obj-fieldconfigdefaultscustomlinecolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfixed) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj pointColor`](#obj-fieldconfigdefaultscustompointcolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointcolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointcolorwithfixed) + * [`obj pointSize`](#obj-fieldconfigdefaultscustompointsize) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointsizewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointsizewithfixed) + * [`fn withMax(value)`](#fn-fieldconfigdefaultscustompointsizewithmax) + * [`fn withMin(value)`](#fn-fieldconfigdefaultscustompointsizewithmin) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustompointsizewithmode) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDims(value)`](#fn-optionswithdims) + * [`fn withDimsMixin(value)`](#fn-optionswithdimsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withSeries(value)`](#fn-optionswithseries) + * [`fn withSeriesMapping(value)`](#fn-optionswithseriesmapping) + * [`fn withSeriesMixin(value)`](#fn-optionswithseriesmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj dims`](#obj-optionsdims) + * [`fn withExclude(value)`](#fn-optionsdimswithexclude) + * [`fn withExcludeMixin(value)`](#fn-optionsdimswithexcludemixin) + * [`fn withFrame(value)`](#fn-optionsdimswithframe) + * [`fn withX(value)`](#fn-optionsdimswithx) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new xyChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLabel + +```jsonnet +fieldConfig.defaults.custom.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLabelValue + +```jsonnet +fieldConfig.defaults.custom.withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLabelValueMixin + +```jsonnet +fieldConfig.defaults.custom.withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColorMixin + +```jsonnet +fieldConfig.defaults.custom.withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointColorMixin + +```jsonnet +fieldConfig.defaults.custom.withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSizeMixin + +```jsonnet +fieldConfig.defaults.custom.withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShow + +```jsonnet +fieldConfig.defaults.custom.withShow(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.labelValue + + +####### fn fieldConfig.defaults.custom.labelValue.withField + +```jsonnet +fieldConfig.defaults.custom.labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.labelValue.withFixed + +```jsonnet +fieldConfig.defaults.custom.labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.labelValue.withMode + +```jsonnet +fieldConfig.defaults.custom.labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +###### obj fieldConfig.defaults.custom.lineColor + + +####### fn fieldConfig.defaults.custom.lineColor.withField + +```jsonnet +fieldConfig.defaults.custom.lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.lineColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.pointColor + + +####### fn fieldConfig.defaults.custom.pointColor.withField + +```jsonnet +fieldConfig.defaults.custom.pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +###### obj fieldConfig.defaults.custom.pointSize + + +####### fn fieldConfig.defaults.custom.pointSize.withField + +```jsonnet +fieldConfig.defaults.custom.pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointSize.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMax + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMin + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMode + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDims + +```jsonnet +options.withDims(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration for the Table/Auto mode +#### fn options.withDimsMixin + +```jsonnet +options.withDimsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration for the Table/Auto mode +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withSeries + +```jsonnet +options.withSeries(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Manual Mode +#### fn options.withSeriesMapping + +```jsonnet +options.withSeriesMapping(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Auto is "table" in the UI +#### fn options.withSeriesMixin + +```jsonnet +options.withSeriesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Manual Mode +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.dims + + +##### fn options.dims.withExclude + +```jsonnet +options.dims.withExclude(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withExcludeMixin + +```jsonnet +options.dims.withExcludeMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withFrame + +```jsonnet +options.dims.withFrame(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.dims.withX + +```jsonnet +options.dims.withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md new file mode 100644 index 00000000..30e01524 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md @@ -0,0 +1,663 @@ +# series + + + +## Index + +* [`fn withAxisBorderShow(value=true)`](#fn-withaxisbordershow) +* [`fn withAxisCenteredZero(value=true)`](#fn-withaxiscenteredzero) +* [`fn withAxisColorMode(value)`](#fn-withaxiscolormode) +* [`fn withAxisGridShow(value=true)`](#fn-withaxisgridshow) +* [`fn withAxisLabel(value)`](#fn-withaxislabel) +* [`fn withAxisPlacement(value)`](#fn-withaxisplacement) +* [`fn withAxisSoftMax(value)`](#fn-withaxissoftmax) +* [`fn withAxisSoftMin(value)`](#fn-withaxissoftmin) +* [`fn withAxisWidth(value)`](#fn-withaxiswidth) +* [`fn withFrame(value)`](#fn-withframe) +* [`fn withHideFrom(value)`](#fn-withhidefrom) +* [`fn withHideFromMixin(value)`](#fn-withhidefrommixin) +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withLabelValue(value)`](#fn-withlabelvalue) +* [`fn withLabelValueMixin(value)`](#fn-withlabelvaluemixin) +* [`fn withLineColor(value)`](#fn-withlinecolor) +* [`fn withLineColorMixin(value)`](#fn-withlinecolormixin) +* [`fn withLineStyle(value)`](#fn-withlinestyle) +* [`fn withLineStyleMixin(value)`](#fn-withlinestylemixin) +* [`fn withLineWidth(value)`](#fn-withlinewidth) +* [`fn withName(value)`](#fn-withname) +* [`fn withPointColor(value)`](#fn-withpointcolor) +* [`fn withPointColorMixin(value)`](#fn-withpointcolormixin) +* [`fn withPointSize(value)`](#fn-withpointsize) +* [`fn withPointSizeMixin(value)`](#fn-withpointsizemixin) +* [`fn withScaleDistribution(value)`](#fn-withscaledistribution) +* [`fn withScaleDistributionMixin(value)`](#fn-withscaledistributionmixin) +* [`fn withShow(value)`](#fn-withshow) +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) +* [`obj hideFrom`](#obj-hidefrom) + * [`fn withLegend(value=true)`](#fn-hidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-hidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-hidefromwithviz) +* [`obj labelValue`](#obj-labelvalue) + * [`fn withField(value)`](#fn-labelvaluewithfield) + * [`fn withFixed(value)`](#fn-labelvaluewithfixed) + * [`fn withMode(value)`](#fn-labelvaluewithmode) +* [`obj lineColor`](#obj-linecolor) + * [`fn withField(value)`](#fn-linecolorwithfield) + * [`fn withFixed(value)`](#fn-linecolorwithfixed) +* [`obj lineStyle`](#obj-linestyle) + * [`fn withDash(value)`](#fn-linestylewithdash) + * [`fn withDashMixin(value)`](#fn-linestylewithdashmixin) + * [`fn withFill(value)`](#fn-linestylewithfill) +* [`obj pointColor`](#obj-pointcolor) + * [`fn withField(value)`](#fn-pointcolorwithfield) + * [`fn withFixed(value)`](#fn-pointcolorwithfixed) +* [`obj pointSize`](#obj-pointsize) + * [`fn withField(value)`](#fn-pointsizewithfield) + * [`fn withFixed(value)`](#fn-pointsizewithfixed) + * [`fn withMax(value)`](#fn-pointsizewithmax) + * [`fn withMin(value)`](#fn-pointsizewithmin) + * [`fn withMode(value)`](#fn-pointsizewithmode) +* [`obj scaleDistribution`](#obj-scaledistribution) + * [`fn withLinearThreshold(value)`](#fn-scaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-scaledistributionwithlog) + * [`fn withType(value)`](#fn-scaledistributionwithtype) + +## Fields + +### fn withAxisBorderShow + +```jsonnet +withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisCenteredZero + +```jsonnet +withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisColorMode + +```jsonnet +withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +### fn withAxisGridShow + +```jsonnet +withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisLabel + +```jsonnet +withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withAxisPlacement + +```jsonnet +withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +### fn withAxisSoftMax + +```jsonnet +withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisSoftMin + +```jsonnet +withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisWidth + +```jsonnet +withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withFrame + +```jsonnet +withFrame(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withHideFrom + +```jsonnet +withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withHideFromMixin + +```jsonnet +withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +### fn withLabelValue + +```jsonnet +withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelValueMixin + +```jsonnet +withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColor + +```jsonnet +withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColorMixin + +```jsonnet +withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineStyle + +```jsonnet +withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineStyleMixin + +```jsonnet +withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineWidth + +```jsonnet +withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPointColor + +```jsonnet +withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointColorMixin + +```jsonnet +withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSize + +```jsonnet +withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSizeMixin + +```jsonnet +withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScaleDistribution + +```jsonnet +withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withScaleDistributionMixin + +```jsonnet +withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withShow + +```jsonnet +withShow(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj hideFrom + + +#### fn hideFrom.withLegend + +```jsonnet +hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withTooltip + +```jsonnet +hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withViz + +```jsonnet +hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj labelValue + + +#### fn labelValue.withField + +```jsonnet +labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn labelValue.withFixed + +```jsonnet +labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn labelValue.withMode + +```jsonnet +labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +### obj lineColor + + +#### fn lineColor.withField + +```jsonnet +lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn lineColor.withFixed + +```jsonnet +lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj lineStyle + + +#### fn lineStyle.withDash + +```jsonnet +lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withDashMixin + +```jsonnet +lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withFill + +```jsonnet +lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +### obj pointColor + + +#### fn pointColor.withField + +```jsonnet +pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointColor.withFixed + +```jsonnet +pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj pointSize + + +#### fn pointSize.withField + +```jsonnet +pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointSize.withFixed + +```jsonnet +pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMax + +```jsonnet +pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMin + +```jsonnet +pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMode + +```jsonnet +pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +### obj scaleDistribution + + +#### fn scaleDistribution.withLinearThreshold + +```jsonnet +scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withLog + +```jsonnet +scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withType + +```jsonnet +scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md new file mode 100644 index 00000000..d744fc5d --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md new file mode 100644 index 00000000..69dda9ac --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md new file mode 100644 index 00000000..196c7692 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md new file mode 100644 index 00000000..2997ad7e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md new file mode 100644 index 00000000..62c49ab0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/preferences.md b/gen/grafonnet-v11.0.0/docs/preferences.md new file mode 100644 index 00000000..79b7bfc8 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/preferences.md @@ -0,0 +1,210 @@ +# preferences + +grafonnet.preferences + +## Index + +* [`fn withCookiePreferences(value)`](#fn-withcookiepreferences) +* [`fn withCookiePreferencesMixin(value)`](#fn-withcookiepreferencesmixin) +* [`fn withHomeDashboardUID(value)`](#fn-withhomedashboarduid) +* [`fn withLanguage(value)`](#fn-withlanguage) +* [`fn withQueryHistory(value)`](#fn-withqueryhistory) +* [`fn withQueryHistoryMixin(value)`](#fn-withqueryhistorymixin) +* [`fn withTheme(value)`](#fn-withtheme) +* [`fn withTimezone(value)`](#fn-withtimezone) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj cookiePreferences`](#obj-cookiepreferences) + * [`fn withAnalytics(value)`](#fn-cookiepreferenceswithanalytics) + * [`fn withAnalyticsMixin(value)`](#fn-cookiepreferenceswithanalyticsmixin) + * [`fn withFunctional(value)`](#fn-cookiepreferenceswithfunctional) + * [`fn withFunctionalMixin(value)`](#fn-cookiepreferenceswithfunctionalmixin) + * [`fn withPerformance(value)`](#fn-cookiepreferenceswithperformance) + * [`fn withPerformanceMixin(value)`](#fn-cookiepreferenceswithperformancemixin) +* [`obj queryHistory`](#obj-queryhistory) + * [`fn withHomeTab(value)`](#fn-queryhistorywithhometab) + +## Fields + +### fn withCookiePreferences + +```jsonnet +withCookiePreferences(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCookiePreferencesMixin + +```jsonnet +withCookiePreferencesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHomeDashboardUID + +```jsonnet +withHomeDashboardUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID for the home dashboard +### fn withLanguage + +```jsonnet +withLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Selected language (beta) +### fn withQueryHistory + +```jsonnet +withQueryHistory(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryHistoryMixin + +```jsonnet +withQueryHistoryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTheme + +```jsonnet +withTheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +light, dark, empty is default +### fn withTimezone + +```jsonnet +withTimezone(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The timezone selection +TODO: this should use the timezone defined in common +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +day of the week (sunday, monday, etc) +### obj cookiePreferences + + +#### fn cookiePreferences.withAnalytics + +```jsonnet +cookiePreferences.withAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withAnalyticsMixin + +```jsonnet +cookiePreferences.withAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctional + +```jsonnet +cookiePreferences.withFunctional(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctionalMixin + +```jsonnet +cookiePreferences.withFunctionalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformance + +```jsonnet +cookiePreferences.withPerformance(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformanceMixin + +```jsonnet +cookiePreferences.withPerformanceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj queryHistory + + +#### fn queryHistory.withHomeTab + +```jsonnet +queryHistory.withHomeTab(value) +``` + +PARAMETERS: + +* **value** (`string`) + +one of: '' | 'query' | 'starred'; \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/publicdashboard.md b/gen/grafonnet-v11.0.0/docs/publicdashboard.md new file mode 100644 index 00000000..9cb78fbd --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/publicdashboard.md @@ -0,0 +1,84 @@ +# publicdashboard + +grafonnet.publicdashboard + +## Index + +* [`fn withAccessToken(value)`](#fn-withaccesstoken) +* [`fn withAnnotationsEnabled(value=true)`](#fn-withannotationsenabled) +* [`fn withDashboardUid(value)`](#fn-withdashboarduid) +* [`fn withIsEnabled(value=true)`](#fn-withisenabled) +* [`fn withTimeSelectionEnabled(value=true)`](#fn-withtimeselectionenabled) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withAccessToken + +```jsonnet +withAccessToken(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique public access token +### fn withAnnotationsEnabled + +```jsonnet +withAnnotationsEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if annotations are enabled +### fn withDashboardUid + +```jsonnet +withDashboardUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Dashboard unique identifier referenced by this public dashboard +### fn withIsEnabled + +```jsonnet +withIsEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the public dashboard is enabled +### fn withTimeSelectionEnabled + +```jsonnet +withTimeSelectionEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the time range picker is enabled +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique public dashboard identifier \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/dimensionFilters.md b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/dimensionFilters.md new file mode 100644 index 00000000..43b6cf55 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/dimensionFilters.md @@ -0,0 +1,69 @@ +# dimensionFilters + + + +## Index + +* [`fn withDimension(value)`](#fn-withdimension) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperator(value)`](#fn-withoperator) + +## Fields + +### fn withDimension + +```jsonnet +withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of Dimension to be filtered on. +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated filter is deprecated in favour of filters to support multiselect. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/resources.md b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/resources.md new file mode 100644 index 00000000..18bb633a --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/resources.md @@ -0,0 +1,68 @@ +# resources + + + +## Index + +* [`fn withMetricNamespace(value)`](#fn-withmetricnamespace) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withResourceName(value)`](#fn-withresourcename) +* [`fn withSubscription(value)`](#fn-withsubscription) + +## Fields + +### fn withMetricNamespace + +```jsonnet +withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceName + +```jsonnet +withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureTraces/filters.md b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureTraces/filters.md new file mode 100644 index 00000000..0c5c7182 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureTraces/filters.md @@ -0,0 +1,57 @@ +# filters + + + +## Index + +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperation(value)`](#fn-withoperation) +* [`fn withProperty(value)`](#fn-withproperty) + +## Fields + +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withOperation + +```jsonnet +withOperation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Comparison operator to use. Either equals or not equals. +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Property name, auto-populated based on available traces. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md new file mode 100644 index 00000000..1355e0ef --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md @@ -0,0 +1,1513 @@ +# azuremonitor + +grafonnet.query.azuremonitor + +## Subpackages + +* [azureMonitor.dimensionFilters](azureMonitor/dimensionFilters.md) +* [azureMonitor.resources](azureMonitor/resources.md) +* [azureTraces.filters](azureTraces/filters.md) + +## Index + +* [`fn withAzureLogAnalytics(value)`](#fn-withazureloganalytics) +* [`fn withAzureLogAnalyticsMixin(value)`](#fn-withazureloganalyticsmixin) +* [`fn withAzureMonitor(value)`](#fn-withazuremonitor) +* [`fn withAzureMonitorMixin(value)`](#fn-withazuremonitormixin) +* [`fn withAzureResourceGraph(value)`](#fn-withazureresourcegraph) +* [`fn withAzureResourceGraphMixin(value)`](#fn-withazureresourcegraphmixin) +* [`fn withAzureTraces(value)`](#fn-withazuretraces) +* [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) +* [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withNamespace(value)`](#fn-withnamespace) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResource(value)`](#fn-withresource) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withSubscription(value)`](#fn-withsubscription) +* [`fn withSubscriptions(value)`](#fn-withsubscriptions) +* [`fn withSubscriptionsMixin(value)`](#fn-withsubscriptionsmixin) +* [`obj azureLogAnalytics`](#obj-azureloganalytics) + * [`fn withDashboardTime(value=true)`](#fn-azureloganalyticswithdashboardtime) + * [`fn withIntersectTime(value=true)`](#fn-azureloganalyticswithintersecttime) + * [`fn withQuery(value)`](#fn-azureloganalyticswithquery) + * [`fn withResource(value)`](#fn-azureloganalyticswithresource) + * [`fn withResources(value)`](#fn-azureloganalyticswithresources) + * [`fn withResourcesMixin(value)`](#fn-azureloganalyticswithresourcesmixin) + * [`fn withResultFormat(value)`](#fn-azureloganalyticswithresultformat) + * [`fn withTimeColumn(value)`](#fn-azureloganalyticswithtimecolumn) + * [`fn withWorkspace(value)`](#fn-azureloganalyticswithworkspace) +* [`obj azureMonitor`](#obj-azuremonitor) + * [`fn withAggregation(value)`](#fn-azuremonitorwithaggregation) + * [`fn withAlias(value)`](#fn-azuremonitorwithalias) + * [`fn withAllowedTimeGrainsMs(value)`](#fn-azuremonitorwithallowedtimegrainsms) + * [`fn withAllowedTimeGrainsMsMixin(value)`](#fn-azuremonitorwithallowedtimegrainsmsmixin) + * [`fn withCustomNamespace(value)`](#fn-azuremonitorwithcustomnamespace) + * [`fn withDimension(value)`](#fn-azuremonitorwithdimension) + * [`fn withDimensionFilter(value)`](#fn-azuremonitorwithdimensionfilter) + * [`fn withDimensionFilters(value)`](#fn-azuremonitorwithdimensionfilters) + * [`fn withDimensionFiltersMixin(value)`](#fn-azuremonitorwithdimensionfiltersmixin) + * [`fn withMetricDefinition(value)`](#fn-azuremonitorwithmetricdefinition) + * [`fn withMetricName(value)`](#fn-azuremonitorwithmetricname) + * [`fn withMetricNamespace(value)`](#fn-azuremonitorwithmetricnamespace) + * [`fn withRegion(value)`](#fn-azuremonitorwithregion) + * [`fn withResourceGroup(value)`](#fn-azuremonitorwithresourcegroup) + * [`fn withResourceName(value)`](#fn-azuremonitorwithresourcename) + * [`fn withResourceUri(value)`](#fn-azuremonitorwithresourceuri) + * [`fn withResources(value)`](#fn-azuremonitorwithresources) + * [`fn withResourcesMixin(value)`](#fn-azuremonitorwithresourcesmixin) + * [`fn withTimeGrain(value)`](#fn-azuremonitorwithtimegrain) + * [`fn withTimeGrainUnit(value)`](#fn-azuremonitorwithtimegrainunit) + * [`fn withTop(value)`](#fn-azuremonitorwithtop) +* [`obj azureResourceGraph`](#obj-azureresourcegraph) + * [`fn withQuery(value)`](#fn-azureresourcegraphwithquery) + * [`fn withResultFormat(value)`](#fn-azureresourcegraphwithresultformat) +* [`obj azureTraces`](#obj-azuretraces) + * [`fn withFilters(value)`](#fn-azuretraceswithfilters) + * [`fn withFiltersMixin(value)`](#fn-azuretraceswithfiltersmixin) + * [`fn withOperationId(value)`](#fn-azuretraceswithoperationid) + * [`fn withQuery(value)`](#fn-azuretraceswithquery) + * [`fn withResources(value)`](#fn-azuretraceswithresources) + * [`fn withResourcesMixin(value)`](#fn-azuretraceswithresourcesmixin) + * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) + * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) + * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) +* [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) + * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) + * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) + * [`fn withAppInsightsMetricNameQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequery) + * [`fn withAppInsightsMetricNameQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequerymixin) + * [`fn withMetricDefinitionsQuery(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquery) + * [`fn withMetricDefinitionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquerymixin) + * [`fn withMetricNamesQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquery) + * [`fn withMetricNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquerymixin) + * [`fn withMetricNamespaceQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequery) + * [`fn withMetricNamespaceQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequerymixin) + * [`fn withResourceGroupsQuery(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquery) + * [`fn withResourceGroupsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquerymixin) + * [`fn withResourceNamesQuery(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquery) + * [`fn withResourceNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquerymixin) + * [`fn withSubscriptionsQuery(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquery) + * [`fn withSubscriptionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquerymixin) + * [`fn withUnknownQuery(value)`](#fn-grafanatemplatevariablefnwithunknownquery) + * [`fn withUnknownQueryMixin(value)`](#fn-grafanatemplatevariablefnwithunknownquerymixin) + * [`fn withWorkspacesQuery(value)`](#fn-grafanatemplatevariablefnwithworkspacesquery) + * [`fn withWorkspacesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithworkspacesquerymixin) + * [`obj AppInsightsGroupByQuery`](#obj-grafanatemplatevariablefnappinsightsgroupbyquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithkind) + * [`fn withMetricName(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithmetricname) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithrawquery) + * [`obj AppInsightsMetricNameQuery`](#obj-grafanatemplatevariablefnappinsightsmetricnamequery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithrawquery) + * [`obj MetricDefinitionsQuery`](#obj-grafanatemplatevariablefnmetricdefinitionsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithsubscription) + * [`obj MetricNamesQuery`](#obj-grafanatemplatevariablefnmetricnamesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamesquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithsubscription) + * [`obj MetricNamespaceQuery`](#obj-grafanatemplatevariablefnmetricnamespacequery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamespacequerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithsubscription) + * [`obj ResourceGroupsQuery`](#obj-grafanatemplatevariablefnresourcegroupsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcegroupsquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithrawquery) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithsubscription) + * [`obj ResourceNamesQuery`](#obj-grafanatemplatevariablefnresourcenamesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcenamesquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithresourcegroup) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithsubscription) + * [`obj SubscriptionsQuery`](#obj-grafanatemplatevariablefnsubscriptionsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnsubscriptionsquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithrawquery) + * [`obj UnknownQuery`](#obj-grafanatemplatevariablefnunknownquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnunknownquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnunknownquerywithrawquery) + * [`obj WorkspacesQuery`](#obj-grafanatemplatevariablefnworkspacesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnworkspacesquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithrawquery) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithsubscription) + +## Fields + +### fn withAzureLogAnalytics + +```jsonnet +withAzureLogAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Logs sub-query properties +### fn withAzureLogAnalyticsMixin + +```jsonnet +withAzureLogAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Logs sub-query properties +### fn withAzureMonitor + +```jsonnet +withAzureMonitor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureMonitorMixin + +```jsonnet +withAzureMonitorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureResourceGraph + +```jsonnet +withAzureResourceGraph(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureResourceGraphMixin + +```jsonnet +withAzureResourceGraphMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureTraces + +```jsonnet +withAzureTraces(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Application Insights Traces sub-query properties +### fn withAzureTracesMixin + +```jsonnet +withAzureTracesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Application Insights Traces sub-query properties +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withGrafanaTemplateVariableFn + +```jsonnet +withGrafanaTemplateVariableFn(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withGrafanaTemplateVariableFnMixin + +```jsonnet +withGrafanaTemplateVariableFnMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withNamespace + +```jsonnet +withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure Monitor query type. +queryType: #AzureQueryType +### fn withResource + +```jsonnet +withResource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Template variables params. These exist for backwards compatiblity with legacy template variables. +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure subscription containing the resource(s) to be queried. +### fn withSubscriptions + +```jsonnet +withSubscriptions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Subscriptions to be queried via Azure Resource Graph. +### fn withSubscriptionsMixin + +```jsonnet +withSubscriptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Subscriptions to be queried via Azure Resource Graph. +### obj azureLogAnalytics + + +#### fn azureLogAnalytics.withDashboardTime + +```jsonnet +azureLogAnalytics.withDashboardTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false. +#### fn azureLogAnalytics.withIntersectTime + +```jsonnet +azureLogAnalytics.withIntersectTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated Use dashboardTime instead +#### fn azureLogAnalytics.withQuery + +```jsonnet +azureLogAnalytics.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +KQL query to be executed. +#### fn azureLogAnalytics.withResource + +```jsonnet +azureLogAnalytics.withResource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureLogAnalytics.withResources + +```jsonnet +azureLogAnalytics.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureLogAnalytics.withResourcesMixin + +```jsonnet +azureLogAnalytics.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureLogAnalytics.withResultFormat + +```jsonnet +azureLogAnalytics.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"`, `"logs"` + + +#### fn azureLogAnalytics.withTimeColumn + +```jsonnet +azureLogAnalytics.withTimeColumn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated +#### fn azureLogAnalytics.withWorkspace + +```jsonnet +azureLogAnalytics.withWorkspace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Workspace ID. This was removed in Grafana 8, but remains for backwards compat. +### obj azureMonitor + + +#### fn azureMonitor.withAggregation + +```jsonnet +azureMonitor.withAggregation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric. +#### fn azureMonitor.withAlias + +```jsonnet +azureMonitor.withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail. +#### fn azureMonitor.withAllowedTimeGrainsMs + +```jsonnet +azureMonitor.withAllowedTimeGrainsMs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Time grains that are supported by the metric. +#### fn azureMonitor.withAllowedTimeGrainsMsMixin + +```jsonnet +azureMonitor.withAllowedTimeGrainsMsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Time grains that are supported by the metric. +#### fn azureMonitor.withCustomNamespace + +```jsonnet +azureMonitor.withCustomNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used as the value for the metricNamespace property when it's different from the resource namespace. +#### fn azureMonitor.withDimension + +```jsonnet +azureMonitor.withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +#### fn azureMonitor.withDimensionFilter + +```jsonnet +azureMonitor.withDimensionFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +#### fn azureMonitor.withDimensionFilters + +```jsonnet +azureMonitor.withDimensionFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +#### fn azureMonitor.withDimensionFiltersMixin + +```jsonnet +azureMonitor.withDimensionFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +#### fn azureMonitor.withMetricDefinition + +```jsonnet +azureMonitor.withMetricDefinition(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use metricNamespace instead +#### fn azureMonitor.withMetricName + +```jsonnet +azureMonitor.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The metric to query data for within the specified metricNamespace. e.g. UsedCapacity +#### fn azureMonitor.withMetricNamespace + +```jsonnet +azureMonitor.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +metricNamespace is used as the resource type (or resource namespace). +It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts +Kept the name of the variable as metricNamespace to avoid backward incompatibility issues. +#### fn azureMonitor.withRegion + +```jsonnet +azureMonitor.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The Azure region containing the resource(s). +#### fn azureMonitor.withResourceGroup + +```jsonnet +azureMonitor.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureMonitor.withResourceName + +```jsonnet +azureMonitor.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureMonitor.withResourceUri + +```jsonnet +azureMonitor.withResourceUri(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resourceGroup, resourceName and metricNamespace instead +#### fn azureMonitor.withResources + +```jsonnet +azureMonitor.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureMonitor.withResourcesMixin + +```jsonnet +azureMonitor.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureMonitor.withTimeGrain + +```jsonnet +azureMonitor.withTimeGrain(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The granularity of data points to be queried. Defaults to auto. +#### fn azureMonitor.withTimeGrainUnit + +```jsonnet +azureMonitor.withTimeGrainUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated +#### fn azureMonitor.withTop + +```jsonnet +azureMonitor.withTop(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Maximum number of records to return. Defaults to 10. +### obj azureResourceGraph + + +#### fn azureResourceGraph.withQuery + +```jsonnet +azureResourceGraph.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure Resource Graph KQL query to be executed. +#### fn azureResourceGraph.withResultFormat + +```jsonnet +azureResourceGraph.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the format results should be returned as. Defaults to table. +### obj azureTraces + + +#### fn azureTraces.withFilters + +```jsonnet +azureTraces.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters for property values. +#### fn azureTraces.withFiltersMixin + +```jsonnet +azureTraces.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters for property values. +#### fn azureTraces.withOperationId + +```jsonnet +azureTraces.withOperationId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Operation ID. Used only for Traces queries. +#### fn azureTraces.withQuery + +```jsonnet +azureTraces.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +KQL query to be executed. +#### fn azureTraces.withResources + +```jsonnet +azureTraces.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureTraces.withResourcesMixin + +```jsonnet +azureTraces.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureTraces.withResultFormat + +```jsonnet +azureTraces.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"`, `"logs"` + + +#### fn azureTraces.withTraceTypes + +```jsonnet +azureTraces.withTraceTypes(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Types of events to filter by. +#### fn azureTraces.withTraceTypesMixin + +```jsonnet +azureTraces.withTraceTypesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Types of events to filter by. +### obj grafanaTemplateVariableFn + + +#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQuery + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQuery + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricDefinitionsQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead +#### fn grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead +#### fn grafanaTemplateVariableFn.withMetricNamesQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamespaceQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamespaceQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceGroupsQuery + +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceGroupsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceNamesQuery + +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceNamesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withSubscriptionsQuery + +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withSubscriptionsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withUnknownQuery + +```jsonnet +grafanaTemplateVariableFn.withUnknownQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withUnknownQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withUnknownQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withWorkspacesQuery + +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withWorkspacesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj grafanaTemplateVariableFn.AppInsightsGroupByQuery + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.AppInsightsMetricNameQuery + + +##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricDefinitionsQuery + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricNamesQuery + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricNamespaceQuery + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.ResourceGroupsQuery + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.ResourceNamesQuery + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.SubscriptionsQuery + + +##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.UnknownQuery + + +##### fn grafanaTemplateVariableFn.UnknownQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.WorkspacesQuery + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchLogsQuery/logGroups.md b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchLogsQuery/logGroups.md new file mode 100644 index 00000000..a59d7777 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchLogsQuery/logGroups.md @@ -0,0 +1,57 @@ +# logGroups + + + +## Index + +* [`fn withAccountId(value)`](#fn-withaccountid) +* [`fn withAccountLabel(value)`](#fn-withaccountlabel) +* [`fn withArn(value)`](#fn-witharn) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withAccountId + +```jsonnet +withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AccountId of the log group +### fn withAccountLabel + +```jsonnet +withAccountLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Label of the log group +### fn withArn + +```jsonnet +withArn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ARN of the log group +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the log group \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md new file mode 100644 index 00000000..d2fb19d9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md new file mode 100644 index 00000000..d2fb19d9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md new file mode 100644 index 00000000..d2fb19d9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md new file mode 100644 index 00000000..d6b1381c --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md @@ -0,0 +1,1299 @@ +# cloudwatch + +grafonnet.query.cloudwatch + +## Subpackages + +* [CloudWatchLogsQuery.logGroups](CloudWatchLogsQuery/logGroups.md) +* [CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters](CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md) +* [CloudWatchMetricsQuery.sql.orderBy.parameters](CloudWatchMetricsQuery/sql/orderBy/parameters.md) +* [CloudWatchMetricsQuery.sql.select.parameters](CloudWatchMetricsQuery/sql/select/parameters.md) + +## Index + +* [`obj CloudWatchAnnotationQuery`](#obj-cloudwatchannotationquery) + * [`fn withAccountId(value)`](#fn-cloudwatchannotationquerywithaccountid) + * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) + * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) + * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-cloudwatchannotationquerywithdatasourcemixin) + * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) + * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) + * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchannotationquerywithmatchexact) + * [`fn withMetricName(value)`](#fn-cloudwatchannotationquerywithmetricname) + * [`fn withNamespace(value)`](#fn-cloudwatchannotationquerywithnamespace) + * [`fn withPeriod(value)`](#fn-cloudwatchannotationquerywithperiod) + * [`fn withPrefixMatching(value=true)`](#fn-cloudwatchannotationquerywithprefixmatching) + * [`fn withQueryMode(value)`](#fn-cloudwatchannotationquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchannotationquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchannotationquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchannotationquerywithregion) + * [`fn withStatistic(value)`](#fn-cloudwatchannotationquerywithstatistic) + * [`fn withStatistics(value)`](#fn-cloudwatchannotationquerywithstatistics) + * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) +* [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) + * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-cloudwatchlogsquerywithdatasourcemixin) + * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) + * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) + * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) + * [`fn withLogGroupNames(value)`](#fn-cloudwatchlogsquerywithloggroupnames) + * [`fn withLogGroupNamesMixin(value)`](#fn-cloudwatchlogsquerywithloggroupnamesmixin) + * [`fn withLogGroups(value)`](#fn-cloudwatchlogsquerywithloggroups) + * [`fn withLogGroupsMixin(value)`](#fn-cloudwatchlogsquerywithloggroupsmixin) + * [`fn withQueryMode(value)`](#fn-cloudwatchlogsquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchlogsquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchlogsquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) + * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) + * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) +* [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) + * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) + * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) + * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-cloudwatchmetricsquerywithdatasourcemixin) + * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) + * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) + * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) + * [`fn withHide(value=true)`](#fn-cloudwatchmetricsquerywithhide) + * [`fn withId(value)`](#fn-cloudwatchmetricsquerywithid) + * [`fn withLabel(value)`](#fn-cloudwatchmetricsquerywithlabel) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchmetricsquerywithmatchexact) + * [`fn withMetricEditorMode(value)`](#fn-cloudwatchmetricsquerywithmetriceditormode) + * [`fn withMetricName(value)`](#fn-cloudwatchmetricsquerywithmetricname) + * [`fn withMetricQueryType(value)`](#fn-cloudwatchmetricsquerywithmetricquerytype) + * [`fn withNamespace(value)`](#fn-cloudwatchmetricsquerywithnamespace) + * [`fn withPeriod(value)`](#fn-cloudwatchmetricsquerywithperiod) + * [`fn withQueryMode(value)`](#fn-cloudwatchmetricsquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchmetricsquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchmetricsquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchmetricsquerywithregion) + * [`fn withSql(value)`](#fn-cloudwatchmetricsquerywithsql) + * [`fn withSqlExpression(value)`](#fn-cloudwatchmetricsquerywithsqlexpression) + * [`fn withSqlMixin(value)`](#fn-cloudwatchmetricsquerywithsqlmixin) + * [`fn withStatistic(value)`](#fn-cloudwatchmetricsquerywithstatistic) + * [`fn withStatistics(value)`](#fn-cloudwatchmetricsquerywithstatistics) + * [`fn withStatisticsMixin(value)`](#fn-cloudwatchmetricsquerywithstatisticsmixin) + * [`obj sql`](#obj-cloudwatchmetricsquerysql) + * [`fn withFrom(value)`](#fn-cloudwatchmetricsquerysqlwithfrom) + * [`fn withFromMixin(value)`](#fn-cloudwatchmetricsquerysqlwithfrommixin) + * [`fn withGroupBy(value)`](#fn-cloudwatchmetricsquerysqlwithgroupby) + * [`fn withGroupByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithgroupbymixin) + * [`fn withLimit(value)`](#fn-cloudwatchmetricsquerysqlwithlimit) + * [`fn withOrderBy(value)`](#fn-cloudwatchmetricsquerysqlwithorderby) + * [`fn withOrderByDirection(value)`](#fn-cloudwatchmetricsquerysqlwithorderbydirection) + * [`fn withOrderByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithorderbymixin) + * [`fn withSelect(value)`](#fn-cloudwatchmetricsquerysqlwithselect) + * [`fn withSelectMixin(value)`](#fn-cloudwatchmetricsquerysqlwithselectmixin) + * [`fn withWhere(value)`](#fn-cloudwatchmetricsquerysqlwithwhere) + * [`fn withWhereMixin(value)`](#fn-cloudwatchmetricsquerysqlwithwheremixin) + * [`obj from`](#obj-cloudwatchmetricsquerysqlfrom) + * [`fn withQueryEditorFunctionExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpression) + * [`fn withQueryEditorFunctionExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpressionmixin) + * [`fn withQueryEditorPropertyExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpression) + * [`fn withQueryEditorPropertyExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpressionmixin) + * [`obj QueryEditorFunctionExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpression) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) + * [`obj QueryEditorPropertyExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpression) + * [`fn withProperty(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithproperty) + * [`fn withPropertyMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithpropertymixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithtype) + * [`obj property`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionproperty) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithname) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithtype) + * [`obj groupBy`](#obj-cloudwatchmetricsquerysqlgroupby) + * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressions) + * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressionsmixin) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithtype) + * [`obj orderBy`](#obj-cloudwatchmetricsquerysqlorderby) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbywithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlorderbywithtype) + * [`obj select`](#obj-cloudwatchmetricsquerysqlselect) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectwithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlselectwithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlselectwithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlselectwithtype) + * [`obj where`](#obj-cloudwatchmetricsquerysqlwhere) + * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressions) + * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressionsmixin) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlwherewithtype) + +## Fields + +### obj CloudWatchAnnotationQuery + + +#### fn CloudWatchAnnotationQuery.withAccountId + +```jsonnet +CloudWatchAnnotationQuery.withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +#### fn CloudWatchAnnotationQuery.withActionPrefix + +```jsonnet +CloudWatchAnnotationQuery.withActionPrefix(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use this parameter to filter the results of the operation to only those alarms +that use a certain alarm action. For example, you could specify the ARN of +an SNS topic to find all alarms that send notifications to that topic. +e.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action` +but not match `arn:aws:sns:us-east-1:123456789012:your-app-action` +#### fn CloudWatchAnnotationQuery.withAlarmNamePrefix + +```jsonnet +CloudWatchAnnotationQuery.withAlarmNamePrefix(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An alarm name prefix. If you specify this parameter, you receive information +about all alarms that have names that start with this prefix. +e.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu` +#### fn CloudWatchAnnotationQuery.withDatasource + +```jsonnet +CloudWatchAnnotationQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchAnnotationQuery.withDatasourceMixin + +```jsonnet +CloudWatchAnnotationQuery.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchAnnotationQuery.withDimensions + +```jsonnet +CloudWatchAnnotationQuery.withDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchAnnotationQuery.withDimensionsMixin + +```jsonnet +CloudWatchAnnotationQuery.withDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchAnnotationQuery.withHide + +```jsonnet +CloudWatchAnnotationQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchAnnotationQuery.withMatchExact + +```jsonnet +CloudWatchAnnotationQuery.withMatchExact(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. +#### fn CloudWatchAnnotationQuery.withMetricName + +```jsonnet +CloudWatchAnnotationQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the metric +#### fn CloudWatchAnnotationQuery.withNamespace + +```jsonnet +CloudWatchAnnotationQuery.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +#### fn CloudWatchAnnotationQuery.withPeriod + +```jsonnet +CloudWatchAnnotationQuery.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +#### fn CloudWatchAnnotationQuery.withPrefixMatching + +```jsonnet +CloudWatchAnnotationQuery.withPrefixMatching(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix +#### fn CloudWatchAnnotationQuery.withQueryMode + +```jsonnet +CloudWatchAnnotationQuery.withQueryMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + + +#### fn CloudWatchAnnotationQuery.withQueryType + +```jsonnet +CloudWatchAnnotationQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchAnnotationQuery.withRefId + +```jsonnet +CloudWatchAnnotationQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchAnnotationQuery.withRegion + +```jsonnet +CloudWatchAnnotationQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the metric +#### fn CloudWatchAnnotationQuery.withStatistic + +```jsonnet +CloudWatchAnnotationQuery.withStatistic(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +#### fn CloudWatchAnnotationQuery.withStatistics + +```jsonnet +CloudWatchAnnotationQuery.withStatistics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### fn CloudWatchAnnotationQuery.withStatisticsMixin + +```jsonnet +CloudWatchAnnotationQuery.withStatisticsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +### obj CloudWatchLogsQuery + + +#### fn CloudWatchLogsQuery.withDatasource + +```jsonnet +CloudWatchLogsQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchLogsQuery.withDatasourceMixin + +```jsonnet +CloudWatchLogsQuery.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchLogsQuery.withExpression + +```jsonnet +CloudWatchLogsQuery.withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The CloudWatch Logs Insights query to execute +#### fn CloudWatchLogsQuery.withHide + +```jsonnet +CloudWatchLogsQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchLogsQuery.withId + +```jsonnet +CloudWatchLogsQuery.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn CloudWatchLogsQuery.withLogGroupNames + +```jsonnet +CloudWatchLogsQuery.withLogGroupNames(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use logGroups +#### fn CloudWatchLogsQuery.withLogGroupNamesMixin + +```jsonnet +CloudWatchLogsQuery.withLogGroupNamesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use logGroups +#### fn CloudWatchLogsQuery.withLogGroups + +```jsonnet +CloudWatchLogsQuery.withLogGroups(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Log groups to query +#### fn CloudWatchLogsQuery.withLogGroupsMixin + +```jsonnet +CloudWatchLogsQuery.withLogGroupsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Log groups to query +#### fn CloudWatchLogsQuery.withQueryMode + +```jsonnet +CloudWatchLogsQuery.withQueryMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + + +#### fn CloudWatchLogsQuery.withQueryType + +```jsonnet +CloudWatchLogsQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchLogsQuery.withRefId + +```jsonnet +CloudWatchLogsQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchLogsQuery.withRegion + +```jsonnet +CloudWatchLogsQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the logs +#### fn CloudWatchLogsQuery.withStatsGroups + +```jsonnet +CloudWatchLogsQuery.withStatsGroups(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Fields to group the results by, this field is automatically populated whenever the query is updated +#### fn CloudWatchLogsQuery.withStatsGroupsMixin + +```jsonnet +CloudWatchLogsQuery.withStatsGroupsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Fields to group the results by, this field is automatically populated whenever the query is updated +### obj CloudWatchMetricsQuery + + +#### fn CloudWatchMetricsQuery.withAccountId + +```jsonnet +CloudWatchMetricsQuery.withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +#### fn CloudWatchMetricsQuery.withAlias + +```jsonnet +CloudWatchMetricsQuery.withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Deprecated: use label +@deprecated use label +#### fn CloudWatchMetricsQuery.withDatasource + +```jsonnet +CloudWatchMetricsQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchMetricsQuery.withDatasourceMixin + +```jsonnet +CloudWatchMetricsQuery.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +#### fn CloudWatchMetricsQuery.withDimensions + +```jsonnet +CloudWatchMetricsQuery.withDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchMetricsQuery.withDimensionsMixin + +```jsonnet +CloudWatchMetricsQuery.withDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchMetricsQuery.withExpression + +```jsonnet +CloudWatchMetricsQuery.withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Math expression query +#### fn CloudWatchMetricsQuery.withHide + +```jsonnet +CloudWatchMetricsQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchMetricsQuery.withId + +```jsonnet +CloudWatchMetricsQuery.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter. +#### fn CloudWatchMetricsQuery.withLabel + +```jsonnet +CloudWatchMetricsQuery.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details. +#### fn CloudWatchMetricsQuery.withMatchExact + +```jsonnet +CloudWatchMetricsQuery.withMatchExact(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. +#### fn CloudWatchMetricsQuery.withMetricEditorMode + +```jsonnet +CloudWatchMetricsQuery.withMetricEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +#### fn CloudWatchMetricsQuery.withMetricName + +```jsonnet +CloudWatchMetricsQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the metric +#### fn CloudWatchMetricsQuery.withMetricQueryType + +```jsonnet +CloudWatchMetricsQuery.withMetricQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +#### fn CloudWatchMetricsQuery.withNamespace + +```jsonnet +CloudWatchMetricsQuery.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +#### fn CloudWatchMetricsQuery.withPeriod + +```jsonnet +CloudWatchMetricsQuery.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +#### fn CloudWatchMetricsQuery.withQueryMode + +```jsonnet +CloudWatchMetricsQuery.withQueryMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + + +#### fn CloudWatchMetricsQuery.withQueryType + +```jsonnet +CloudWatchMetricsQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchMetricsQuery.withRefId + +```jsonnet +CloudWatchMetricsQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchMetricsQuery.withRegion + +```jsonnet +CloudWatchMetricsQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the metric +#### fn CloudWatchMetricsQuery.withSql + +```jsonnet +CloudWatchMetricsQuery.withSql(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn CloudWatchMetricsQuery.withSqlExpression + +```jsonnet +CloudWatchMetricsQuery.withSqlExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string. +#### fn CloudWatchMetricsQuery.withSqlMixin + +```jsonnet +CloudWatchMetricsQuery.withSqlMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn CloudWatchMetricsQuery.withStatistic + +```jsonnet +CloudWatchMetricsQuery.withStatistic(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +#### fn CloudWatchMetricsQuery.withStatistics + +```jsonnet +CloudWatchMetricsQuery.withStatistics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### fn CloudWatchMetricsQuery.withStatisticsMixin + +```jsonnet +CloudWatchMetricsQuery.withStatisticsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### obj CloudWatchMetricsQuery.sql + + +##### fn CloudWatchMetricsQuery.sql.withFrom + +```jsonnet +CloudWatchMetricsQuery.sql.withFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +FROM part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withFromMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +FROM part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withGroupBy + +```jsonnet +CloudWatchMetricsQuery.sql.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withGroupByMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withLimit + +```jsonnet +CloudWatchMetricsQuery.sql.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +LIMIT part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withOrderBy + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withOrderByDirection + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByDirection(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The sort order of the SQL expression, `ASC` or `DESC` +##### fn CloudWatchMetricsQuery.sql.withOrderByMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withSelect + +```jsonnet +CloudWatchMetricsQuery.sql.withSelect(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withSelectMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withSelectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withWhere + +```jsonnet +CloudWatchMetricsQuery.sql.withWhere(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withWhereMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withWhereMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### obj CloudWatchMetricsQuery.sql.from + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType() +``` + + + +###### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType() +``` + + + +####### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property + + +######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + + +##### obj CloudWatchMetricsQuery.sql.groupBy + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressions + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withType + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + + +##### obj CloudWatchMetricsQuery.sql.orderBy + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withName + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withType + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withType() +``` + + + +##### obj CloudWatchMetricsQuery.sql.select + + +###### fn CloudWatchMetricsQuery.sql.select.withName + +```jsonnet +CloudWatchMetricsQuery.sql.select.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn CloudWatchMetricsQuery.sql.select.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.select.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.select.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.select.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.select.withType + +```jsonnet +CloudWatchMetricsQuery.sql.select.withType() +``` + + + +##### obj CloudWatchMetricsQuery.sql.where + + +###### fn CloudWatchMetricsQuery.sql.where.withExpressions + +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.where.withExpressionsMixin + +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.where.withType + +```jsonnet +CloudWatchMetricsQuery.sql.where.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md new file mode 100644 index 00000000..34d28192 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md @@ -0,0 +1,32 @@ +# filters + + + +## Index + +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withQuery(value)`](#fn-withquery) + +## Fields + +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md new file mode 100644 index 00000000..d26292ae --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md @@ -0,0 +1,3256 @@ +# elasticsearch + +grafonnet.query.elasticsearch + +## Subpackages + +* [bucketAggs.Filters.settings.filters](bucketAggs/Filters/settings/filters.md) +* [metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables](metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [metrics.PipelineMetricAggregation.BucketScript.pipelineVariables](metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withBucketAggs(value)`](#fn-withbucketaggs) +* [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withMetrics(value)`](#fn-withmetrics) +* [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTimeField(value)`](#fn-withtimefield) +* [`obj bucketAggs`](#obj-bucketaggs) + * [`obj DateHistogram`](#obj-bucketaggsdatehistogram) + * [`fn withField(value)`](#fn-bucketaggsdatehistogramwithfield) + * [`fn withId(value)`](#fn-bucketaggsdatehistogramwithid) + * [`fn withSettings(value)`](#fn-bucketaggsdatehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsdatehistogramwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsdatehistogramwithtype) + * [`obj settings`](#obj-bucketaggsdatehistogramsettings) + * [`fn withInterval(value)`](#fn-bucketaggsdatehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-bucketaggsdatehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-bucketaggsdatehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-bucketaggsdatehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-bucketaggsdatehistogramsettingswithtrimedges) + * [`obj Filters`](#obj-bucketaggsfilters) + * [`fn withId(value)`](#fn-bucketaggsfilterswithid) + * [`fn withSettings(value)`](#fn-bucketaggsfilterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsfilterswithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsfilterswithtype) + * [`obj settings`](#obj-bucketaggsfilterssettings) + * [`fn withFilters(value)`](#fn-bucketaggsfilterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-bucketaggsfilterssettingswithfiltersmixin) + * [`obj GeoHashGrid`](#obj-bucketaggsgeohashgrid) + * [`fn withField(value)`](#fn-bucketaggsgeohashgridwithfield) + * [`fn withId(value)`](#fn-bucketaggsgeohashgridwithid) + * [`fn withSettings(value)`](#fn-bucketaggsgeohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsgeohashgridwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsgeohashgridwithtype) + * [`obj settings`](#obj-bucketaggsgeohashgridsettings) + * [`fn withPrecision(value)`](#fn-bucketaggsgeohashgridsettingswithprecision) + * [`obj Histogram`](#obj-bucketaggshistogram) + * [`fn withField(value)`](#fn-bucketaggshistogramwithfield) + * [`fn withId(value)`](#fn-bucketaggshistogramwithid) + * [`fn withSettings(value)`](#fn-bucketaggshistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggshistogramwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggshistogramwithtype) + * [`obj settings`](#obj-bucketaggshistogramsettings) + * [`fn withInterval(value)`](#fn-bucketaggshistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-bucketaggshistogramsettingswithmindoccount) + * [`obj Nested`](#obj-bucketaggsnested) + * [`fn withField(value)`](#fn-bucketaggsnestedwithfield) + * [`fn withId(value)`](#fn-bucketaggsnestedwithid) + * [`fn withSettings(value)`](#fn-bucketaggsnestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggsnestedwithsettingsmixin) + * [`fn withType()`](#fn-bucketaggsnestedwithtype) + * [`obj Terms`](#obj-bucketaggsterms) + * [`fn withField(value)`](#fn-bucketaggstermswithfield) + * [`fn withId(value)`](#fn-bucketaggstermswithid) + * [`fn withSettings(value)`](#fn-bucketaggstermswithsettings) + * [`fn withSettingsMixin(value)`](#fn-bucketaggstermswithsettingsmixin) + * [`fn withType()`](#fn-bucketaggstermswithtype) + * [`obj settings`](#obj-bucketaggstermssettings) + * [`fn withMinDocCount(value)`](#fn-bucketaggstermssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-bucketaggstermssettingswithmissing) + * [`fn withOrder(value)`](#fn-bucketaggstermssettingswithorder) + * [`fn withOrderBy(value)`](#fn-bucketaggstermssettingswithorderby) + * [`fn withSize(value)`](#fn-bucketaggstermssettingswithsize) +* [`obj metrics`](#obj-metrics) + * [`obj Count`](#obj-metricscount) + * [`fn withHide(value=true)`](#fn-metricscountwithhide) + * [`fn withId(value)`](#fn-metricscountwithid) + * [`fn withType()`](#fn-metricscountwithtype) + * [`obj MetricAggregationWithSettings`](#obj-metricsmetricaggregationwithsettings) + * [`obj Average`](#obj-metricsmetricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricsmetricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricsmetricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricsmetricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricsmetricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricsmetricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricsmetricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricsmetricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricsmetricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricsmetricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricsmetricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricsmetricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricsmetricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricsmetricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricsmetricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricsmetricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricsmetricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricsmetricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricsmetricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricsmetricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricsmetricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) + * [`obj PipelineMetricAggregation`](#obj-metricspipelinemetricaggregation) + * [`obj BucketScript`](#obj-metricspipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-metricspipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricspipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricspipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-metricspipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricspipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricspipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-metricspipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-metricspipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-metricspipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-metricspipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricspipelinemetricaggregationmovingaveragewithtype) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withBucketAggs + +```jsonnet +withBucketAggs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withBucketAggsMixin + +```jsonnet +withBucketAggsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withMetrics + +```jsonnet +withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMetricsMixin + +```jsonnet +withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeField + +```jsonnet +withTimeField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj bucketAggs + + +#### obj bucketAggs.DateHistogram + + +##### fn bucketAggs.DateHistogram.withField + +```jsonnet +bucketAggs.DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.DateHistogram.withId + +```jsonnet +bucketAggs.DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.DateHistogram.withSettings + +```jsonnet +bucketAggs.DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.DateHistogram.withSettingsMixin + +```jsonnet +bucketAggs.DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.DateHistogram.withType + +```jsonnet +bucketAggs.DateHistogram.withType() +``` + + + +##### obj bucketAggs.DateHistogram.settings + + +###### fn bucketAggs.DateHistogram.settings.withInterval + +```jsonnet +bucketAggs.DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withMinDocCount + +```jsonnet +bucketAggs.DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withOffset + +```jsonnet +bucketAggs.DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withTimeZone + +```jsonnet +bucketAggs.DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.DateHistogram.settings.withTrimEdges + +```jsonnet +bucketAggs.DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj bucketAggs.Filters + + +##### fn bucketAggs.Filters.withId + +```jsonnet +bucketAggs.Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Filters.withSettings + +```jsonnet +bucketAggs.Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Filters.withSettingsMixin + +```jsonnet +bucketAggs.Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Filters.withType + +```jsonnet +bucketAggs.Filters.withType() +``` + + + +##### obj bucketAggs.Filters.settings + + +###### fn bucketAggs.Filters.settings.withFilters + +```jsonnet +bucketAggs.Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn bucketAggs.Filters.settings.withFiltersMixin + +```jsonnet +bucketAggs.Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### obj bucketAggs.GeoHashGrid + + +##### fn bucketAggs.GeoHashGrid.withField + +```jsonnet +bucketAggs.GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.GeoHashGrid.withId + +```jsonnet +bucketAggs.GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.GeoHashGrid.withSettings + +```jsonnet +bucketAggs.GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.GeoHashGrid.withSettingsMixin + +```jsonnet +bucketAggs.GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.GeoHashGrid.withType + +```jsonnet +bucketAggs.GeoHashGrid.withType() +``` + + + +##### obj bucketAggs.GeoHashGrid.settings + + +###### fn bucketAggs.GeoHashGrid.settings.withPrecision + +```jsonnet +bucketAggs.GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj bucketAggs.Histogram + + +##### fn bucketAggs.Histogram.withField + +```jsonnet +bucketAggs.Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Histogram.withId + +```jsonnet +bucketAggs.Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Histogram.withSettings + +```jsonnet +bucketAggs.Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Histogram.withSettingsMixin + +```jsonnet +bucketAggs.Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Histogram.withType + +```jsonnet +bucketAggs.Histogram.withType() +``` + + + +##### obj bucketAggs.Histogram.settings + + +###### fn bucketAggs.Histogram.settings.withInterval + +```jsonnet +bucketAggs.Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Histogram.settings.withMinDocCount + +```jsonnet +bucketAggs.Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj bucketAggs.Nested + + +##### fn bucketAggs.Nested.withField + +```jsonnet +bucketAggs.Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Nested.withId + +```jsonnet +bucketAggs.Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Nested.withSettings + +```jsonnet +bucketAggs.Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Nested.withSettingsMixin + +```jsonnet +bucketAggs.Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Nested.withType + +```jsonnet +bucketAggs.Nested.withType() +``` + + + +#### obj bucketAggs.Terms + + +##### fn bucketAggs.Terms.withField + +```jsonnet +bucketAggs.Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Terms.withId + +```jsonnet +bucketAggs.Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn bucketAggs.Terms.withSettings + +```jsonnet +bucketAggs.Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Terms.withSettingsMixin + +```jsonnet +bucketAggs.Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn bucketAggs.Terms.withType + +```jsonnet +bucketAggs.Terms.withType() +``` + + + +##### obj bucketAggs.Terms.settings + + +###### fn bucketAggs.Terms.settings.withMinDocCount + +```jsonnet +bucketAggs.Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Terms.settings.withMissing + +```jsonnet +bucketAggs.Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Terms.settings.withOrder + +```jsonnet +bucketAggs.Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +###### fn bucketAggs.Terms.settings.withOrderBy + +```jsonnet +bucketAggs.Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn bucketAggs.Terms.settings.withSize + +```jsonnet +bucketAggs.Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj metrics + + +#### obj metrics.Count + + +##### fn metrics.Count.withHide + +```jsonnet +metrics.Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn metrics.Count.withId + +```jsonnet +metrics.Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn metrics.Count.withType + +```jsonnet +metrics.Count.withType() +``` + + + +#### obj metrics.MetricAggregationWithSettings + + +##### obj metrics.MetricAggregationWithSettings.Average + + +###### fn metrics.MetricAggregationWithSettings.Average.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Average.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Average.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Average.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Average.settings + + +####### fn metrics.MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Average.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.BucketScript + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.BucketScript.settings + + +####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.BucketScript.settings.script + + +######## fn metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.CumulativeSum + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.CumulativeSum.settings + + +####### fn metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Derivative + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Derivative.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Derivative.settings + + +####### fn metrics.MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +metrics.MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.ExtendedStats + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings.script + + +######## fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Logs + + +###### fn metrics.MetricAggregationWithSettings.Logs.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Logs.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Logs.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Logs.settings + + +####### fn metrics.MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +metrics.MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Max + + +###### fn metrics.MetricAggregationWithSettings.Max.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Max.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Max.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Max.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Max.settings + + +####### fn metrics.MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Max.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Min + + +###### fn metrics.MetricAggregationWithSettings.Min.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Min.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Min.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Min.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Min.settings + + +####### fn metrics.MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Min.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.MovingAverage + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +metrics.MetricAggregationWithSettings.MovingAverage.withType() +``` + + + +##### obj metrics.MetricAggregationWithSettings.MovingFunction + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.MovingFunction.settings + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### obj metrics.MetricAggregationWithSettings.MovingFunction.settings.script + + +######## fn metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Percentiles + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Percentiles.settings + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Percentiles.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Rate + + +###### fn metrics.MetricAggregationWithSettings.Rate.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Rate.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Rate.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Rate.settings + + +####### fn metrics.MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +metrics.MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.RawData + + +###### fn metrics.MetricAggregationWithSettings.RawData.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.RawData.withId + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawData.withType + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.RawData.settings + + +####### fn metrics.MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +metrics.MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.RawDocument + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.RawDocument.settings + + +####### fn metrics.MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +metrics.MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.SerialDiff + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.SerialDiff.settings + + +####### fn metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.Sum + + +###### fn metrics.MetricAggregationWithSettings.Sum.withField + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.Sum.withId + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.Sum.withType + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.Sum.settings + + +####### fn metrics.MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.MetricAggregationWithSettings.Sum.settings.script + + +######## fn metrics.MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +metrics.MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.TopMetrics + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.TopMetrics.settings + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.MetricAggregationWithSettings.UniqueCount + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.withType() +``` + + + +###### obj metrics.MetricAggregationWithSettings.UniqueCount.settings + + +####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj metrics.PipelineMetricAggregation + + +##### obj metrics.PipelineMetricAggregation.BucketScript + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withId + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.BucketScript.withType + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.withType() +``` + + + +###### obj metrics.PipelineMetricAggregation.BucketScript.settings + + +####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +####### obj metrics.PipelineMetricAggregation.BucketScript.settings.script + + +######## fn metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.PipelineMetricAggregation.CumulativeSum + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.withType() +``` + + + +###### obj metrics.PipelineMetricAggregation.CumulativeSum.settings + + +####### fn metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.PipelineMetricAggregation.Derivative + + +###### fn metrics.PipelineMetricAggregation.Derivative.withField + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withHide + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.Derivative.withId + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.Derivative.withType + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.withType() +``` + + + +###### obj metrics.PipelineMetricAggregation.Derivative.settings + + +####### fn metrics.PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +metrics.PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj metrics.PipelineMetricAggregation.MovingAverage + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn metrics.PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +metrics.PipelineMetricAggregation.MovingAverage.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md new file mode 100644 index 00000000..98f89524 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md new file mode 100644 index 00000000..98f89524 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md b/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md new file mode 100644 index 00000000..f670470e --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md @@ -0,0 +1,624 @@ +# googlecloudmonitoring + +grafonnet.query.googlecloudmonitoring + +## Index + +* [`fn withAliasBy(value)`](#fn-withaliasby) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withPromQLQuery(value)`](#fn-withpromqlquery) +* [`fn withPromQLQueryMixin(value)`](#fn-withpromqlquerymixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSloQuery(value)`](#fn-withsloquery) +* [`fn withSloQueryMixin(value)`](#fn-withsloquerymixin) +* [`fn withTimeSeriesList(value)`](#fn-withtimeserieslist) +* [`fn withTimeSeriesListMixin(value)`](#fn-withtimeserieslistmixin) +* [`fn withTimeSeriesQuery(value)`](#fn-withtimeseriesquery) +* [`fn withTimeSeriesQueryMixin(value)`](#fn-withtimeseriesquerymixin) +* [`obj promQLQuery`](#obj-promqlquery) + * [`fn withExpr(value)`](#fn-promqlquerywithexpr) + * [`fn withProjectName(value)`](#fn-promqlquerywithprojectname) + * [`fn withStep(value)`](#fn-promqlquerywithstep) +* [`obj sloQuery`](#obj-sloquery) + * [`fn withAlignmentPeriod(value)`](#fn-sloquerywithalignmentperiod) + * [`fn withGoal(value)`](#fn-sloquerywithgoal) + * [`fn withLookbackPeriod(value)`](#fn-sloquerywithlookbackperiod) + * [`fn withPerSeriesAligner(value)`](#fn-sloquerywithperseriesaligner) + * [`fn withProjectName(value)`](#fn-sloquerywithprojectname) + * [`fn withSelectorName(value)`](#fn-sloquerywithselectorname) + * [`fn withServiceId(value)`](#fn-sloquerywithserviceid) + * [`fn withServiceName(value)`](#fn-sloquerywithservicename) + * [`fn withSloId(value)`](#fn-sloquerywithsloid) + * [`fn withSloName(value)`](#fn-sloquerywithsloname) +* [`obj timeSeriesList`](#obj-timeserieslist) + * [`fn withAlignmentPeriod(value)`](#fn-timeserieslistwithalignmentperiod) + * [`fn withCrossSeriesReducer(value)`](#fn-timeserieslistwithcrossseriesreducer) + * [`fn withFilters(value)`](#fn-timeserieslistwithfilters) + * [`fn withFiltersMixin(value)`](#fn-timeserieslistwithfiltersmixin) + * [`fn withGroupBys(value)`](#fn-timeserieslistwithgroupbys) + * [`fn withGroupBysMixin(value)`](#fn-timeserieslistwithgroupbysmixin) + * [`fn withPerSeriesAligner(value)`](#fn-timeserieslistwithperseriesaligner) + * [`fn withPreprocessor(value)`](#fn-timeserieslistwithpreprocessor) + * [`fn withProjectName(value)`](#fn-timeserieslistwithprojectname) + * [`fn withSecondaryAlignmentPeriod(value)`](#fn-timeserieslistwithsecondaryalignmentperiod) + * [`fn withSecondaryCrossSeriesReducer(value)`](#fn-timeserieslistwithsecondarycrossseriesreducer) + * [`fn withSecondaryGroupBys(value)`](#fn-timeserieslistwithsecondarygroupbys) + * [`fn withSecondaryGroupBysMixin(value)`](#fn-timeserieslistwithsecondarygroupbysmixin) + * [`fn withSecondaryPerSeriesAligner(value)`](#fn-timeserieslistwithsecondaryperseriesaligner) + * [`fn withText(value)`](#fn-timeserieslistwithtext) + * [`fn withTitle(value)`](#fn-timeserieslistwithtitle) + * [`fn withView(value)`](#fn-timeserieslistwithview) +* [`obj timeSeriesQuery`](#obj-timeseriesquery) + * [`fn withGraphPeriod(value)`](#fn-timeseriesquerywithgraphperiod) + * [`fn withGraphPeriodMixin(value)`](#fn-timeseriesquerywithgraphperiodmixin) + * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) + * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) + +## Fields + +### fn withAliasBy + +```jsonnet +withAliasBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Time interval in milliseconds. +### fn withPromQLQuery + +```jsonnet +withPromQLQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withPromQLQueryMixin + +```jsonnet +withPromQLQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSloQuery + +```jsonnet +withSloQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withSloQueryMixin + +```jsonnet +withSloQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withTimeSeriesList + +```jsonnet +withTimeSeriesList(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesListMixin + +```jsonnet +withTimeSeriesListMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesQuery + +```jsonnet +withTimeSeriesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### fn withTimeSeriesQueryMixin + +```jsonnet +withTimeSeriesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### obj promQLQuery + + +#### fn promQLQuery.withExpr + +```jsonnet +promQLQuery.withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL expression/query to be executed. +#### fn promQLQuery.withProjectName + +```jsonnet +promQLQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn promQLQuery.withStep + +```jsonnet +promQLQuery.withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL min step +### obj sloQuery + + +#### fn sloQuery.withAlignmentPeriod + +```jsonnet +sloQuery.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn sloQuery.withGoal + +```jsonnet +sloQuery.withGoal(value) +``` + +PARAMETERS: + +* **value** (`number`) + +SLO goal value. +#### fn sloQuery.withLookbackPeriod + +```jsonnet +sloQuery.withLookbackPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific lookback period for the SLO. +#### fn sloQuery.withPerSeriesAligner + +```jsonnet +sloQuery.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn sloQuery.withProjectName + +```jsonnet +sloQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn sloQuery.withSelectorName + +```jsonnet +sloQuery.withSelectorName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +SLO selector. +#### fn sloQuery.withServiceId + +```jsonnet +sloQuery.withServiceId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the service the SLO is in. +#### fn sloQuery.withServiceName + +```jsonnet +sloQuery.withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name for the service the SLO is in. +#### fn sloQuery.withSloId + +```jsonnet +sloQuery.withSloId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the SLO. +#### fn sloQuery.withSloName + +```jsonnet +sloQuery.withSloName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the SLO. +### obj timeSeriesList + + +#### fn timeSeriesList.withAlignmentPeriod + +```jsonnet +timeSeriesList.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withCrossSeriesReducer + +```jsonnet +timeSeriesList.withCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withFilters + +```jsonnet +timeSeriesList.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withFiltersMixin + +```jsonnet +timeSeriesList.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withGroupBys + +```jsonnet +timeSeriesList.withGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withGroupBysMixin + +```jsonnet +timeSeriesList.withGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withPerSeriesAligner + +```jsonnet +timeSeriesList.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withPreprocessor + +```jsonnet +timeSeriesList.withPreprocessor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"rate"`, `"delta"` + +Types of pre-processor available. Defined by the metric. +#### fn timeSeriesList.withProjectName + +```jsonnet +timeSeriesList.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesList.withSecondaryAlignmentPeriod + +```jsonnet +timeSeriesList.withSecondaryAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withSecondaryCrossSeriesReducer + +```jsonnet +timeSeriesList.withSecondaryCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withSecondaryGroupBys + +```jsonnet +timeSeriesList.withSecondaryGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryGroupBysMixin + +```jsonnet +timeSeriesList.withSecondaryGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryPerSeriesAligner + +```jsonnet +timeSeriesList.withSecondaryPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withText + +```jsonnet +timeSeriesList.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation text. +#### fn timeSeriesList.withTitle + +```jsonnet +timeSeriesList.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation title. +#### fn timeSeriesList.withView + +```jsonnet +timeSeriesList.withView(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Data view, defaults to FULL. +### obj timeSeriesQuery + + +#### fn timeSeriesQuery.withGraphPeriod + +```jsonnet +timeSeriesQuery.withGraphPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +To disable the graphPeriod, it should explictly be set to 'disabled'. +#### fn timeSeriesQuery.withGraphPeriodMixin + +```jsonnet +timeSeriesQuery.withGraphPeriodMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +To disable the graphPeriod, it should explictly be set to 'disabled'. +#### fn timeSeriesQuery.withProjectName + +```jsonnet +timeSeriesQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesQuery.withQuery + +```jsonnet +timeSeriesQuery.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +MQL query to be executed. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md b/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md new file mode 100644 index 00000000..63a8f7a0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md @@ -0,0 +1,154 @@ +# grafanapyroscope + +grafonnet.query.grafanapyroscope + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) +* [`fn withMaxNodes(value)`](#fn-withmaxnodes) +* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSpanSelector(value)`](#fn-withspanselector) +* [`fn withSpanSelectorMixin(value)`](#fn-withspanselectormixin) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLabelSelector + +```jsonnet +withLabelSelector(value="{}") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"{}"` + + +### fn withMaxNodes + +```jsonnet +withMaxNodes(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withProfileTypeId + +```jsonnet +withProfileTypeId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSpanSelector + +```jsonnet +withSpanSelector(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withSpanSelectorMixin + +```jsonnet +withSpanSelectorMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/index.md b/gen/grafonnet-v11.0.0/docs/query/index.md new file mode 100644 index 00000000..270e0a83 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/index.md @@ -0,0 +1,15 @@ +# query + +grafonnet.query + +## Subpackages + +* [azuremonitor](azuremonitor/index.md) +* [cloudwatch](cloudwatch/index.md) +* [elasticsearch](elasticsearch/index.md) +* [googlecloudmonitoring](googlecloudmonitoring.md) +* [grafanapyroscope](grafanapyroscope.md) +* [loki](loki.md) +* [parca](parca.md) +* [prometheus](prometheus.md) +* [tempo](tempo/index.md) diff --git a/gen/grafonnet-v11.0.0/docs/query/loki.md b/gen/grafonnet-v11.0.0/docs/query/loki.md new file mode 100644 index 00000000..f0246b80 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/loki.md @@ -0,0 +1,181 @@ +# loki + +grafonnet.query.loki + +## Index + +* [`fn new(datasource, expr)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withLegendFormat(value)`](#fn-withlegendformat) +* [`fn withMaxLines(value)`](#fn-withmaxlines) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRange(value=true)`](#fn-withrange) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResolution(value)`](#fn-withresolution) +* [`fn withStep(value)`](#fn-withstep) + +## Fields + +### fn new + +```jsonnet +new(datasource, expr) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) + +Creates a new loki query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withInstant + +```jsonnet +withInstant(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLegendFormat + +```jsonnet +withLegendFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMaxLines + +```jsonnet +withMaxLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRange + +```jsonnet +withRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResolution + +```jsonnet +withResolution(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withStep + +```jsonnet +withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/parca.md b/gen/grafonnet-v11.0.0/docs/query/parca.md new file mode 100644 index 00000000..562caa77 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/parca.md @@ -0,0 +1,94 @@ +# parca + +grafonnet.query.parca + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) +* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLabelSelector + +```jsonnet +withLabelSelector(value="{}") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"{}"` + + +### fn withProfileTypeId + +```jsonnet +withProfileTypeId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/prometheus.md b/gen/grafonnet-v11.0.0/docs/query/prometheus.md new file mode 100644 index 00000000..054c00ae --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/prometheus.md @@ -0,0 +1,196 @@ +# prometheus + +grafonnet.query.prometheus + +## Index + +* [`fn new(datasource, expr)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withExemplar(value=true)`](#fn-withexemplar) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withIntervalFactor(value)`](#fn-withintervalfactor) +* [`fn withLegendFormat(value)`](#fn-withlegendformat) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRange(value=true)`](#fn-withrange) +* [`fn withRefId(value)`](#fn-withrefid) + +## Fields + +### fn new + +```jsonnet +new(datasource, expr) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) + +Creates a new prometheus query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withExemplar + +```jsonnet +withExemplar(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"time_series"`, `"table"`, `"heatmap"` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withInstant + +```jsonnet +withInstant(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An additional lower limit for the step parameter of the Prometheus query and for the +`$__interval` and `$__rate_interval` variables. +### fn withIntervalFactor + +```jsonnet +withIntervalFactor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the interval factor for this query. +### fn withLegendFormat + +```jsonnet +withLegendFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the legend format for this query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRange + +```jsonnet +withRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/tempo/filters.md b/gen/grafonnet-v11.0.0/docs/query/tempo/filters.md new file mode 100644 index 00000000..4482fd27 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/tempo/filters.md @@ -0,0 +1,94 @@ +# filters + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md b/gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md new file mode 100644 index 00000000..795b78ef --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md @@ -0,0 +1,94 @@ +# groupBy + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/tempo/index.md b/gen/grafonnet-v11.0.0/docs/query/tempo/index.md new file mode 100644 index 00000000..934fb7b3 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/tempo/index.md @@ -0,0 +1,289 @@ +# tempo + +grafonnet.query.tempo + +## Subpackages + +* [filters](filters.md) +* [groupBy](groupBy.md) + +## Index + +* [`fn new(datasource, query, filters)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLimit(value)`](#fn-withlimit) +* [`fn withMaxDuration(value)`](#fn-withmaxduration) +* [`fn withMinDuration(value)`](#fn-withminduration) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSearch(value)`](#fn-withsearch) +* [`fn withServiceMapIncludeNamespace(value=true)`](#fn-withservicemapincludenamespace) +* [`fn withServiceMapQuery(value)`](#fn-withservicemapquery) +* [`fn withServiceMapQueryMixin(value)`](#fn-withservicemapquerymixin) +* [`fn withServiceName(value)`](#fn-withservicename) +* [`fn withSpanName(value)`](#fn-withspanname) +* [`fn withSpss(value)`](#fn-withspss) +* [`fn withTableType(value)`](#fn-withtabletype) + +## Fields + +### fn new + +```jsonnet +new(datasource, query, filters) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **query** (`string`) +* **filters** (`array`) + +Creates a new tempo query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLimit + +```jsonnet +withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of traces that are returned from Tempo +### fn withMaxDuration + +```jsonnet +withMaxDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withMinDuration + +```jsonnet +withMinDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TraceQL query or trace ID +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSearch + +```jsonnet +withSearch(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true +### fn withServiceMapIncludeNamespace + +```jsonnet +withServiceMapIncludeNamespace(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Use service.namespace in addition to service.name to uniquely identify a service. +### fn withServiceMapQuery + +```jsonnet +withServiceMapQuery(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally. +### fn withServiceMapQueryMixin + +```jsonnet +withServiceMapQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally. +### fn withServiceName + +```jsonnet +withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by service name +### fn withSpanName + +```jsonnet +withSpanName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by span name +### fn withSpss + +```jsonnet +withSpss(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of spans per spanset that are returned from Tempo +### fn withTableType + +```jsonnet +withTableType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"traces"`, `"spans"`, `"raw"` + +The type of the table that is used to display the search results \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/role.md b/gen/grafonnet-v11.0.0/docs/role.md new file mode 100644 index 00000000..bb77d199 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/role.md @@ -0,0 +1,81 @@ +# role + +grafonnet.role + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withDisplayName(value)`](#fn-withdisplayname) +* [`fn withGroupName(value)`](#fn-withgroupname) +* [`fn withHidden(value)`](#fn-withhidden) +* [`fn withHiddenMixin(value)`](#fn-withhiddenmixin) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Role description +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display +### fn withGroupName + +```jsonnet +withGroupName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. +### fn withHidden + +```jsonnet +withHidden(value) +``` + +PARAMETERS: + +* **value** (`boolean`) + +Do not show this role +### fn withHiddenMixin + +```jsonnet +withHiddenMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`) + +Do not show this role +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The role identifier `managed:builtins:editor:permissions` \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/rolebinding.md b/gen/grafonnet-v11.0.0/docs/rolebinding.md new file mode 100644 index 00000000..9a1e904b --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/rolebinding.md @@ -0,0 +1,189 @@ +# rolebinding + +grafonnet.rolebinding + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withSubject(value)`](#fn-withsubject) +* [`fn withSubjectMixin(value)`](#fn-withsubjectmixin) +* [`obj role`](#obj-role) + * [`fn withBuiltinRoleRef(value)`](#fn-rolewithbuiltinroleref) + * [`fn withBuiltinRoleRefMixin(value)`](#fn-rolewithbuiltinrolerefmixin) + * [`fn withCustomRoleRef(value)`](#fn-rolewithcustomroleref) + * [`fn withCustomRoleRefMixin(value)`](#fn-rolewithcustomrolerefmixin) + * [`obj BuiltinRoleRef`](#obj-rolebuiltinroleref) + * [`fn withKind()`](#fn-rolebuiltinrolerefwithkind) + * [`fn withName(value)`](#fn-rolebuiltinrolerefwithname) + * [`obj CustomRoleRef`](#obj-rolecustomroleref) + * [`fn withKind()`](#fn-rolecustomrolerefwithkind) + * [`fn withName(value)`](#fn-rolecustomrolerefwithname) +* [`obj subject`](#obj-subject) + * [`fn withKind(value)`](#fn-subjectwithkind) + * [`fn withName(value)`](#fn-subjectwithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withSubject + +```jsonnet +withSubject(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSubjectMixin + +```jsonnet +withSubjectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj role + + +#### fn role.withBuiltinRoleRef + +```jsonnet +role.withBuiltinRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withBuiltinRoleRefMixin + +```jsonnet +role.withBuiltinRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRef + +```jsonnet +role.withCustomRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRefMixin + +```jsonnet +role.withCustomRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj role.BuiltinRoleRef + + +##### fn role.BuiltinRoleRef.withKind + +```jsonnet +role.BuiltinRoleRef.withKind() +``` + + + +##### fn role.BuiltinRoleRef.withName + +```jsonnet +role.BuiltinRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"viewer"`, `"editor"`, `"admin"` + + +#### obj role.CustomRoleRef + + +##### fn role.CustomRoleRef.withKind + +```jsonnet +role.CustomRoleRef.withKind() +``` + + + +##### fn role.CustomRoleRef.withName + +```jsonnet +role.CustomRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj subject + + +#### fn subject.withKind + +```jsonnet +subject.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Team"`, `"User"` + + +#### fn subject.withName + +```jsonnet +subject.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The team/user identifier name \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/team.md b/gen/grafonnet-v11.0.0/docs/team.md new file mode 100644 index 00000000..cce602b9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/team.md @@ -0,0 +1,33 @@ +# team + +grafonnet.team + +## Index + +* [`fn withEmail(value)`](#fn-withemail) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withEmail + +```jsonnet +withEmail(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Email of the team. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/util.md b/gen/grafonnet-v11.0.0/docs/util.md new file mode 100644 index 00000000..286e93c0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/util.md @@ -0,0 +1,285 @@ +# util + +Helper functions that work well with Grafonnet. + +## Index + +* [`obj dashboard`](#obj-dashboard) + * [`fn getOptionsForCustomQuery(query)`](#fn-dashboardgetoptionsforcustomquery) +* [`obj grid`](#obj-grid) + * [`fn makeGrid(panels, panelWidth, panelHeight, startY)`](#fn-gridmakegrid) + * [`fn wrapPanels(panels, panelWidth, panelHeight, startY)`](#fn-gridwrappanels) +* [`obj panel`](#obj-panel) + * [`fn calculateLowestYforPanel(panel, panels)`](#fn-panelcalculatelowestyforpanel) + * [`fn getPanelIDs(panels)`](#fn-panelgetpanelids) + * [`fn getPanelsBeforeNextRow(panels)`](#fn-panelgetpanelsbeforenextrow) + * [`fn groupPanelsInRows(panels)`](#fn-panelgrouppanelsinrows) + * [`fn mapToRows(func, panels)`](#fn-panelmaptorows) + * [`fn normalizeY(panels)`](#fn-panelnormalizey) + * [`fn normalizeYInRow(rowPanel)`](#fn-panelnormalizeyinrow) + * [`fn resolveCollapsedFlagOnRows(panels)`](#fn-panelresolvecollapsedflagonrows) + * [`fn sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8)`](#fn-panelsanitizepanel) + * [`fn setPanelIDs(panels, overrideExistingIDs=true)`](#fn-panelsetpanelids) + * [`fn sortPanelsByXY(panels)`](#fn-panelsortpanelsbyxy) + * [`fn sortPanelsInRow(rowPanel)`](#fn-panelsortpanelsinrow) + * [`fn validatePanelIDs(panels)`](#fn-panelvalidatepanelids) +* [`obj string`](#obj-string) + * [`fn slugify(string)`](#fn-stringslugify) + +## Fields + +### obj dashboard + + +#### fn dashboard.getOptionsForCustomQuery + +```jsonnet +dashboard.getOptionsForCustomQuery(query) +``` + +PARAMETERS: + +* **query** (`string`) + +`getOptionsForCustomQuery` provides values for the `options` and `current` fields. +These are required for template variables of type 'custom'but do not automatically +get populated by Grafana when importing a dashboard from JSON. + +This is a bit of a hack and should always be called on functions that set `type` on +a template variable. Ideally Grafana populates these fields from the `query` value +but this provides a backwards compatible solution. + +### obj grid + + +#### fn grid.makeGrid + +```jsonnet +grid.makeGrid(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` +and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, +then all panels below it will be folded into the row. + +This function will use the full grid of 24 columns, setting `panelWidth` to a value +that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) +Other value for `panelWidth` will leave a gap on the far right. + +Optional `startY` can be provided to place generated grid above or below existing panels. + +#### fn grid.wrapPanels + +```jsonnet +grid.wrapPanels(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. +'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + +### obj panel + + +#### fn panel.calculateLowestYforPanel + +```jsonnet +panel.calculateLowestYforPanel(panel, panels) +``` + +PARAMETERS: + +* **panel** (`object`) +* **panels** (`array`) + +`calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + +#### fn panel.getPanelIDs + +```jsonnet +panel.getPanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelIDs` returns an array with all panel IDs including IDs from panels in rows. + +#### fn panel.getPanelsBeforeNextRow + +```jsonnet +panel.getPanelsBeforeNextRow(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + +#### fn panel.groupPanelsInRows + +```jsonnet +panel.groupPanelsInRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.mapToRows + +```jsonnet +panel.mapToRows(func, panels) +``` + +PARAMETERS: + +* **func** (`function`) +* **panels** (`array`) + +`mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + +#### fn panel.normalizeY + +```jsonnet +panel.normalizeY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + +This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + +#### fn panel.normalizeYInRow + +```jsonnet +panel.normalizeYInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`normalizeYInRow` applies `normalizeY` to the panels in a row panel. + +#### fn panel.resolveCollapsedFlagOnRows + +```jsonnet +panel.resolveCollapsedFlagOnRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.sanitizePanel + +```jsonnet +panel.sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8) +``` + +PARAMETERS: + +* **panel** (`object`) +* **defaultX** (`number`) + - default value: `0` +* **defaultY** (`number`) + - default value: `0` +* **defaultHeight** (`number`) + - default value: `8` +* **defaultWidth** (`number`) + - default value: `8` + +`sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + +The default values for x,y,h,w are only applied if not already set. + +#### fn panel.setPanelIDs + +```jsonnet +panel.setPanelIDs(panels, overrideExistingIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **overrideExistingIDs** (`bool`) + - default value: `true` + +`setPanelIDs` ensures that all `panels` have a unique ID, this function is used in `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent experience. + +`overrideExistingIDs` can be set to not replace existing IDs, consider validating the IDs with `validatePanelIDs()` to ensure there are no duplicate IDs. + +#### fn panel.sortPanelsByXY + +```jsonnet +panel.sortPanelsByXY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + +#### fn panel.sortPanelsInRow + +```jsonnet +panel.sortPanelsInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + +#### fn panel.validatePanelIDs + +```jsonnet +panel.validatePanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`validatePanelIDs` validates returns `false` if there are duplicate panel IDs in `panels`. + +### obj string + + +#### fn string.slugify + +```jsonnet +string.slugify(string) +``` + +PARAMETERS: + +* **string** (`string`) + +`slugify` will create a simple slug from `string`, keeping only alphanumeric +characters and replacing spaces with dashes. diff --git a/gen/grafonnet-v11.0.0/folder.libsonnet b/gen/grafonnet-v11.0.0/folder.libsonnet new file mode 100644 index 00000000..e462d484 --- /dev/null +++ b/gen/grafonnet-v11.0.0/folder.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.folder', name: 'folder' }, + '#withParentUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'only used if nested folders are enabled' } }, + withParentUid(value): { + parentUid: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder title' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique folder id' } }, + withUid(value): { + uid: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/jsonnetfile.json b/gen/grafonnet-v11.0.0/jsonnetfile.json new file mode 100644 index 00000000..8479d5a9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/jsonnetfile.json @@ -0,0 +1,24 @@ +{ + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/docsonnet.git", + "subdir": "doc-util" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/xtd.git", + "subdir": "" + } + }, + "version": "master" + } + ], + "legacyImports": true, + "version": 1 +} \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/librarypanel.libsonnet b/gen/grafonnet-v11.0.0/librarypanel.libsonnet new file mode 100644 index 00000000..6182588f --- /dev/null +++ b/gen/grafonnet-v11.0.0/librarypanel.libsonnet @@ -0,0 +1,1130 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.librarypanel', name: 'librarypanel' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description' } }, + withDescription(value): { + description: value, + }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder UID' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { + meta: value, + }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { + meta+: value, + }, + meta+: + { + '#withConnectedDashboards': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withConnectedDashboards(value): { + meta+: { + connectedDashboards: value, + }, + }, + '#withCreated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCreated(value): { + meta+: { + created: value, + }, + }, + '#withCreatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedBy(value): { + meta+: { + createdBy: value, + }, + }, + '#withCreatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedByMixin(value): { + meta+: { + createdBy+: value, + }, + }, + createdBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { + meta+: { + createdBy+: { + avatarUrl: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + meta+: { + createdBy+: { + id: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + meta+: { + createdBy+: { + name: value, + }, + }, + }, + }, + '#withFolderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderName(value): { + meta+: { + folderName: value, + }, + }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + meta+: { + folderUid: value, + }, + }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUpdated(value): { + meta+: { + updated: value, + }, + }, + '#withUpdatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedBy(value): { + meta+: { + updatedBy: value, + }, + }, + '#withUpdatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedByMixin(value): { + meta+: { + updatedBy+: value, + }, + }, + updatedBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { + meta+: { + updatedBy+: { + avatarUrl: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + meta+: { + updatedBy+: { + id: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + meta+: { + updatedBy+: { + name: value, + }, + }, + }, + }, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + withModelMixin(value): { + model+: value, + }, + model+: + { + '#withCacheTimeout': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets panel queries cache timeout.' } }, + withCacheTimeout(value): { + model+: { + cacheTimeout: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + model+: { + datasource: value, + }, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + model+: { + datasource+: value, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + model+: { + datasource+: { + type: value, + }, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + model+: { + datasource+: { + uid: value, + }, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { + model+: { + description: value, + }, + }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfig(value): { + model+: { + fieldConfig: value, + }, + }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfigMixin(value): { + model+: { + fieldConfig+: value, + }, + }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaults(value): { + model+: { + fieldConfig+: { + defaults: value, + }, + }, + }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaultsMixin(value): { + model+: { + fieldConfig+: { + defaults+: value, + }, + }, + }, + defaults+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColor(value): { + model+: { + fieldConfig+: { + defaults+: { + color: value, + }, + }, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColorMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: value, + }, + }, + }, + }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + fixedColor: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + mode: value, + }, + }, + }, + }, + }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + seriesBy: value, + }, + }, + }, + }, + }, + }, + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustom(value): { + model+: { + fieldConfig+: { + defaults+: { + custom: value, + }, + }, + }, + }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustomMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + custom+: value, + }, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { + model+: { + fieldConfig+: { + defaults+: { + decimals: value, + }, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Human readable field metadata' } }, + withDescription(value): { + model+: { + fieldConfig+: { + defaults+: { + description: value, + }, + }, + }, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { + model+: { + fieldConfig+: { + defaults+: { + displayName: value, + }, + }, + }, + }, + '#withDisplayNameFromDS': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy.' } }, + withDisplayNameFromDS(value): { + model+: { + fieldConfig+: { + defaults+: { + displayNameFromDS: value, + }, + }, + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { + model+: { + fieldConfig+: { + defaults+: { + filterable: value, + }, + }, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { + model+: { + fieldConfig+: { + defaults+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { + model+: { + fieldConfig+: { + defaults+: { + mappings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + mappings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + mappings+: + { + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'value', + }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { + options+: { + from: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { + options+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'range', + }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { + options+: { + pattern: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'regex', + }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { + options+: { + match: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'special', + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { + model+: { + fieldConfig+: { + defaults+: { + max: value, + }, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { + model+: { + fieldConfig+: { + defaults+: { + min: value, + }, + }, + }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { + model+: { + fieldConfig+: { + defaults+: { + noValue: value, + }, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { + model+: { + fieldConfig+: { + defaults+: { + path: value, + }, + }, + }, + }, + '#withThresholds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholds(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds: value, + }, + }, + }, + }, + '#withThresholdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholdsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: value, + }, + }, + }, + }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + mode: value, + }, + }, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + steps: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + steps+: + { + '#': { help: '', name: 'steps' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { + color: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { + value: value, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { + model+: { + fieldConfig+: { + defaults+: { + unit: value, + }, + }, + }, + }, + '#withWriteable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source can write a value to the path. Auth/authz are supported separately' } }, + withWriteable(value=true): { + model+: { + fieldConfig+: { + defaults+: { + writeable: value, + }, + }, + }, + }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { + model+: { + fieldConfig+: { + overrides: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { + model+: { + fieldConfig+: { + overrides+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + overrides+: + { + '#': { help: '', name: 'overrides' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { + matcher: value, + }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { + matcher+: value, + }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + matcher+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + matcher+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + matcher+: { + options+: value, + }, + }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { + properties: + (if std.isArray(value) + then value + else [value]), + }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { + properties+: + (if std.isArray(value) + then value + else [value]), + }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { + id: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValueMixin(value): { + value+: value, + }, + }, + }, + }, + '#withHideTimeOverride': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the timeFrom or timeShift overrides are shown in the panel header' } }, + withHideTimeOverride(value=true): { + model+: { + hideTimeOverride: value, + }, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { + model+: { + interval: value, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { + model+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { + model+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { + model+: { + maxDataPoints: value, + }, + }, + '#withMaxPerRow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels' } }, + withMaxPerRow(value): { + model+: { + maxPerRow: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptions(value): { + model+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptionsMixin(value): { + model+: { + options+: value, + }, + }, + '#withPluginVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.' } }, + withPluginVersion(value): { + model+: { + pluginVersion: value, + }, + }, + '#withQueryCachingTTL': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Overrides the data source configured time-to-live for a query cache item in milliseconds' } }, + withQueryCachingTTL(value): { + model+: { + queryCachingTTL: value, + }, + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + model+: { + repeat: value, + }, + }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { + model+: { + repeatDirection: value, + }, + }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { + model+: { + targets: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { + model+: { + targets+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { + model+: { + timeFrom: value, + }, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { + model+: { + timeShift: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { + model+: { + title: value, + }, + }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { + model+: { + transformations: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { + model+: { + transformations+: + (if std.isArray(value) + then value + else [value]), + }, + }, + transformations+: + { + '#': { help: '', name: 'transformations' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { + disabled: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + filter+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + filter+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + filter+: { + options+: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { + id: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withTopic': { 'function': { args: [{ default: null, enums: ['series', 'annotations', 'alertStates'], name: 'value', type: ['string'] }], help: 'Where to pull DataFrames from as input to transformation' } }, + withTopic(value): { + topic: value, + }, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { + model+: { + transparent: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { + model+: { + type: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel name (also saved in the model)' } }, + withName(value): { + name: value, + }, + '#withSchemaVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Dashboard version when this was saved (zero if unknown)' } }, + withSchemaVersion(value): { + schemaVersion: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel type (from inside the model)' } }, + withType(value): { + type: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library element UID' } }, + withUid(value): { + uid: value, + }, + '#withVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'panel version, incremented each time the dashboard is updated.' } }, + withVersion(value): { + version: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/main.libsonnet b/gen/grafonnet-v11.0.0/main.libsonnet new file mode 100644 index 00000000..f4688b2e --- /dev/null +++ b/gen/grafonnet-v11.0.0/main.libsonnet @@ -0,0 +1,26 @@ +// This file is generated, do not manually edit. +{ + '#': { + filename: 'main.libsonnet', + help: 'Jsonnet library for rendering Grafana resources\n## Install\n\n```\njb install github.com/grafana/grafonnet/gen/grafonnet-v11.0.0@main\n```\n\n## Usage\n\n```jsonnet\nlocal grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet"\n```\n', + 'import': 'github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet', + installTemplate: '\n## Install\n\n```\njb install %(url)s@%(version)s\n```\n', + name: 'grafonnet', + url: 'github.com/grafana/grafonnet/gen/grafonnet-v11.0.0', + usageTemplate: '\n## Usage\n\n```jsonnet\nlocal %(name)s = import "%(import)s"\n```\n', + version: 'main', + }, + accesspolicy: import 'accesspolicy.libsonnet', + dashboard: import 'dashboard.libsonnet', + librarypanel: import 'librarypanel.libsonnet', + preferences: import 'preferences.libsonnet', + publicdashboard: import 'publicdashboard.libsonnet', + role: import 'role.libsonnet', + rolebinding: import 'rolebinding.libsonnet', + team: import 'team.libsonnet', + folder: import 'folder.libsonnet', + panel: import 'panelindex.libsonnet', + query: import 'query.libsonnet', + util: import 'custom/util/main.libsonnet', + alerting: import 'alerting.libsonnet', +} diff --git a/gen/grafonnet-v11.0.0/panel.libsonnet b/gen/grafonnet-v11.0.0/panel.libsonnet new file mode 100644 index 00000000..14bf068e --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel.libsonnet @@ -0,0 +1,791 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + panelOptions+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { + title: value, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { + description: value, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { + transparent: value, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { + links: + (if std.isArray(value) + then value + else [value]), + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { + links+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + repeat: value, + }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { + repeatDirection: value, + }, + '#withPluginVersion': { 'function': { args: [], help: '' } }, + withPluginVersion(): { + pluginVersion: 'v11.0.0', + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { + type: value, + }, + link+: + { + '#': { help: '', name: 'link' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + }, + queryOptions+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { + interval: value, + }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { + timeFrom: value, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { + timeShift: value, + }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { + targets: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { + targets+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { + transformations: + (if std.isArray(value) + then value + else [value]), + }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { + transformations+: + (if std.isArray(value) + then value + else [value]), + }, + transformation+: + { + '#': { help: '', name: 'transformation' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { + disabled: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + filter+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + filter+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + filter+: { + options+: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { + id: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withTopic': { 'function': { args: [{ default: null, enums: ['series', 'annotations', 'alertStates'], name: 'value', type: ['string'] }], help: 'Where to pull DataFrames from as input to transformation' } }, + withTopic(value): { + topic: value, + }, + }, + }, + standardOptions+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { + fieldConfig+: { + defaults+: { + unit: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { + fieldConfig+: { + defaults+: { + min: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { + fieldConfig+: { + defaults+: { + max: value, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { + fieldConfig+: { + defaults+: { + decimals: value, + }, + }, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { + fieldConfig+: { + defaults+: { + displayName: value, + }, + }, + }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { + fieldConfig+: { + defaults+: { + color+: { + fixedColor: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + color+: { + mode: value, + }, + }, + }, + }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { + fieldConfig+: { + defaults+: { + color+: { + seriesBy: value, + }, + }, + }, + }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { + fieldConfig+: { + defaults+: { + noValue: value, + }, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { + fieldConfig+: { + defaults+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { + fieldConfig+: { + defaults+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { + fieldConfig+: { + defaults+: { + mappings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { + fieldConfig+: { + defaults+: { + mappings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { + fieldConfig+: { + overrides: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { + fieldConfig+: { + overrides+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { + fieldConfig+: { + defaults+: { + filterable: value, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { + fieldConfig+: { + defaults+: { + path: value, + }, + }, + }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + mode: value, + }, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + steps: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + mapping+: + { + '#': { help: '', name: 'mapping' }, + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'value', + }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { + options+: { + from: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { + options+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'range', + }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { + options+: { + pattern: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'regex', + }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { + options+: { + match: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'special', + }, + }, + }, + threshold+: { + step+: + { + '#': { help: '', name: 'step' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { + color: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { + value: value, + }, + }, + }, + override+: + { + '#': { help: '', name: 'override' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { + matcher: value, + }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { + matcher+: value, + }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + matcher+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + matcher+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + matcher+: { + options+: value, + }, + }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { + properties: + (if std.isArray(value) + then value + else [value]), + }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { + properties+: + (if std.isArray(value) + then value + else [value]), + }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { + id: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValueMixin(value): { + value+: value, + }, + }, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + libraryPanel+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel name' } }, + withName(value): { + libraryPanel+: { + name: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel uid' } }, + withUid(value): { + libraryPanel+: { + uid: value, + }, + }, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { + gridPos+: { + h: value, + }, + }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { + gridPos+: { + static: value, + }, + }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { + gridPos+: { + w: value, + }, + }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { + gridPos+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { + gridPos+: { + y: value, + }, + }, + }, +} ++ (import 'custom/panel.libsonnet') diff --git a/gen/grafonnet-v11.0.0/panel/alertList.libsonnet b/gen/grafonnet-v11.0.0/panel/alertList.libsonnet new file mode 100644 index 00000000..da5434e6 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/alertList.libsonnet @@ -0,0 +1,19 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.alertList', name: 'alertList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'alertlist', + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet b/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet new file mode 100644 index 00000000..c44d746f --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet @@ -0,0 +1,94 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.annotationsList', name: 'annotationsList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'annolist', + }, + }, + options+: + { + '#withLimit': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value=10): { + options+: { + limit: value, + }, + }, + '#withNavigateAfter': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateAfter(value='10m'): { + options+: { + navigateAfter: value, + }, + }, + '#withNavigateBefore': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateBefore(value='10m'): { + options+: { + navigateBefore: value, + }, + }, + '#withNavigateToPanel': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNavigateToPanel(value=true): { + options+: { + navigateToPanel: value, + }, + }, + '#withOnlyFromThisDashboard': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyFromThisDashboard(value=true): { + options+: { + onlyFromThisDashboard: value, + }, + }, + '#withOnlyInTimeRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyInTimeRange(value=true): { + options+: { + onlyInTimeRange: value, + }, + }, + '#withShowTags': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTags(value=true): { + options+: { + showTags: value, + }, + }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { + options+: { + showTime: value, + }, + }, + '#withShowUser': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUser(value=true): { + options+: { + showUser: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/barChart.libsonnet b/gen/grafonnet-v11.0.0/panel/barChart.libsonnet new file mode 100644 index 00000000..af33b763 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/barChart.libsonnet @@ -0,0 +1,553 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barChart', name: 'barChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'barchart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withBarRadius': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Controls the radius of each bar.' } }, + withBarRadius(value=0): { + options+: { + barRadius: value, + }, + }, + '#withBarWidth': { 'function': { args: [{ default: 0.96999999999999997, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of bars. 1 = Max width, 0 = Min width.' } }, + withBarWidth(value=0.96999999999999997): { + options+: { + barWidth: value, + }, + }, + '#withColorByField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use the color value for a sibling field to color each bar value.' } }, + withColorByField(value): { + options+: { + colorByField: value, + }, + }, + '#withFullHighlight': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area' } }, + withFullHighlight(value=true): { + options+: { + fullHighlight: value, + }, + }, + '#withGroupWidth': { 'function': { args: [{ default: 0.69999999999999996, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of groups. 1 = max with, 0 = min width.' } }, + withGroupWidth(value=0.69999999999999996): { + options+: { + groupWidth: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withStacking(value): { + options+: { + stacking: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Manually select which field from the dataset to represent the x field.' } }, + withXField(value): { + options+: { + xField: value, + }, + }, + '#withXTickLabelMaxLength': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the max length that a label can have before it is truncated.' } }, + withXTickLabelMaxLength(value): { + options+: { + xTickLabelMaxLength: value, + }, + }, + '#withXTickLabelRotation': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the rotation of the x axis labels.' } }, + withXTickLabelRotation(value=0): { + options+: { + xTickLabelRotation: value, + }, + }, + '#withXTickLabelSpacing': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior' } }, + withXTickLabelSpacing(value=0): { + options+: { + xTickLabelSpacing: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet b/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet new file mode 100644 index 00000000..1560e5e7 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet @@ -0,0 +1,168 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barGauge', name: 'barGauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bargauge', + }, + }, + options+: + { + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withDisplayMode(value): { + options+: { + displayMode: value, + }, + }, + '#withMaxVizHeight': { 'function': { args: [{ default: 300, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxVizHeight(value=300): { + options+: { + maxVizHeight: value, + }, + }, + '#withMinVizHeight': { 'function': { args: [{ default: 16, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=16): { + options+: { + minVizHeight: value, + }, + }, + '#withMinVizWidth': { 'function': { args: [{ default: 8, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=8): { + options+: { + minVizWidth: value, + }, + }, + '#withNamePlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'left'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge name to be placed explicitly' } }, + withNamePlacement(value): { + options+: { + namePlacement: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowUnfilled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUnfilled(value=true): { + options+: { + showUnfilled: value, + }, + }, + '#withSizing': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge size to be set explicitly' } }, + withSizing(value): { + options+: { + sizing: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withValueMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueMode(value): { + options+: { + valueMode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet new file mode 100644 index 00000000..721c4baa --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet @@ -0,0 +1,830 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.candlestick', name: 'candlestick' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'candlestick', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCandleStyle': { 'function': { args: [{ default: null, enums: ['candles', 'ohlcbars'], name: 'value', type: ['string'] }], help: '' } }, + withCandleStyle(value): { + options+: { + candleStyle: value, + }, + }, + '#withColorStrategy': { 'function': { args: [{ default: null, enums: ['open-close', 'close-close'], name: 'value', type: ['string'] }], help: '' } }, + withColorStrategy(value): { + options+: { + colorStrategy: value, + }, + }, + '#withColors': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColors(value): { + options+: { + colors: value, + }, + }, + '#withColorsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorsMixin(value): { + options+: { + colors+: value, + }, + }, + colors+: + { + '#withDown': { 'function': { args: [{ default: 'red', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDown(value='red'): { + options+: { + colors+: { + down: value, + }, + }, + }, + '#withFlat': { 'function': { args: [{ default: 'gray', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFlat(value='gray'): { + options+: { + colors+: { + flat: value, + }, + }, + }, + '#withUp': { 'function': { args: [{ default: 'green', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUp(value='green'): { + options+: { + colors+: { + up: value, + }, + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFields(value): { + options+: { + fields: value, + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldsMixin(value): { + options+: { + fields+: value, + }, + }, + fields+: + { + '#withClose': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the final (end) value of the given period' } }, + withClose(value): { + options+: { + fields+: { + close: value, + }, + }, + }, + '#withHigh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the highest value of the given period' } }, + withHigh(value): { + options+: { + fields+: { + high: value, + }, + }, + }, + '#withLow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the lowest value of the given period' } }, + withLow(value): { + options+: { + fields+: { + low: value, + }, + }, + }, + '#withOpen': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the starting value of the given period' } }, + withOpen(value): { + options+: { + fields+: { + open: value, + }, + }, + }, + '#withVolume': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the sample count in the given period. (e.g. number of trades)' } }, + withVolume(value): { + options+: { + fields+: { + volume: value, + }, + }, + }, + }, + '#withIncludeAllFields': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled, all fields will be sent to the graph' } }, + withIncludeAllFields(value=true): { + options+: { + includeAllFields: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['candles+volume', 'candles', 'volume'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/canvas.libsonnet b/gen/grafonnet-v11.0.0/panel/canvas.libsonnet new file mode 100644 index 00000000..2d7be5f0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/canvas.libsonnet @@ -0,0 +1,544 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.canvas', name: 'canvas' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'canvas', + }, + }, + options+: + { + '#withInfinitePan': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable infinite pan' } }, + withInfinitePan(value=true): { + options+: { + infinitePan: value, + }, + }, + '#withInlineEditing': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable inline editing' } }, + withInlineEditing(value=true): { + options+: { + inlineEditing: value, + }, + }, + '#withPanZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable pan and zoom' } }, + withPanZoom(value=true): { + options+: { + panZoom: value, + }, + }, + '#withRoot': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRoot(value): { + options+: { + root: value, + }, + }, + '#withRootMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRootMixin(value): { + options+: { + root+: value, + }, + }, + root+: + { + '#withElements': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElements(value): { + options+: { + root+: { + elements: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withElementsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElementsMixin(value): { + options+: { + root+: { + elements+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + elements+: + { + '#': { help: '', name: 'elements' }, + '#withBackground': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackground(value): { + background: value, + }, + '#withBackgroundMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundMixin(value): { + background+: value, + }, + background+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + background+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + background+: { + color+: value, + }, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + background+: { + color+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + background+: { + color+: { + fixed: value, + }, + }, + }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { + background+: { + image: value, + }, + }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { + background+: { + image+: value, + }, + }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + background+: { + image+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + background+: { + image+: { + fixed: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + background+: { + image+: { + mode: value, + }, + }, + }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + background+: { + size: value, + }, + }, + }, + '#withBorder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorder(value): { + border: value, + }, + '#withBorderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorderMixin(value): { + border+: value, + }, + border+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + border+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + border+: { + color+: value, + }, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + border+: { + color+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + border+: { + color+: { + fixed: value, + }, + }, + }, + }, + '#withRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRadius(value): { + border+: { + radius: value, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + border+: { + width: value, + }, + }, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfig(value): { + config: value, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfigMixin(value): { + config+: value, + }, + '#withConnections': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnections(value): { + connections: + (if std.isArray(value) + then value + else [value]), + }, + '#withConnectionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnectionsMixin(value): { + connections+: + (if std.isArray(value) + then value + else [value]), + }, + connections+: + { + '#': { help: '', name: 'connections' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + color: value, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + color+: value, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + color+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + color+: { + fixed: value, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { + path: value, + }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { + size: value, + }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { + size+: value, + }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + size+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + size+: { + fixed: value, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + size+: { + max: value, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + size+: { + min: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + size+: { + mode: value, + }, + }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { + source: value, + }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { + source+: value, + }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + source+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + source+: { + y: value, + }, + }, + }, + '#withSourceOriginal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceOriginal(value): { + sourceOriginal: value, + }, + '#withSourceOriginalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceOriginalMixin(value): { + sourceOriginal+: value, + }, + sourceOriginal+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + sourceOriginal+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + sourceOriginal+: { + y: value, + }, + }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { + target: value, + }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { + target+: value, + }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + target+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + target+: { + y: value, + }, + }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { + targetName: value, + }, + '#withTargetOriginal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetOriginal(value): { + targetOriginal: value, + }, + '#withTargetOriginalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetOriginalMixin(value): { + targetOriginal+: value, + }, + targetOriginal+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + targetOriginal+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + targetOriginal+: { + y: value, + }, + }, + }, + '#withVertices': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withVertices(value): { + vertices: + (if std.isArray(value) + then value + else [value]), + }, + '#withVerticesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withVerticesMixin(value): { + vertices+: + (if std.isArray(value) + then value + else [value]), + }, + vertices+: + { + '#': { help: '', name: 'vertices' }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + x: value, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + y: value, + }, + }, + }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { + constraint: value, + }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { + constraint+: value, + }, + constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { + constraint+: { + horizontal: value, + }, + }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { + constraint+: { + vertical: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { + placement: value, + }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { + placement+: value, + }, + placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { + placement+: { + bottom: value, + }, + }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { + placement+: { + height: value, + }, + }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { + placement+: { + left: value, + }, + }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { + placement+: { + right: value, + }, + }, + '#withRotation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRotation(value): { + placement+: { + rotation: value, + }, + }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { + placement+: { + top: value, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + placement+: { + width: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the root element' } }, + withName(value): { + options+: { + root+: { + name: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: 'Type of root element (frame)' } }, + withType(): { + options+: { + root+: { + type: 'frame', + }, + }, + }, + }, + '#withShowAdvancedTypes': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show all available element types' } }, + withShowAdvancedTypes(value=true): { + options+: { + showAdvancedTypes: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet new file mode 100644 index 00000000..9e7ccd1f --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet @@ -0,0 +1,100 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.dashboardList', name: 'dashboardList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'dashlist', + }, + }, + options+: + { + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'folderId is deprecated, and migrated to folderUid on panel init' } }, + withFolderId(value): { + options+: { + folderId: value, + }, + }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + options+: { + folderUID: value, + }, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIncludeVars(value=true): { + options+: { + includeVars: value, + }, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withKeepTime(value=true): { + options+: { + keepTime: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxItems(value=10): { + options+: { + maxItems: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value=''): { + options+: { + query: value, + }, + }, + '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowHeadings(value=true): { + options+: { + showHeadings: value, + }, + }, + '#withShowRecentlyViewed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowRecentlyViewed(value=true): { + options+: { + showRecentlyViewed: value, + }, + }, + '#withShowSearch': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowSearch(value=true): { + options+: { + showSearch: value, + }, + }, + '#withShowStarred': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowStarred(value=true): { + options+: { + showStarred: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet b/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet new file mode 100644 index 00000000..6763f6d4 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.datagrid', name: 'datagrid' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'datagrid', + }, + }, + options+: + { + '#withSelectedSeries': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSelectedSeries(value=0): { + options+: { + selectedSeries: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/debug.libsonnet b/gen/grafonnet-v11.0.0/panel/debug.libsonnet new file mode 100644 index 00000000..cc668311 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/debug.libsonnet @@ -0,0 +1,67 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.debug', name: 'debug' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'debug', + }, + }, + options+: + { + '#withCounters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCounters(value): { + options+: { + counters: value, + }, + }, + '#withCountersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCountersMixin(value): { + options+: { + counters+: value, + }, + }, + counters+: + { + '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDataChanged(value=true): { + options+: { + counters+: { + dataChanged: value, + }, + }, + }, + '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRender(value=true): { + options+: { + counters+: { + render: value, + }, + }, + }, + '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSchemaChanged(value=true): { + options+: { + counters+: { + schemaChanged: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/gauge.libsonnet b/gen/grafonnet-v11.0.0/panel/gauge.libsonnet new file mode 100644 index 00000000..93b56530 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/gauge.libsonnet @@ -0,0 +1,150 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.gauge', name: 'gauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'gauge', + }, + }, + options+: + { + '#withMinVizHeight': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=75): { + options+: { + minVizHeight: value, + }, + }, + '#withMinVizWidth': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=75): { + options+: { + minVizWidth: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowThresholdLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdLabels(value=true): { + options+: { + showThresholdLabels: value, + }, + }, + '#withShowThresholdMarkers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdMarkers(value=true): { + options+: { + showThresholdMarkers: value, + }, + }, + '#withSizing': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge size to be set explicitly' } }, + withSizing(value): { + options+: { + sizing: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/geomap.libsonnet b/gen/grafonnet-v11.0.0/panel/geomap.libsonnet new file mode 100644 index 00000000..b0750681 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/geomap.libsonnet @@ -0,0 +1,486 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.geomap', name: 'geomap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'geomap', + }, + }, + options+: + { + '#withBasemap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemap(value): { + options+: { + basemap: value, + }, + }, + '#withBasemapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemapMixin(value): { + options+: { + basemap+: value, + }, + }, + basemap+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { + options+: { + basemap+: { + config: value, + }, + }, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfigMixin(value): { + options+: { + basemap+: { + config+: value, + }, + }, + }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { + options+: { + basemap+: { + filterData: value, + }, + }, + }, + '#withFilterDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterDataMixin(value): { + options+: { + basemap+: { + filterData+: value, + }, + }, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { + options+: { + basemap+: { + location: value, + }, + }, + }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { + options+: { + basemap+: { + location+: value, + }, + }, + }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { + options+: { + basemap+: { + location+: { + gazetteer: value, + }, + }, + }, + }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { + options+: { + basemap+: { + location+: { + geohash: value, + }, + }, + }, + }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { + options+: { + basemap+: { + location+: { + latitude: value, + }, + }, + }, + }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { + options+: { + basemap+: { + location+: { + longitude: value, + }, + }, + }, + }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { + options+: { + basemap+: { + location+: { + lookup: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + basemap+: { + location+: { + mode: value, + }, + }, + }, + }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { + options+: { + basemap+: { + location+: { + wkt: value, + }, + }, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { + options+: { + basemap+: { + name: value, + }, + }, + }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { + options+: { + basemap+: { + opacity: value, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { + options+: { + basemap+: { + tooltip: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + options+: { + basemap+: { + type: value, + }, + }, + }, + }, + '#withControls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControls(value): { + options+: { + controls: value, + }, + }, + '#withControlsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsMixin(value): { + options+: { + controls+: value, + }, + }, + controls+: + { + '#withMouseWheelZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'let the mouse wheel zoom' } }, + withMouseWheelZoom(value=true): { + options+: { + controls+: { + mouseWheelZoom: value, + }, + }, + }, + '#withShowAttribution': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Lower right' } }, + withShowAttribution(value=true): { + options+: { + controls+: { + showAttribution: value, + }, + }, + }, + '#withShowDebug': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show debug' } }, + withShowDebug(value=true): { + options+: { + controls+: { + showDebug: value, + }, + }, + }, + '#withShowMeasure': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show measure' } }, + withShowMeasure(value=true): { + options+: { + controls+: { + showMeasure: value, + }, + }, + }, + '#withShowScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Scale options' } }, + withShowScale(value=true): { + options+: { + controls+: { + showScale: value, + }, + }, + }, + '#withShowZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Zoom (upper left)' } }, + withShowZoom(value=true): { + options+: { + controls+: { + showZoom: value, + }, + }, + }, + }, + '#withLayers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayers(value): { + options+: { + layers: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLayersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayersMixin(value): { + options+: { + layers+: + (if std.isArray(value) + then value + else [value]), + }, + }, + layers+: + { + '#': { help: '', name: 'layers' }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { + config: value, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfigMixin(value): { + config+: value, + }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { + filterData: value, + }, + '#withFilterDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterDataMixin(value): { + filterData+: value, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { + location+: value, + }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { + location+: { + gazetteer: value, + }, + }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { + location+: { + geohash: value, + }, + }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { + location+: { + latitude: value, + }, + }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { + location+: { + longitude: value, + }, + }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { + location+: { + lookup: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + location+: { + mode: value, + }, + }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { + location+: { + wkt: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { + name: value, + }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { + opacity: value, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withView(value): { + options+: { + view: value, + }, + }, + '#withViewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withViewMixin(value): { + options+: { + view+: value, + }, + }, + view+: + { + '#withAllLayers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAllLayers(value=true): { + options+: { + view+: { + allLayers: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: 'zero', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value='zero'): { + options+: { + view+: { + id: value, + }, + }, + }, + '#withLastOnly': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLastOnly(value=true): { + options+: { + view+: { + lastOnly: value, + }, + }, + }, + '#withLat': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLat(value=0): { + options+: { + view+: { + lat: value, + }, + }, + }, + '#withLayer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLayer(value): { + options+: { + view+: { + layer: value, + }, + }, + }, + '#withLon': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLon(value=0): { + options+: { + view+: { + lon: value, + }, + }, + }, + '#withMaxZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxZoom(value): { + options+: { + view+: { + maxZoom: value, + }, + }, + }, + '#withMinZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinZoom(value): { + options+: { + view+: { + minZoom: value, + }, + }, + }, + '#withPadding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withPadding(value): { + options+: { + view+: { + padding: value, + }, + }, + }, + '#withShared': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShared(value=true): { + options+: { + view+: { + shared: value, + }, + }, + }, + '#withZoom': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withZoom(value=1): { + options+: { + view+: { + zoom: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet b/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet new file mode 100644 index 00000000..bbd5fc04 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet @@ -0,0 +1,839 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.heatmap', name: 'heatmap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'heatmap', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCalculate': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the heatmap should be calculated from data' } }, + withCalculate(value=true): { + options+: { + calculate: value, + }, + }, + '#withCalculation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculation(value): { + options+: { + calculation: value, + }, + }, + '#withCalculationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculationMixin(value): { + options+: { + calculation+: value, + }, + }, + calculation+: + { + '#withXBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBuckets(value): { + options+: { + calculation+: { + xBuckets: value, + }, + }, + }, + '#withXBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBucketsMixin(value): { + options+: { + calculation+: { + xBuckets+: value, + }, + }, + }, + xBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + calculation+: { + xBuckets+: { + mode: value, + }, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { + options+: { + calculation+: { + xBuckets+: { + scale: value, + }, + }, + }, + }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: value, + }, + }, + }, + }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { + options+: { + calculation+: { + xBuckets+: { + value: value, + }, + }, + }, + }, + }, + '#withYBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBuckets(value): { + options+: { + calculation+: { + yBuckets: value, + }, + }, + }, + '#withYBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBucketsMixin(value): { + options+: { + calculation+: { + yBuckets+: value, + }, + }, + }, + yBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + calculation+: { + yBuckets+: { + mode: value, + }, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { + options+: { + calculation+: { + yBuckets+: { + scale: value, + }, + }, + }, + }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: value, + }, + }, + }, + }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { + options+: { + calculation+: { + yBuckets+: { + value: value, + }, + }, + }, + }, + }, + }, + '#withCellGap': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls gap between cells' } }, + withCellGap(value=1): { + options+: { + cellGap: value, + }, + }, + '#withCellRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls cell radius' } }, + withCellRadius(value): { + options+: { + cellRadius: value, + }, + }, + '#withCellValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValues(value): { + options+: { + cellValues: value, + }, + }, + '#withCellValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValuesMixin(value): { + options+: { + cellValues+: value, + }, + }, + cellValues+: + { + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for cell values' } }, + withDecimals(value): { + options+: { + cellValues+: { + decimals: value, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the cell value unit' } }, + withUnit(value): { + options+: { + cellValues+: { + unit: value, + }, + }, + }, + }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withColor(value): { + options+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withColorMixin(value): { + options+: { + color+: value, + }, + }, + color+: + { + '#withExponent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the exponent when scale is set to exponential' } }, + withExponent(value): { + options+: { + color+: { + exponent: value, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color fill when in opacity mode' } }, + withFill(value): { + options+: { + color+: { + fill: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the color scale' } }, + withMax(value): { + options+: { + color+: { + max: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the color scale' } }, + withMin(value): { + options+: { + color+: { + min: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withMode(value): { + options+: { + color+: { + mode: value, + }, + }, + }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the color scheme' } }, + withReverse(value=true): { + options+: { + color+: { + reverse: value, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withScale(value): { + options+: { + color+: { + scale: value, + }, + }, + }, + '#withScheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color scheme used' } }, + withScheme(value): { + options+: { + color+: { + scheme: value, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the number of color steps' } }, + withSteps(value): { + options+: { + color+: { + steps: value, + }, + }, + }, + }, + '#withExemplars': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplars(value): { + options+: { + exemplars: value, + }, + }, + '#withExemplarsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarsMixin(value): { + options+: { + exemplars+: value, + }, + }, + exemplars+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color of the exemplar markers' } }, + withColor(value): { + options+: { + exemplars+: { + color: value, + }, + }, + }, + }, + '#withFilterValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValues(value): { + options+: { + filterValues: value, + }, + }, + '#withFilterValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValuesMixin(value): { + options+: { + filterValues+: value, + }, + }, + filterValues+: + { + '#withGe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values greater than or equal to the given value' } }, + withGe(value): { + options+: { + filterValues+: { + ge: value, + }, + }, + }, + '#withLe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values less than or equal to the given value' } }, + withLe(value): { + options+: { + filterValues+: { + le: value, + }, + }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the legend is shown' } }, + withShow(value=true): { + options+: { + legend+: { + show: value, + }, + }, + }, + }, + '#withRowsFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrame(value): { + options+: { + rowsFrame: value, + }, + }, + '#withRowsFrameMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrameMixin(value): { + options+: { + rowsFrame+: value, + }, + }, + rowsFrame+: + { + '#withLayout': { 'function': { args: [{ default: null, enums: ['le', 'ge', 'unknown', 'auto'], name: 'value', type: ['string'] }], help: '' } }, + withLayout(value): { + options+: { + rowsFrame+: { + layout: value, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the name of the cell when not calculating from data' } }, + withValue(value): { + options+: { + rowsFrame+: { + value: value, + }, + }, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withShowColorScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a color scale in header' } }, + withShowColorScale(value=true): { + options+: { + tooltip+: { + showColorScale: value, + }, + }, + }, + '#withYHistogram': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a histogram of the y-axis values' } }, + withYHistogram(value=true): { + options+: { + tooltip+: { + yHistogram: value, + }, + }, + }, + }, + '#withYAxis': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxis(value): { + options+: { + yAxis: value, + }, + }, + '#withYAxisMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisMixin(value): { + options+: { + yAxis+: value, + }, + }, + yAxis+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + options+: { + yAxis+: { + axisBorderShow: value, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + options+: { + yAxis+: { + axisCenteredZero: value, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + options+: { + yAxis+: { + axisColorMode: value, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + options+: { + yAxis+: { + axisGridShow: value, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + options+: { + yAxis+: { + axisLabel: value, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + options+: { + yAxis+: { + axisPlacement: value, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + options+: { + yAxis+: { + axisSoftMax: value, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + options+: { + yAxis+: { + axisSoftMin: value, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + options+: { + yAxis+: { + axisWidth: value, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for yAxis values' } }, + withDecimals(value): { + options+: { + yAxis+: { + decimals: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the yAxis' } }, + withMax(value): { + options+: { + yAxis+: { + max: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the yAxis' } }, + withMin(value): { + options+: { + yAxis+: { + min: value, + }, + }, + }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the yAxis' } }, + withReverse(value=true): { + options+: { + yAxis+: { + reverse: value, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + options+: { + yAxis+: { + scaleDistribution: value, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + options+: { + yAxis+: { + scaleDistribution+: value, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + yAxis+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + yAxis+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + yAxis+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the yAxis unit' } }, + withUnit(value): { + options+: { + yAxis+: { + unit: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/histogram.libsonnet b/gen/grafonnet-v11.0.0/panel/histogram.libsonnet new file mode 100644 index 00000000..d875c920 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/histogram.libsonnet @@ -0,0 +1,486 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.histogram', name: 'histogram' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'histogram', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withBucketCount': { 'function': { args: [{ default: 30, enums: null, name: 'value', type: ['integer'] }], help: 'Bucket count (approx)' } }, + withBucketCount(value=30): { + options+: { + bucketCount: value, + }, + }, + '#withBucketOffset': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Offset buckets by this amount' } }, + withBucketOffset(value=0): { + options+: { + bucketOffset: value, + }, + }, + '#withBucketSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Size of each bucket' } }, + withBucketSize(value): { + options+: { + bucketSize: value, + }, + }, + '#withCombine': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Combines multiple series into a single histogram' } }, + withCombine(value=true): { + options+: { + combine: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/logs.libsonnet b/gen/grafonnet-v11.0.0/panel/logs.libsonnet new file mode 100644 index 00000000..219e5146 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/logs.libsonnet @@ -0,0 +1,76 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.logs', name: 'logs' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'logs', + }, + }, + options+: + { + '#withDedupStrategy': { 'function': { args: [{ default: null, enums: ['none', 'exact', 'numbers', 'signature'], name: 'value', type: ['string'] }], help: '' } }, + withDedupStrategy(value): { + options+: { + dedupStrategy: value, + }, + }, + '#withEnableLogDetails': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnableLogDetails(value=true): { + options+: { + enableLogDetails: value, + }, + }, + '#withPrettifyLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPrettifyLogMessage(value=true): { + options+: { + prettifyLogMessage: value, + }, + }, + '#withShowCommonLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowCommonLabels(value=true): { + options+: { + showCommonLabels: value, + }, + }, + '#withShowLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLabels(value=true): { + options+: { + showLabels: value, + }, + }, + '#withShowLogContextToggle': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLogContextToggle(value=true): { + options+: { + showLogContextToggle: value, + }, + }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { + options+: { + showTime: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: ['Descending', 'Ascending'], name: 'value', type: ['string'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withWrapLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapLogMessage(value=true): { + options+: { + wrapLogMessage: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/news.libsonnet b/gen/grafonnet-v11.0.0/panel/news.libsonnet new file mode 100644 index 00000000..734f07c2 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/news.libsonnet @@ -0,0 +1,34 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.news', name: 'news' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'news', + }, + }, + options+: + { + '#withFeedUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'empty/missing will default to grafana blog' } }, + withFeedUrl(value): { + options+: { + feedUrl: value, + }, + }, + '#withShowImage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowImage(value=true): { + options+: { + showImage: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet b/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet new file mode 100644 index 00000000..8ba36a4f --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet @@ -0,0 +1,118 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.nodeGraph', name: 'nodeGraph' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'nodeGraph', + }, + }, + options+: + { + '#withEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdges(value): { + options+: { + edges: value, + }, + }, + '#withEdgesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgesMixin(value): { + options+: { + edges+: value, + }, + }, + edges+: + { + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { + options+: { + edges+: { + mainStatUnit: value, + }, + }, + }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { + options+: { + edges+: { + secondaryStatUnit: value, + }, + }, + }, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { + options+: { + nodes: value, + }, + }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { + options+: { + nodes+: value, + }, + }, + nodes+: + { + '#withArcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcs(value): { + options+: { + nodes+: { + arcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withArcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcsMixin(value): { + options+: { + nodes+: { + arcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + arcs+: + { + '#': { help: '', name: 'arcs' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { + color: value, + }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { + field: value, + }, + }, + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { + options+: { + nodes+: { + mainStatUnit: value, + }, + }, + }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { + options+: { + nodes+: { + secondaryStatUnit: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet b/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet new file mode 100644 index 00000000..b5d13ddb --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet @@ -0,0 +1,380 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.pieChart', name: 'pieChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'piechart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withDisplayLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabels(value): { + options+: { + displayLabels: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDisplayLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabelsMixin(value): { + options+: { + displayLabels+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValues(value): { + options+: { + legend+: { + values: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValuesMixin(value): { + options+: { + legend+: { + values+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withPieType': { 'function': { args: [{ default: null, enums: ['pie', 'donut'], name: 'value', type: ['string'] }], help: 'Select the pie chart display style.' } }, + withPieType(value): { + options+: { + pieType: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/row.libsonnet b/gen/grafonnet-v11.0.0/panel/row.libsonnet new file mode 100644 index 00000000..1548d38a --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/row.libsonnet @@ -0,0 +1,103 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.row', name: 'row' }, + '#withCollapsed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether this row should be collapsed or not.' } }, + withCollapsed(value=true): { + collapsed: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withGridPos': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPos(value): { + gridPos: value, + }, + '#withGridPosMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPosMixin(value): { + gridPos+: value, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { + gridPos+: { + h: value, + }, + }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { + gridPos+: { + static: value, + }, + }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { + gridPos+: { + w: value, + }, + }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { + gridPos+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { + gridPos+: { + y: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.' } }, + withId(value): { + id: value, + }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { + panels: + (if std.isArray(value) + then value + else [value]), + }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { + panels+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + repeat: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Row title' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'row', + }, +} ++ (import '../custom/row.libsonnet') diff --git a/gen/grafonnet-v11.0.0/panel/stat.libsonnet b/gen/grafonnet-v11.0.0/panel/stat.libsonnet new file mode 100644 index 00000000..9591569a --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/stat.libsonnet @@ -0,0 +1,156 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stat', name: 'stat' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'stat', + }, + }, + options+: + { + '#withColorMode': { 'function': { args: [{ default: null, enums: ['value', 'background', 'background_solid', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withColorMode(value): { + options+: { + colorMode: value, + }, + }, + '#withGraphMode': { 'function': { args: [{ default: null, enums: ['none', 'line', 'area'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGraphMode(value): { + options+: { + graphMode: value, + }, + }, + '#withJustifyMode': { 'function': { args: [{ default: null, enums: ['auto', 'center'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withJustifyMode(value): { + options+: { + justifyMode: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowPercentChange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowPercentChange(value=true): { + options+: { + showPercentChange: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTextMode': { 'function': { args: [{ default: null, enums: ['auto', 'value', 'value_and_name', 'name', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTextMode(value): { + options+: { + textMode: value, + }, + }, + '#withWideLayout': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWideLayout(value=true): { + options+: { + wideLayout: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet b/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet new file mode 100644 index 00000000..8978708c --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet @@ -0,0 +1,309 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stateTimeline', name: 'stateTimeline' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'state-timeline', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=0): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withAlignValue': { 'function': { args: [{ default: null, enums: ['center', 'left', 'right'], name: 'value', type: ['string'] }], help: 'Controls the value alignment in the TimelineChart component' } }, + withAlignValue(value): { + options+: { + alignValue: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMergeValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Merge equal consecutive values' } }, + withMergeValues(value=true): { + options+: { + mergeValues: value, + }, + }, + '#withRowHeight': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Controls the row height' } }, + withRowHeight(value=0.90000000000000002): { + options+: { + rowHeight: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + timezone+: + { + '#withTimeZoneUtc': { 'function': { args: [], help: 'Use UTC/GMT timezone' } }, + withTimeZoneUtc(): { + TimeZoneUtc: 'utc', + }, + '#withTimeZoneBrowser': { 'function': { args: [], help: 'Use the timezone defined by end user web browser' } }, + withTimeZoneBrowser(): { + TimeZoneBrowser: 'browser', + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet b/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet new file mode 100644 index 00000000..bfe62828 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet @@ -0,0 +1,303 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.statusHistory', name: 'statusHistory' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'status-history', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withColWidth': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Controls the column width' } }, + withColWidth(value=0.90000000000000002): { + options+: { + colWidth: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withRowHeight': { 'function': { args: [{ default: 0.90000000000000002, enums: null, name: 'value', type: ['number'] }], help: 'Set the height of the rows' } }, + withRowHeight(value=0.90000000000000002): { + options+: { + rowHeight: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + timezone+: + { + '#withTimeZoneUtc': { 'function': { args: [], help: 'Use UTC/GMT timezone' } }, + withTimeZoneUtc(): { + TimeZoneUtc: 'utc', + }, + '#withTimeZoneBrowser': { 'function': { args: [], help: 'Use the timezone defined by end user web browser' } }, + withTimeZoneBrowser(): { + TimeZoneBrowser: 'browser', + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/table.libsonnet b/gen/grafonnet-v11.0.0/panel/table.libsonnet new file mode 100644 index 00000000..cab12430 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/table.libsonnet @@ -0,0 +1,1274 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.table', name: 'table' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'table', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAlign': { 'function': { args: [{ default: null, enums: ['auto', 'left', 'right', 'center'], name: 'value', type: ['string'] }], help: 'TODO -- should not be table specific!\nTODO docs' } }, + withAlign(value): { + fieldConfig+: { + defaults+: { + custom+: { + align: value, + }, + }, + }, + }, + '#withCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions: value, + }, + }, + }, + }, + '#withCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: value, + }, + }, + }, + }, + cellOptions+: + { + '#withTableAutoCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableAutoCellOptions: value, + }, + }, + }, + }, + }, + '#withTableAutoCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableAutoCellOptions+: value, + }, + }, + }, + }, + }, + TableAutoCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'auto', + }, + }, + }, + }, + }, + }, + '#withTableSparklineCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableSparklineCellOptions: value, + }, + }, + }, + }, + }, + '#withTableSparklineCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableSparklineCellOptions+: value, + }, + }, + }, + }, + }, + TableSparklineCellOptions+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisBorderShow: value, + }, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisCenteredZero: value, + }, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisColorMode: value, + }, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisGridShow: value, + }, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisLabel: value, + }, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisPlacement: value, + }, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisSoftMax: value, + }, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisSoftMin: value, + }, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisWidth: value, + }, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barAlignment: value, + }, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barMaxWidth: value, + }, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barWidthFactor: value, + }, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + drawStyle: value, + }, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillBelowTo: value, + }, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillColor: value, + }, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillOpacity: value, + }, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + gradientMode: value, + }, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom: value, + }, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: value, + }, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + }, + '#withHideValue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHideValue(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideValue: value, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineColor: value, + }, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineInterpolation: value, + }, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle: value, + }, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: value, + }, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineWidth: value, + }, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointColor: value, + }, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointSize: value, + }, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointSymbol: value, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution: value, + }, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: value, + }, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + showPoints: value, + }, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + spanNulls: value, + }, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + spanNulls+: value, + }, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking: value, + }, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: value, + }, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle: value, + }, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle+: value, + }, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + transform: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'sparkline', + }, + }, + }, + }, + }, + }, + '#withTableBarGaugeCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableBarGaugeCellOptions: value, + }, + }, + }, + }, + }, + '#withTableBarGaugeCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableBarGaugeCellOptions+: value, + }, + }, + }, + }, + }, + TableBarGaugeCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + mode: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'gauge', + }, + }, + }, + }, + }, + '#withValueDisplayMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueDisplayMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + valueDisplayMode: value, + }, + }, + }, + }, + }, + }, + '#withTableColoredBackgroundCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColoredBackgroundCellOptions: value, + }, + }, + }, + }, + }, + '#withTableColoredBackgroundCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColoredBackgroundCellOptions+: value, + }, + }, + }, + }, + }, + TableColoredBackgroundCellOptions+: + { + '#withApplyToRow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withApplyToRow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + applyToRow: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'gradient'], name: 'value', type: ['string'] }], help: 'Display mode to the "Colored Background" display\nmode for table cells. Either displays a solid color (basic mode)\nor a gradient.' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + mode: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'color-background', + }, + }, + }, + }, + }, + }, + '#withTableColorTextCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColorTextCellOptions: value, + }, + }, + }, + }, + }, + '#withTableColorTextCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColorTextCellOptions+: value, + }, + }, + }, + }, + }, + TableColorTextCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'color-text', + }, + }, + }, + }, + }, + }, + '#withTableImageCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableImageCellOptions: value, + }, + }, + }, + }, + }, + '#withTableImageCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableImageCellOptions+: value, + }, + }, + }, + }, + }, + TableImageCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'image', + }, + }, + }, + }, + }, + }, + '#withTableDataLinksCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Show data links in the cell' } }, + withTableDataLinksCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableDataLinksCellOptions: value, + }, + }, + }, + }, + }, + '#withTableDataLinksCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Show data links in the cell' } }, + withTableDataLinksCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableDataLinksCellOptions+: value, + }, + }, + }, + }, + }, + TableDataLinksCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'data-links', + }, + }, + }, + }, + }, + }, + '#withTableJsonViewCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableJsonViewCellOptions: value, + }, + }, + }, + }, + }, + '#withTableJsonViewCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableJsonViewCellOptions+: value, + }, + }, + }, + }, + }, + TableJsonViewCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'json-view', + }, + }, + }, + }, + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['auto', 'color-text', 'color-background', 'color-background-solid', 'gradient-gauge', 'lcd-gauge', 'json-view', 'basic', 'image', 'gauge', 'sparkline', 'data-links', 'custom'], name: 'value', type: ['string'] }], help: "Internally, this is the \"type\" of cell that's being displayed\nin the table such as colored text, JSON, gauge, etc.\nThe color-background-solid, gradient-gauge, and lcd-gauge\nmodes are deprecated in favor of new cell subOptions" } }, + withDisplayMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + displayMode: value, + }, + }, + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFilterable(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + filterable: value, + }, + }, + }, + }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '?? default is missing or false ??' } }, + withHidden(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hidden: value, + }, + }, + }, + }, + '#withHideHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Hides any header for a column, useful for columns that show some static content or buttons.' } }, + withHideHeader(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideHeader: value, + }, + }, + }, + }, + '#withInspect': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInspect(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + inspect: value, + }, + }, + }, + }, + '#withMinWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMinWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + minWidth: value, + }, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + width: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCellHeight': { 'function': { args: [{ default: null, enums: ['sm', 'md', 'lg'], name: 'value', type: ['string'] }], help: 'Height of a table cell' } }, + withCellHeight(value): { + options+: { + cellHeight: value, + }, + }, + '#withFooter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withFooter(value): { + options+: { + footer: value, + }, + }, + '#withFooterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withFooterMixin(value): { + options+: { + footer+: value, + }, + }, + footer+: + { + '#withCountRows': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withCountRows(value=true): { + options+: { + footer+: { + countRows: value, + }, + }, + }, + '#withEnablePagination': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnablePagination(value=true): { + options+: { + footer+: { + enablePagination: value, + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { + options+: { + footer+: { + fields: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { + options+: { + footer+: { + fields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'actually 1 value' } }, + withReducer(value): { + options+: { + footer+: { + reducer: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'actually 1 value' } }, + withReducerMixin(value): { + options+: { + footer+: { + reducer+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShow(value=true): { + options+: { + footer+: { + show: value, + }, + }, + }, + }, + '#withFrameIndex': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Represents the index of the selected frame' } }, + withFrameIndex(value=0): { + options+: { + frameIndex: value, + }, + }, + '#withShowHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the panel should show the header' } }, + withShowHeader(value=true): { + options+: { + showHeader: value, + }, + }, + '#withShowTypeIcons': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the header should show icons for the column types' } }, + withShowTypeIcons(value=true): { + options+: { + showTypeIcons: value, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortBy(value): { + options+: { + sortBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSortByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortByMixin(value): { + options+: { + sortBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + sortBy+: + { + '#': { help: '', name: 'sortBy' }, + '#withDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag used to indicate descending sort order' } }, + withDesc(value=true): { + desc: value, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the display name of the field to sort by' } }, + withDisplayName(value): { + displayName: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/text.libsonnet b/gen/grafonnet-v11.0.0/panel/text.libsonnet new file mode 100644 index 00000000..066fe626 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/text.libsonnet @@ -0,0 +1,73 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.text', name: 'text' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'text', + }, + }, + options+: + { + '#withCode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCode(value): { + options+: { + code: value, + }, + }, + '#withCodeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeMixin(value): { + options+: { + code+: value, + }, + }, + code+: + { + '#withLanguage': { 'function': { args: [{ default: null, enums: ['json', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'plaintext'], name: 'value', type: ['string'] }], help: '' } }, + withLanguage(value): { + options+: { + code+: { + language: value, + }, + }, + }, + '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLineNumbers(value=true): { + options+: { + code+: { + showLineNumbers: value, + }, + }, + }, + '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowMiniMap(value=true): { + options+: { + code+: { + showMiniMap: value, + }, + }, + }, + }, + '#withContent': { 'function': { args: [{ default: '# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withContent(value='# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)'): { + options+: { + content: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet new file mode 100644 index 00000000..25525317 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet @@ -0,0 +1,747 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.timeSeries', name: 'timeSeries' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'timeseries', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + timezone+: + { + '#withTimeZoneUtc': { 'function': { args: [], help: 'Use UTC/GMT timezone' } }, + withTimeZoneUtc(): { + TimeZoneUtc: 'utc', + }, + '#withTimeZoneBrowser': { 'function': { args: [], help: 'Use the timezone defined by end user web browser' } }, + withTimeZoneBrowser(): { + TimeZoneBrowser: 'browser', + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/trend.libsonnet b/gen/grafonnet-v11.0.0/panel/trend.libsonnet new file mode 100644 index 00000000..1e4a1b65 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/trend.libsonnet @@ -0,0 +1,718 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.trend', name: 'trend' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'trend', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the x field to use (defaults to first number)' } }, + withXField(value): { + options+: { + xField: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet b/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet new file mode 100644 index 00000000..868d0390 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet @@ -0,0 +1,1070 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.xyChart', name: 'xyChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'xychart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + label: value, + }, + }, + }, + }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue: value, + }, + }, + }, + }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: value, + }, + }, + }, + }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + fixed: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: value, + }, + }, + }, + }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: { + fixed: value, + }, + }, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: value, + }, + }, + }, + }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: { + fixed: value, + }, + }, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: value, + }, + }, + }, + }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + fixed: value, + }, + }, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + max: value, + }, + }, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + min: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { + fieldConfig+: { + defaults+: { + custom+: { + show: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withDims': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration for the Table/Auto mode' } }, + withDims(value): { + options+: { + dims: value, + }, + }, + '#withDimsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration for the Table/Auto mode' } }, + withDimsMixin(value): { + options+: { + dims+: value, + }, + }, + dims+: + { + '#withExclude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExclude(value): { + options+: { + dims+: { + exclude: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExcludeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExcludeMixin(value): { + options+: { + dims+: { + exclude+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFrame(value): { + options+: { + dims+: { + frame: value, + }, + }, + }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { + options+: { + dims+: { + x: value, + }, + }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withSeries': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Manual Mode' } }, + withSeries(value): { + options+: { + series: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSeriesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Manual Mode' } }, + withSeriesMixin(value): { + options+: { + series+: + (if std.isArray(value) + then value + else [value]), + }, + }, + series+: + { + '#': { help: '', name: 'series' }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + axisBorderShow: value, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + axisCenteredZero: value, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + axisColorMode: value, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + axisGridShow: value, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + axisLabel: value, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + axisPlacement: value, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + axisSoftMax: value, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + axisSoftMin: value, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + axisWidth: value, + }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFrame(value): { + frame: value, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + hideFrom: value, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + hideFrom+: value, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + hideFrom+: { + legend: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + hideFrom+: { + tooltip: value, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + hideFrom+: { + viz: value, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { + label: value, + }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { + labelValue: value, + }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { + labelValue+: value, + }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + labelValue+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + labelValue+: { + fixed: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + labelValue+: { + mode: value, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { + lineColor: value, + }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { + lineColor+: value, + }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + lineColor+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + lineColor+: { + fixed: value, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + lineStyle: value, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + lineStyle+: value, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + lineStyle+: { + fill: value, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { + lineWidth: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { + pointColor: value, + }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { + pointColor+: value, + }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + pointColor+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + pointColor+: { + fixed: value, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { + pointSize: value, + }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { + pointSize+: value, + }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + pointSize+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + pointSize+: { + fixed: value, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + pointSize+: { + max: value, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + pointSize+: { + min: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + pointSize+: { + mode: value, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + scaleDistribution: value, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + scaleDistribution+: value, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + scaleDistribution+: { + linearThreshold: value, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + scaleDistribution+: { + log: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + scaleDistribution+: { + type: value, + }, + }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { + show: value, + }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { + x: value, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withY(value): { + y: value, + }, + }, + '#withSeriesMapping': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Auto is "table" in the UI' } }, + withSeriesMapping(value): { + options+: { + seriesMapping: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/panelindex.libsonnet b/gen/grafonnet-v11.0.0/panelindex.libsonnet new file mode 100644 index 00000000..cffcdad0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/panelindex.libsonnet @@ -0,0 +1,30 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + alertList: import 'panel/alertList.libsonnet', + annotationsList: import 'panel/annotationsList.libsonnet', + barChart: import 'panel/barChart.libsonnet', + barGauge: import 'panel/barGauge.libsonnet', + candlestick: import 'panel/candlestick.libsonnet', + canvas: import 'panel/canvas.libsonnet', + dashboardList: import 'panel/dashboardList.libsonnet', + datagrid: import 'panel/datagrid.libsonnet', + debug: import 'panel/debug.libsonnet', + gauge: import 'panel/gauge.libsonnet', + geomap: import 'panel/geomap.libsonnet', + heatmap: import 'panel/heatmap.libsonnet', + histogram: import 'panel/histogram.libsonnet', + logs: import 'panel/logs.libsonnet', + news: import 'panel/news.libsonnet', + nodeGraph: import 'panel/nodeGraph.libsonnet', + pieChart: import 'panel/pieChart.libsonnet', + stat: import 'panel/stat.libsonnet', + stateTimeline: import 'panel/stateTimeline.libsonnet', + statusHistory: import 'panel/statusHistory.libsonnet', + table: import 'panel/table.libsonnet', + text: import 'panel/text.libsonnet', + timeSeries: import 'panel/timeSeries.libsonnet', + trend: import 'panel/trend.libsonnet', + xyChart: import 'panel/xyChart.libsonnet', + row: import 'panel/row.libsonnet', +} diff --git a/gen/grafonnet-v11.0.0/preferences.libsonnet b/gen/grafonnet-v11.0.0/preferences.libsonnet new file mode 100644 index 00000000..e91b0377 --- /dev/null +++ b/gen/grafonnet-v11.0.0/preferences.libsonnet @@ -0,0 +1,88 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.preferences', name: 'preferences' }, + '#withCookiePreferences': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCookiePreferences(value): { + cookiePreferences: value, + }, + '#withCookiePreferencesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCookiePreferencesMixin(value): { + cookiePreferences+: value, + }, + cookiePreferences+: + { + '#withAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalytics(value): { + cookiePreferences+: { + analytics: value, + }, + }, + '#withAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalyticsMixin(value): { + cookiePreferences+: { + analytics+: value, + }, + }, + '#withFunctional': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctional(value): { + cookiePreferences+: { + functional: value, + }, + }, + '#withFunctionalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctionalMixin(value): { + cookiePreferences+: { + functional+: value, + }, + }, + '#withPerformance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformance(value): { + cookiePreferences+: { + performance: value, + }, + }, + '#withPerformanceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformanceMixin(value): { + cookiePreferences+: { + performance+: value, + }, + }, + }, + '#withHomeDashboardUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID for the home dashboard' } }, + withHomeDashboardUID(value): { + homeDashboardUID: value, + }, + '#withLanguage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Selected language (beta)' } }, + withLanguage(value): { + language: value, + }, + '#withQueryHistory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryHistory(value): { + queryHistory: value, + }, + '#withQueryHistoryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryHistoryMixin(value): { + queryHistory+: value, + }, + queryHistory+: + { + '#withHomeTab': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "one of: '' | 'query' | 'starred';" } }, + withHomeTab(value): { + queryHistory+: { + homeTab: value, + }, + }, + }, + '#withTheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'light, dark, empty is default' } }, + withTheme(value): { + theme: value, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The timezone selection\nTODO: this should use the timezone defined in common' } }, + withTimezone(value): { + timezone: value, + }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'day of the week (sunday, monday, etc)' } }, + withWeekStart(value): { + weekStart: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/publicdashboard.libsonnet b/gen/grafonnet-v11.0.0/publicdashboard.libsonnet new file mode 100644 index 00000000..200e6382 --- /dev/null +++ b/gen/grafonnet-v11.0.0/publicdashboard.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.publicdashboard', name: 'publicdashboard' }, + '#withAccessToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public access token' } }, + withAccessToken(value): { + accessToken: value, + }, + '#withAnnotationsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if annotations are enabled' } }, + withAnnotationsEnabled(value=true): { + annotationsEnabled: value, + }, + '#withDashboardUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Dashboard unique identifier referenced by this public dashboard' } }, + withDashboardUid(value): { + dashboardUid: value, + }, + '#withIsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the public dashboard is enabled' } }, + withIsEnabled(value=true): { + isEnabled: value, + }, + '#withTimeSelectionEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the time range picker is enabled' } }, + withTimeSelectionEnabled(value=true): { + timeSelectionEnabled: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public dashboard identifier' } }, + withUid(value): { + uid: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/query.libsonnet b/gen/grafonnet-v11.0.0/query.libsonnet new file mode 100644 index 00000000..27a01fa9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query.libsonnet @@ -0,0 +1,13 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query', name: 'query' }, + azuremonitor: import 'query/azuremonitor.libsonnet', + cloudwatch: import 'query/cloudwatch.libsonnet', + elasticsearch: import 'query/elasticsearch.libsonnet', + googlecloudmonitoring: import 'query/googlecloudmonitoring.libsonnet', + grafanapyroscope: import 'query/grafanapyroscope.libsonnet', + loki: import 'query/loki.libsonnet', + parca: import 'query/parca.libsonnet', + prometheus: import 'query/prometheus.libsonnet', + tempo: import 'query/tempo.libsonnet', +} diff --git a/gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet b/gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet new file mode 100644 index 00000000..03370ff8 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet @@ -0,0 +1,859 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.azuremonitor', name: 'azuremonitor' }, + '#withAzureLogAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalytics(value): { + azureLogAnalytics: value, + }, + '#withAzureLogAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalyticsMixin(value): { + azureLogAnalytics+: value, + }, + azureLogAnalytics+: + { + '#withDashboardTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false.' } }, + withDashboardTime(value=true): { + azureLogAnalytics+: { + dashboardTime: value, + }, + }, + '#withIntersectTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated Use dashboardTime instead' } }, + withIntersectTime(value=true): { + azureLogAnalytics+: { + intersectTime: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { + azureLogAnalytics+: { + query: value, + }, + }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResource(value): { + azureLogAnalytics+: { + resource: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureLogAnalytics+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureLogAnalytics+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace', 'logs'], name: 'value', type: ['string'] }], help: '' } }, + withResultFormat(value): { + azureLogAnalytics+: { + resultFormat: value, + }, + }, + '#withTimeColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated' } }, + withTimeColumn(value): { + azureLogAnalytics+: { + timeColumn: value, + }, + }, + '#withWorkspace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Workspace ID. This was removed in Grafana 8, but remains for backwards compat.' } }, + withWorkspace(value): { + azureLogAnalytics+: { + workspace: value, + }, + }, + }, + '#withAzureMonitor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureMonitor(value): { + azureMonitor: value, + }, + '#withAzureMonitorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureMonitorMixin(value): { + azureMonitor+: value, + }, + azureMonitor+: + { + '#withAggregation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.' } }, + withAggregation(value): { + azureMonitor+: { + aggregation: value, + }, + }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.' } }, + withAlias(value): { + azureMonitor+: { + alias: value, + }, + }, + '#withAllowedTimeGrainsMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMs(value): { + azureMonitor+: { + allowedTimeGrainsMs: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withAllowedTimeGrainsMsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMsMixin(value): { + azureMonitor+: { + allowedTimeGrainsMs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withCustomNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Used as the value for the metricNamespace property when it's different from the resource namespace." } }, + withCustomNamespace(value): { + azureMonitor+: { + customNamespace: value, + }, + }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimension(value): { + azureMonitor+: { + dimension: value, + }, + }, + '#withDimensionFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimensionFilter(value): { + azureMonitor+: { + dimensionFilter: value, + }, + }, + '#withDimensionFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFilters(value): { + azureMonitor+: { + dimensionFilters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDimensionFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFiltersMixin(value): { + azureMonitor+: { + dimensionFilters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + dimensionFilters+: + { + '#': { help: '', name: 'dimensionFilters' }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of Dimension to be filtered on.' } }, + withDimension(value): { + dimension: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated filter is deprecated in favour of filters to support multiselect.' } }, + withFilter(value): { + filter: value, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators." } }, + withOperator(value): { + operator: value, + }, + }, + '#withMetricDefinition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use metricNamespace instead' } }, + withMetricDefinition(value): { + azureMonitor+: { + metricDefinition: value, + }, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The metric to query data for within the specified metricNamespace. e.g. UsedCapacity' } }, + withMetricName(value): { + azureMonitor+: { + metricName: value, + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "metricNamespace is used as the resource type (or resource namespace).\nIt's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts\nKept the name of the variable as metricNamespace to avoid backward incompatibility issues." } }, + withMetricNamespace(value): { + azureMonitor+: { + metricNamespace: value, + }, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The Azure region containing the resource(s).' } }, + withRegion(value): { + azureMonitor+: { + region: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceGroup(value): { + azureMonitor+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceName(value): { + azureMonitor+: { + resourceName: value, + }, + }, + '#withResourceUri': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resourceGroup, resourceName and metricNamespace instead' } }, + withResourceUri(value): { + azureMonitor+: { + resourceUri: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureMonitor+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureMonitor+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + resources+: + { + '#': { help: '', name: 'resources' }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + metricNamespace: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value): { + region: value, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + resourceGroup: value, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + resourceName: value, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + subscription: value, + }, + }, + '#withTimeGrain': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The granularity of data points to be queried. Defaults to auto.' } }, + withTimeGrain(value): { + azureMonitor+: { + timeGrain: value, + }, + }, + '#withTimeGrainUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated' } }, + withTimeGrainUnit(value): { + azureMonitor+: { + timeGrainUnit: value, + }, + }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Maximum number of records to return. Defaults to 10.' } }, + withTop(value): { + azureMonitor+: { + top: value, + }, + }, + }, + '#withAzureResourceGraph': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureResourceGraph(value): { + azureResourceGraph: value, + }, + '#withAzureResourceGraphMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureResourceGraphMixin(value): { + azureResourceGraph+: value, + }, + azureResourceGraph+: + { + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Resource Graph KQL query to be executed.' } }, + withQuery(value): { + azureResourceGraph+: { + query: value, + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the format results should be returned as. Defaults to table.' } }, + withResultFormat(value): { + azureResourceGraph+: { + resultFormat: value, + }, + }, + }, + '#withAzureTraces': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTraces(value): { + azureTraces: value, + }, + '#withAzureTracesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTracesMixin(value): { + azureTraces+: value, + }, + azureTraces+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFilters(value): { + azureTraces+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFiltersMixin(value): { + azureTraces+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + '#withOperation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Comparison operator to use. Either equals or not equals.' } }, + withOperation(value): { + operation: value, + }, + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Property name, auto-populated based on available traces.' } }, + withProperty(value): { + property: value, + }, + }, + '#withOperationId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Operation ID. Used only for Traces queries.' } }, + withOperationId(value): { + azureTraces+: { + operationId: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { + azureTraces+: { + query: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureTraces+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureTraces+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace', 'logs'], name: 'value', type: ['string'] }], help: '' } }, + withResultFormat(value): { + azureTraces+: { + resultFormat: value, + }, + }, + '#withTraceTypes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypes(value): { + azureTraces+: { + traceTypes: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTraceTypesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypesMixin(value): { + azureTraces+: { + traceTypes+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withGrafanaTemplateVariableFn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '' } }, + withGrafanaTemplateVariableFn(value): { + grafanaTemplateVariableFn: value, + }, + '#withGrafanaTemplateVariableFnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '' } }, + withGrafanaTemplateVariableFnMixin(value): { + grafanaTemplateVariableFn+: value, + }, + grafanaTemplateVariableFn+: + { + '#withAppInsightsMetricNameQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQuery(value): { + grafanaTemplateVariableFn+: { + AppInsightsMetricNameQuery: value, + }, + }, + '#withAppInsightsMetricNameQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQueryMixin(value): { + grafanaTemplateVariableFn+: { + AppInsightsMetricNameQuery+: value, + }, + }, + AppInsightsMetricNameQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'AppInsightsMetricNameQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withAppInsightsGroupByQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQuery(value): { + grafanaTemplateVariableFn+: { + AppInsightsGroupByQuery: value, + }, + }, + '#withAppInsightsGroupByQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQueryMixin(value): { + grafanaTemplateVariableFn+: { + AppInsightsGroupByQuery+: value, + }, + }, + AppInsightsGroupByQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'AppInsightsGroupByQuery', + }, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricName(value): { + grafanaTemplateVariableFn+: { + metricName: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withSubscriptionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQuery(value): { + grafanaTemplateVariableFn+: { + SubscriptionsQuery: value, + }, + }, + '#withSubscriptionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQueryMixin(value): { + grafanaTemplateVariableFn+: { + SubscriptionsQuery+: value, + }, + }, + SubscriptionsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'SubscriptionsQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withResourceGroupsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQuery(value): { + grafanaTemplateVariableFn+: { + ResourceGroupsQuery: value, + }, + }, + '#withResourceGroupsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQueryMixin(value): { + grafanaTemplateVariableFn+: { + ResourceGroupsQuery+: value, + }, + }, + ResourceGroupsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'ResourceGroupsQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withResourceNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQuery(value): { + grafanaTemplateVariableFn+: { + ResourceNamesQuery: value, + }, + }, + '#withResourceNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQueryMixin(value): { + grafanaTemplateVariableFn+: { + ResourceNamesQuery+: value, + }, + }, + ResourceNamesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'ResourceNamesQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricNamespaceQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQuery(value): { + grafanaTemplateVariableFn+: { + MetricNamespaceQuery: value, + }, + }, + '#withMetricNamespaceQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricNamespaceQuery+: value, + }, + }, + MetricNamespaceQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricNamespaceQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricDefinitionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQuery(value): { + grafanaTemplateVariableFn+: { + MetricDefinitionsQuery: value, + }, + }, + '#withMetricDefinitionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricDefinitionsQuery+: value, + }, + }, + MetricDefinitionsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricDefinitionsQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQuery(value): { + grafanaTemplateVariableFn+: { + MetricNamesQuery: value, + }, + }, + '#withMetricNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricNamesQuery+: value, + }, + }, + MetricNamesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricNamesQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withWorkspacesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQuery(value): { + grafanaTemplateVariableFn+: { + WorkspacesQuery: value, + }, + }, + '#withWorkspacesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQueryMixin(value): { + grafanaTemplateVariableFn+: { + WorkspacesQuery+: value, + }, + }, + WorkspacesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'WorkspacesQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withUnknownQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQuery(value): { + grafanaTemplateVariableFn+: { + UnknownQuery: value, + }, + }, + '#withUnknownQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQueryMixin(value): { + grafanaTemplateVariableFn+: { + UnknownQuery+: value, + }, + }, + UnknownQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'UnknownQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNamespace(value): { + namespace: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Monitor query type.\nqueryType: #AzureQueryType' } }, + withRegion(value): { + region: value, + }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResource(value): { + resource: value, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Template variables params. These exist for backwards compatiblity with legacy template variables.' } }, + withResourceGroup(value): { + resourceGroup: value, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure subscription containing the resource(s) to be queried.' } }, + withSubscription(value): { + subscription: value, + }, + '#withSubscriptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptions(value): { + subscriptions: + (if std.isArray(value) + then value + else [value]), + }, + '#withSubscriptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptionsMixin(value): { + subscriptions+: + (if std.isArray(value) + then value + else [value]), + }, +} diff --git a/gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet b/gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet new file mode 100644 index 00000000..5675f743 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet @@ -0,0 +1,692 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.cloudwatch', name: 'cloudwatch' }, + CloudWatchAnnotationQuery+: + { + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { + accountId: value, + }, + '#withActionPrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use this parameter to filter the results of the operation to only those alarms\nthat use a certain alarm action. For example, you could specify the ARN of\nan SNS topic to find all alarms that send notifications to that topic.\ne.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`\nbut not match `arn:aws:sns:us-east-1:123456789012:your-app-action`' } }, + withActionPrefix(value): { + actionPrefix: value, + }, + '#withAlarmNamePrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An alarm name prefix. If you specify this parameter, you receive information\nabout all alarms that have names that start with this prefix.\ne.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`' } }, + withAlarmNamePrefix(value): { + alarmNamePrefix: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { + dimensions: value, + }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { + dimensions+: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { + matchExact: value, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { + metricName: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { + namespace: value, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { + period: value, + }, + '#withPrefixMatching': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix' } }, + withPrefixMatching(value=true): { + prefixMatching: value, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { + queryMode: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { + region: value, + }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { + statistic: value, + }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { + statistics: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { + statistics+: + (if std.isArray(value) + then value + else [value]), + }, + }, + CloudWatchLogsQuery+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The CloudWatch Logs Insights query to execute' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withLogGroupNames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNames(value): { + logGroupNames: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroupNamesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNamesMixin(value): { + logGroupNames+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroups(value): { + logGroups: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroupsMixin(value): { + logGroups+: + (if std.isArray(value) + then value + else [value]), + }, + logGroups+: + { + '#': { help: '', name: 'logGroups' }, + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AccountId of the log group' } }, + withAccountId(value): { + accountId: value, + }, + '#withAccountLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Label of the log group' } }, + withAccountLabel(value): { + accountLabel: value, + }, + '#withArn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ARN of the log group' } }, + withArn(value): { + arn: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the log group' } }, + withName(value): { + name: value, + }, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { + queryMode: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the logs' } }, + withRegion(value): { + region: value, + }, + '#withStatsGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroups(value): { + statsGroups: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatsGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroupsMixin(value): { + statsGroups+: + (if std.isArray(value) + then value + else [value]), + }, + }, + CloudWatchMetricsQuery+: + { + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { + accountId: value, + }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Deprecated: use label\n@deprecated use label' } }, + withAlias(value): { + alias: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { + dimensions: value, + }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { + dimensions+: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Math expression query' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.' } }, + withId(value): { + id: value, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.' } }, + withLabel(value): { + label: value, + }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { + matchExact: value, + }, + '#withMetricEditorMode': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: '' } }, + withMetricEditorMode(value): { + metricEditorMode: value, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { + metricName: value, + }, + '#withMetricQueryType': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: '' } }, + withMetricQueryType(value): { + metricQueryType: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { + namespace: value, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { + period: value, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { + queryMode: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { + region: value, + }, + '#withSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSql(value): { + sql: value, + }, + '#withSqlMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSqlMixin(value): { + sql+: value, + }, + sql+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'FROM part of the SQL expression' } }, + withFrom(value): { + sql+: { + from: value, + }, + }, + '#withFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'FROM part of the SQL expression' } }, + withFromMixin(value): { + sql+: { + from+: value, + }, + }, + from+: + { + '#withQueryEditorPropertyExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpression(value): { + sql+: { + from+: { + QueryEditorPropertyExpression: value, + }, + }, + }, + '#withQueryEditorPropertyExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpressionMixin(value): { + sql+: { + from+: { + QueryEditorPropertyExpression+: value, + }, + }, + }, + QueryEditorPropertyExpression+: + { + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + sql+: { + from+: { + property: value, + }, + }, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + sql+: { + from+: { + property+: value, + }, + }, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + from+: { + property+: { + name: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + from+: { + property+: { + type: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + from+: { + type: 'property', + }, + }, + }, + }, + '#withQueryEditorFunctionExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpression(value): { + sql+: { + from+: { + QueryEditorFunctionExpression: value, + }, + }, + }, + '#withQueryEditorFunctionExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpressionMixin(value): { + sql+: { + from+: { + QueryEditorFunctionExpression+: value, + }, + }, + }, + QueryEditorFunctionExpression+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + from+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + from+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + from+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + from+: { + type: 'function', + }, + }, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGroupBy(value): { + sql+: { + groupBy: value, + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGroupByMixin(value): { + sql+: { + groupBy+: value, + }, + }, + groupBy+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { + sql+: { + groupBy+: { + expressions: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { + sql+: { + groupBy+: { + expressions+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + groupBy+: { + type: value, + }, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'LIMIT part of the SQL expression' } }, + withLimit(value): { + sql+: { + limit: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderBy(value): { + sql+: { + orderBy: value, + }, + }, + '#withOrderByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderByMixin(value): { + sql+: { + orderBy+: value, + }, + }, + orderBy+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + orderBy+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + orderBy+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + orderBy+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + orderBy+: { + type: 'function', + }, + }, + }, + }, + '#withOrderByDirection': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The sort order of the SQL expression, `ASC` or `DESC`' } }, + withOrderByDirection(value): { + sql+: { + orderByDirection: value, + }, + }, + '#withSelect': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSelect(value): { + sql+: { + select: value, + }, + }, + '#withSelectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSelectMixin(value): { + sql+: { + select+: value, + }, + }, + select+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + select+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + select+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + select+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + select+: { + type: 'function', + }, + }, + }, + }, + '#withWhere': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWhere(value): { + sql+: { + where: value, + }, + }, + '#withWhereMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWhereMixin(value): { + sql+: { + where+: value, + }, + }, + where+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { + sql+: { + where+: { + expressions: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { + sql+: { + where+: { + expressions+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + where+: { + type: value, + }, + }, + }, + }, + }, + '#withSqlExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string.' } }, + withSqlExpression(value): { + sqlExpression: value, + }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { + statistic: value, + }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { + statistics: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { + statistics+: + (if std.isArray(value) + then value + else [value]), + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet b/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet new file mode 100644 index 00000000..7a4e3920 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet @@ -0,0 +1,1451 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.elasticsearch', name: 'elasticsearch' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlias(value): { + alias: value, + }, + '#withBucketAggs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withBucketAggs(value): { + bucketAggs: + (if std.isArray(value) + then value + else [value]), + }, + '#withBucketAggsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withBucketAggsMixin(value): { + bucketAggs+: + (if std.isArray(value) + then value + else [value]), + }, + bucketAggs+: + { + DateHistogram+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { + settings+: { + interval: value, + }, + }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + '#withOffset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOffset(value): { + settings+: { + offset: value, + }, + }, + '#withTimeZone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeZone(value): { + settings+: { + timeZone: value, + }, + }, + '#withTrimEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTrimEdges(value): { + settings+: { + trimEdges: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'date_histogram', + }, + }, + Histogram+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { + settings+: { + interval: value, + }, + }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'histogram', + }, + }, + Terms+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withOrder': { 'function': { args: [{ default: null, enums: ['desc', 'asc'], name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { + settings+: { + order: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { + settings+: { + orderBy: value, + }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'terms', + }, + }, + Filters+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { + settings+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { + settings+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabel(value): { + label: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value): { + query: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'filters', + }, + }, + GeoHashGrid+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withPrecision': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecision(value): { + settings+: { + precision: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'geohash_grid', + }, + }, + Nested+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'nested', + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetrics(value): { + metrics: + (if std.isArray(value) + then value + else [value]), + }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetricsMixin(value): { + metrics+: + (if std.isArray(value) + then value + else [value]), + }, + metrics+: + { + Count+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'count', + }, + }, + PipelineMetricAggregation+: + { + MovingAverage+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_avg', + }, + }, + Derivative+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'derivative', + }, + }, + CumulativeSum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + settings+: { + format: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cumulative_sum', + }, + }, + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { + pipelineVariables: + (if std.isArray(value) + then value + else [value]), + }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { + pipelineVariables+: + (if std.isArray(value) + then value + else [value]), + }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bucket_script', + }, + }, + }, + MetricAggregationWithSettings+: + { + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { + pipelineVariables: + (if std.isArray(value) + then value + else [value]), + }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { + pipelineVariables+: + (if std.isArray(value) + then value + else [value]), + }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bucket_script', + }, + }, + CumulativeSum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + settings+: { + format: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cumulative_sum', + }, + }, + Derivative+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'derivative', + }, + }, + SerialDiff+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withLag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLag(value): { + settings+: { + lag: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'serial_diff', + }, + }, + RawData+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'raw_data', + }, + }, + RawDocument+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'raw_document', + }, + }, + UniqueCount+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withPrecisionThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecisionThreshold(value): { + settings+: { + precision_threshold: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cardinality', + }, + }, + Percentiles+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withPercents': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercents(value): { + settings+: { + percents: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPercentsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercentsMixin(value): { + settings+: { + percents+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'percentiles', + }, + }, + ExtendedStats+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { + meta: value, + }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { + meta+: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + '#withSigma': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSigma(value): { + settings+: { + sigma: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'extended_stats', + }, + }, + Min+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'min', + }, + }, + Max+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'max', + }, + }, + Sum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'sum', + }, + }, + Average+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'avg', + }, + }, + MovingAverage+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_avg', + }, + }, + MovingFunction+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + '#withShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withShift(value): { + settings+: { + shift: value, + }, + }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWindow(value): { + settings+: { + window: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_fn', + }, + }, + Logs+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLimit(value): { + settings+: { + limit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'logs', + }, + }, + Rate+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + settings+: { + mode: value, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'rate', + }, + }, + TopMetrics+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetrics(value): { + settings+: { + metrics: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetricsMixin(value): { + settings+: { + metrics+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withOrder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { + settings+: { + order: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { + settings+: { + orderBy: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'top_metrics', + }, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value): { + query: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRefId(value): { + refId: value, + }, + '#withTimeField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeField(value): { + timeField: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet b/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet new file mode 100644 index 00000000..c50a3aed --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet @@ -0,0 +1,298 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.googlecloudmonitoring', name: 'googlecloudmonitoring' }, + '#withAliasBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.' } }, + withAliasBy(value): { + aliasBy: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Time interval in milliseconds.' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withPromQLQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQuery(value): { + promQLQuery: value, + }, + '#withPromQLQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQueryMixin(value): { + promQLQuery+: value, + }, + promQLQuery+: + { + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL expression/query to be executed.' } }, + withExpr(value): { + promQLQuery+: { + expr: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + promQLQuery+: { + projectName: value, + }, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL min step' } }, + withStep(value): { + promQLQuery+: { + step: value, + }, + }, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withSloQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQuery(value): { + sloQuery: value, + }, + '#withSloQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQueryMixin(value): { + sloQuery+: value, + }, + sloQuery+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { + sloQuery+: { + alignmentPeriod: value, + }, + }, + '#withGoal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'SLO goal value.' } }, + withGoal(value): { + sloQuery+: { + goal: value, + }, + }, + '#withLookbackPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific lookback period for the SLO.' } }, + withLookbackPeriod(value): { + sloQuery+: { + lookbackPeriod: value, + }, + }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { + sloQuery+: { + perSeriesAligner: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + sloQuery+: { + projectName: value, + }, + }, + '#withSelectorName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'SLO selector.' } }, + withSelectorName(value): { + sloQuery+: { + selectorName: value, + }, + }, + '#withServiceId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the service the SLO is in.' } }, + withServiceId(value): { + sloQuery+: { + serviceId: value, + }, + }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name for the service the SLO is in.' } }, + withServiceName(value): { + sloQuery+: { + serviceName: value, + }, + }, + '#withSloId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the SLO.' } }, + withSloId(value): { + sloQuery+: { + sloId: value, + }, + }, + '#withSloName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the SLO.' } }, + withSloName(value): { + sloQuery+: { + sloName: value, + }, + }, + }, + '#withTimeSeriesList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesList(value): { + timeSeriesList: value, + }, + '#withTimeSeriesListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesListMixin(value): { + timeSeriesList+: value, + }, + timeSeriesList+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { + timeSeriesList+: { + alignmentPeriod: value, + }, + }, + '#withCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withCrossSeriesReducer(value): { + timeSeriesList+: { + crossSeriesReducer: value, + }, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFilters(value): { + timeSeriesList+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFiltersMixin(value): { + timeSeriesList+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBys(value): { + timeSeriesList+: { + groupBys: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBysMixin(value): { + timeSeriesList+: { + groupBys+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { + timeSeriesList+: { + perSeriesAligner: value, + }, + }, + '#withPreprocessor': { 'function': { args: [{ default: null, enums: ['none', 'rate', 'delta'], name: 'value', type: ['string'] }], help: 'Types of pre-processor available. Defined by the metric.' } }, + withPreprocessor(value): { + timeSeriesList+: { + preprocessor: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + timeSeriesList+: { + projectName: value, + }, + }, + '#withSecondaryAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withSecondaryAlignmentPeriod(value): { + timeSeriesList+: { + secondaryAlignmentPeriod: value, + }, + }, + '#withSecondaryCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withSecondaryCrossSeriesReducer(value): { + timeSeriesList+: { + secondaryCrossSeriesReducer: value, + }, + }, + '#withSecondaryGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBys(value): { + timeSeriesList+: { + secondaryGroupBys: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSecondaryGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBysMixin(value): { + timeSeriesList+: { + secondaryGroupBys+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSecondaryPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withSecondaryPerSeriesAligner(value): { + timeSeriesList+: { + secondaryPerSeriesAligner: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation text.' } }, + withText(value): { + timeSeriesList+: { + text: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation title.' } }, + withTitle(value): { + timeSeriesList+: { + title: value, + }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Data view, defaults to FULL.' } }, + withView(value): { + timeSeriesList+: { + view: value, + }, + }, + }, + '#withTimeSeriesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQuery(value): { + timeSeriesQuery: value, + }, + '#withTimeSeriesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQueryMixin(value): { + timeSeriesQuery+: value, + }, + timeSeriesQuery+: + { + '#withGraphPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, + withGraphPeriod(value): { + timeSeriesQuery+: { + graphPeriod: value, + }, + }, + '#withGraphPeriodMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, + withGraphPeriodMixin(value): { + timeSeriesQuery+: { + graphPeriod+: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + timeSeriesQuery+: { + projectName: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'MQL query to be executed.' } }, + withQuery(value): { + timeSeriesQuery+: { + query: value, + }, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet b/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet new file mode 100644 index 00000000..495e8b4e --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet @@ -0,0 +1,64 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.grafanapyroscope', name: 'grafanapyroscope' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabelSelector(value='{}'): { + labelSelector: value, + }, + '#withMaxNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxNodes(value): { + maxNodes: value, + }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProfileTypeId(value): { + profileTypeId: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRefId(value): { + refId: value, + }, + '#withSpanSelector': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withSpanSelector(value): { + spanSelector: + (if std.isArray(value) + then value + else [value]), + }, + '#withSpanSelectorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withSpanSelectorMixin(value): { + spanSelector+: + (if std.isArray(value) + then value + else [value]), + }, +} diff --git a/gen/grafonnet-v11.0.0/query/loki.libsonnet b/gen/grafonnet-v11.0.0/query/loki.libsonnet new file mode 100644 index 00000000..97bb4511 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/loki.libsonnet @@ -0,0 +1,57 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.loki', name: 'loki' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpr(value): { + expr: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInstant(value=true): { + instant: value, + }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLegendFormat(value): { + legendFormat: value, + }, + '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxLines(value): { + maxLines: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryType(value): { + queryType: value, + }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRange(value=true): { + range: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRefId(value): { + refId: value, + }, + '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withResolution(value): { + resolution: value, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStep(value): { + step: value, + }, +} ++ (import '../custom/query/loki.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/parca.libsonnet b/gen/grafonnet-v11.0.0/query/parca.libsonnet new file mode 100644 index 00000000..a591db67 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/parca.libsonnet @@ -0,0 +1,32 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.parca', name: 'parca' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabelSelector(value='{}'): { + labelSelector: value, + }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProfileTypeId(value): { + profileTypeId: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRefId(value): { + refId: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/query/prometheus.libsonnet b/gen/grafonnet-v11.0.0/query/prometheus.libsonnet new file mode 100644 index 00000000..694b7242 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/prometheus.libsonnet @@ -0,0 +1,61 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withExemplar(value=true): { + exemplar: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpr(value): { + expr: value, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: ['time_series', 'table', 'heatmap'], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + format: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInstant(value=true): { + instant: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An additional lower limit for the step parameter of the Prometheus query and for the\n`$__interval` and `$__rate_interval` variables.' } }, + withInterval(value): { + interval: value, + }, + '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withIntervalFactor(value): { + intervalFactor: value, + }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLegendFormat(value): { + legendFormat: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryType(value): { + queryType: value, + }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRange(value=true): { + range: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRefId(value): { + refId: value, + }, +} ++ (import '../custom/query/prometheus.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/tempo.libsonnet b/gen/grafonnet-v11.0.0/query/tempo.libsonnet new file mode 100644 index 00000000..1fe9d98e --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/tempo.libsonnet @@ -0,0 +1,165 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.tempo', name: 'tempo' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { + id: value, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { + operator: value, + }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { + scope: value, + }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { + tag: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { + value+: value, + }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { + valueType: value, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupBy(value): { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupByMixin(value): { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { + id: value, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { + operator: value, + }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { + scope: value, + }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { + tag: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { + value+: value, + }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { + valueType: value, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of traces that are returned from Tempo' } }, + withLimit(value): { + limit: value, + }, + '#withMaxDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMaxDuration(value): { + maxDuration: value, + }, + '#withMinDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMinDuration(value): { + minDuration: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TraceQL query or trace ID' } }, + withQuery(value): { + query: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withSearch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true' } }, + withSearch(value): { + search: value, + }, + '#withServiceMapIncludeNamespace': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Use service.namespace in addition to service.name to uniquely identify a service.' } }, + withServiceMapIncludeNamespace(value=true): { + serviceMapIncludeNamespace: value, + }, + '#withServiceMapQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.' } }, + withServiceMapQuery(value): { + serviceMapQuery: value, + }, + '#withServiceMapQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.' } }, + withServiceMapQueryMixin(value): { + serviceMapQuery+: value, + }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by service name' } }, + withServiceName(value): { + serviceName: value, + }, + '#withSpanName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by span name' } }, + withSpanName(value): { + spanName: value, + }, + '#withSpss': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of spans per spanset that are returned from Tempo' } }, + withSpss(value): { + spss: value, + }, + '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans', 'raw'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, + withTableType(value): { + tableType: value, + }, +} ++ (import '../custom/query/tempo.libsonnet') diff --git a/gen/grafonnet-v11.0.0/raw/alerting/contactPoint.libsonnet b/gen/grafonnet-v11.0.0/raw/alerting/contactPoint.libsonnet new file mode 100644 index 00000000..a3d1859a --- /dev/null +++ b/gen/grafonnet-v11.0.0/raw/alerting/contactPoint.libsonnet @@ -0,0 +1,32 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, + '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDisableResolveMessage(value=true): { + disableResolveMessage: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name is used as grouping key in the UI. Contact points with the\nsame name will be grouped in the UI.' } }, + withName(value): { + name: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID is the unique identifier of the contact point. The UID can be\nset by the user.' } }, + withUid(value): { + uid: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/raw/alerting/messageTemplate.libsonnet b/gen/grafonnet-v11.0.0/raw/alerting/messageTemplate.libsonnet new file mode 100644 index 00000000..8ddfaf2c --- /dev/null +++ b/gen/grafonnet-v11.0.0/raw/alerting/messageTemplate.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.messageTemplate', name: 'messageTemplate' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTemplate(value): { + template: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/raw/alerting/muteTiming.libsonnet b/gen/grafonnet-v11.0.0/raw/alerting/muteTiming.libsonnet new file mode 100644 index 00000000..4988afb0 --- /dev/null +++ b/gen/grafonnet-v11.0.0/raw/alerting/muteTiming.libsonnet @@ -0,0 +1,134 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.muteTiming', name: 'muteTiming' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + time_intervals+: + { + '#': { help: '', name: 'time_intervals' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + time_intervals+: + { + '#': { help: '', name: 'time_intervals' }, + '#withDaysOfMonth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonth(value): { + days_of_month: + (if std.isArray(value) + then value + else [value]), + }, + '#withDaysOfMonthMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonthMixin(value): { + days_of_month+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withMonths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonths(value): { + months: + (if std.isArray(value) + then value + else [value]), + }, + '#withMonthsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonthsMixin(value): { + months+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimes(value): { + times: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimesMixin(value): { + times+: + (if std.isArray(value) + then value + else [value]), + }, + times+: + { + '#': { help: '', name: 'times' }, + '#withEndTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withEndTime(value): { + end_time: value, + }, + '#withStartTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStartTime(value): { + start_time: value, + }, + }, + '#withWeekdays': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdays(value): { + weekdays: + (if std.isArray(value) + then value + else [value]), + }, + '#withWeekdaysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdaysMixin(value): { + weekdays+: + (if std.isArray(value) + then value + else [value]), + }, + '#withYears': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYears(value): { + years: + (if std.isArray(value) + then value + else [value]), + }, + '#withYearsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYearsMixin(value): { + years+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/raw/alerting/notificationPolicy.libsonnet b/gen/grafonnet-v11.0.0/raw/alerting/notificationPolicy.libsonnet new file mode 100644 index 00000000..99a22b2d --- /dev/null +++ b/gen/grafonnet-v11.0.0/raw/alerting/notificationPolicy.libsonnet @@ -0,0 +1,130 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withContinue(value=true): { + continue: value, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + group_by: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + group_by+: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupInterval(value): { + group_interval: value, + }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupWait(value): { + group_wait: value, + }, + '#withMatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Deprecated. Remove before v1.0 release.' } }, + withMatch(value): { + match: value, + }, + '#withMatchMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Deprecated. Remove before v1.0 release.' } }, + withMatchMixin(value): { + match+: value, + }, + '#withMatchRe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'MatchRegexps represents a map of Regexp.' } }, + withMatchRe(value): { + match_re: value, + }, + '#withMatchReMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'MatchRegexps represents a map of Regexp.' } }, + withMatchReMixin(value): { + match_re+: value, + }, + '#withMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchers(value): { + matchers: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchersMixin(value): { + matchers+: + (if std.isArray(value) + then value + else [value]), + }, + matchers+: + { + '#': { help: '', name: 'matchers' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + Name: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: 'MatchType is an enum for label matching types.' } }, + withType(value): { + Type: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { + Value: value, + }, + }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervals(value): { + mute_time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervalsMixin(value): { + mute_time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + '#withObjectMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'ObjectMatchers is a list of matchers that can be used to filter alerts.' } }, + withObjectMatchers(value): { + object_matchers: + (if std.isArray(value) + then value + else [value]), + }, + '#withObjectMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'ObjectMatchers is a list of matchers that can be used to filter alerts.' } }, + withObjectMatchersMixin(value): { + object_matchers+: + (if std.isArray(value) + then value + else [value]), + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withReceiver(value): { + receiver: value, + }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRepeatInterval(value): { + repeat_interval: value, + }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutes(value): { + routes: + (if std.isArray(value) + then value + else [value]), + }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutesMixin(value): { + routes+: + (if std.isArray(value) + then value + else [value]), + }, +} diff --git a/gen/grafonnet-v11.0.0/raw/alerting/ruleGroup.libsonnet b/gen/grafonnet-v11.0.0/raw/alerting/ruleGroup.libsonnet new file mode 100644 index 00000000..2e64d5b6 --- /dev/null +++ b/gen/grafonnet-v11.0.0/raw/alerting/ruleGroup.libsonnet @@ -0,0 +1,234 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.ruleGroup', name: 'ruleGroup' }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withInterval(value): { + interval: value, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + rules+: + { + '#': { help: '', name: 'rules' }, + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotations(value): { + annotations: value, + }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotationsMixin(value): { + annotations+: value, + }, + '#withCondition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCondition(value): { + condition: value, + }, + '#withData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withData(value): { + data: + (if std.isArray(value) + then value + else [value]), + }, + '#withDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDataMixin(value): { + data+: + (if std.isArray(value) + then value + else [value]), + }, + data+: + { + '#': { help: '', name: 'data' }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation." } }, + withDatasourceUid(value): { + datasourceUid: value, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModelMixin(value): { + model+: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withRelativeTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRange(value): { + relativeTimeRange: value, + }, + '#withRelativeTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRangeMixin(value): { + relativeTimeRange+: value, + }, + relativeTimeRange+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFrom(value): { + relativeTimeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withTo(value): { + relativeTimeRange+: { + to: value, + }, + }, + }, + }, + '#withExecErrState': { 'function': { args: [{ default: null, enums: ['OK', 'Alerting', 'Error'], name: 'value', type: ['string'] }], help: '' } }, + withExecErrState(value): { + execErrState: value, + }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + folderUID: value, + }, + '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, + withFor(value): { + 'for': value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withIsPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsPaused(value=true): { + isPaused: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelsMixin(value): { + labels+: value, + }, + '#withNoDataState': { 'function': { args: [{ default: null, enums: ['Alerting', 'NoData', 'OK'], name: 'value', type: ['string'] }], help: '' } }, + withNoDataState(value): { + noDataState: value, + }, + '#withNotificationSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNotificationSettings(value): { + notification_settings: value, + }, + '#withNotificationSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNotificationSettingsMixin(value): { + notification_settings+: value, + }, + notification_settings+: + { + '#withGroupBy': { 'function': { args: [{ default: ['alertname', 'grafana_folder'], enums: null, name: 'value', type: ['array'] }], help: "Override the labels by which incoming alerts are grouped together. For example, multiple alerts coming in for\ncluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels\nuse the special value '...' as the sole label name.\nThis effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what\nyou want, unless you have a very low alert volume or your upstream notification system performs its own grouping.\nMust include 'alertname' and 'grafana_folder' if not using '...'." } }, + withGroupBy(value): { + notification_settings+: { + group_by: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: ['alertname', 'grafana_folder'], enums: null, name: 'value', type: ['array'] }], help: "Override the labels by which incoming alerts are grouped together. For example, multiple alerts coming in for\ncluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels\nuse the special value '...' as the sole label name.\nThis effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what\nyou want, unless you have a very low alert volume or your upstream notification system performs its own grouping.\nMust include 'alertname' and 'grafana_folder' if not using '...'." } }, + withGroupByMixin(value): { + notification_settings+: { + group_by+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Override how long to wait before sending a notification about new alerts that are added to a group of alerts for\nwhich an initial notification has already been sent. (Usually ~5m or more.)' } }, + withGroupInterval(value): { + notification_settings+: { + group_interval: value, + }, + }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Override how long to initially wait to send a notification for a group of alerts. Allows to wait for an\ninhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)' } }, + withGroupWait(value): { + notification_settings+: { + group_wait: value, + }, + }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Override the times when notifications should be muted. These must match the name of a mute time interval defined\nin the alertmanager configuration mute_time_intervals section. When muted it will not send any notifications, but\notherwise acts normally.' } }, + withMuteTimeIntervals(value): { + notification_settings+: { + mute_time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Override the times when notifications should be muted. These must match the name of a mute time interval defined\nin the alertmanager configuration mute_time_intervals section. When muted it will not send any notifications, but\notherwise acts normally.' } }, + withMuteTimeIntervalsMixin(value): { + notification_settings+: { + mute_time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the receiver to send notifications to.' } }, + withReceiver(value): { + notification_settings+: { + receiver: value, + }, + }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Override how long to wait before sending a notification again if it has already been sent successfully for an\nalert. (Usually ~3h or more).\nNote that this parameter is implicitly bound by Alertmanager's `--data.retention` configuration flag.\nNotifications will be resent after either repeat_interval or the data retention period have passed, whichever\noccurs first. `repeat_interval` should not be less than `group_interval`." } }, + withRepeatInterval(value): { + notification_settings+: { + repeat_interval: value, + }, + }, + }, + '#withOrgID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOrgID(value): { + orgID: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withRuleGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRuleGroup(value): { + ruleGroup: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUid(value): { + uid: value, + }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUpdated(value): { + updated: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/role.libsonnet b/gen/grafonnet-v11.0.0/role.libsonnet new file mode 100644 index 00000000..54d03bff --- /dev/null +++ b/gen/grafonnet-v11.0.0/role.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.role', name: 'role' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Role description' } }, + withDescription(value): { + description: value, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display' } }, + withDisplayName(value): { + displayName: value, + }, + '#withGroupName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withGroupName(value): { + groupName: value, + }, + '#withHidden': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'boolean'] }], help: 'Do not show this role' } }, + withHidden(value): { + hidden: value, + }, + '#withHiddenMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'boolean'] }], help: 'Do not show this role' } }, + withHiddenMixin(value): { + hidden+: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The role identifier `managed:builtins:editor:permissions`' } }, + withName(value): { + name: value, + }, +} diff --git a/gen/grafonnet-v11.0.0/rolebinding.libsonnet b/gen/grafonnet-v11.0.0/rolebinding.libsonnet new file mode 100644 index 00000000..acf521ed --- /dev/null +++ b/gen/grafonnet-v11.0.0/rolebinding.libsonnet @@ -0,0 +1,92 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.rolebinding', name: 'rolebinding' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'The role we are discussing' } }, + withRole(value): { + role: value, + }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'The role we are discussing' } }, + withRoleMixin(value): { + role+: value, + }, + role+: + { + '#withBuiltinRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRef(value): { + role+: { + BuiltinRoleRef: value, + }, + }, + '#withBuiltinRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRefMixin(value): { + role+: { + BuiltinRoleRef+: value, + }, + }, + BuiltinRoleRef+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + role+: { + kind: 'BuiltinRole', + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: ['viewer', 'editor', 'admin'], name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + }, + '#withCustomRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRef(value): { + role+: { + CustomRoleRef: value, + }, + }, + '#withCustomRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRefMixin(value): { + role+: { + CustomRoleRef+: value, + }, + }, + CustomRoleRef+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + role+: { + kind: 'Role', + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + }, + }, + '#withSubject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubject(value): { + subject: value, + }, + '#withSubjectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubjectMixin(value): { + subject+: value, + }, + subject+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Team', 'User'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { + subject+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The team/user identifier name' } }, + withName(value): { + subject+: { + name: value, + }, + }, + }, +} diff --git a/gen/grafonnet-v11.0.0/team.libsonnet b/gen/grafonnet-v11.0.0/team.libsonnet new file mode 100644 index 00000000..429a64fc --- /dev/null +++ b/gen/grafonnet-v11.0.0/team.libsonnet @@ -0,0 +1,12 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.team', name: 'team' }, + '#withEmail': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Email of the team.' } }, + withEmail(value): { + email: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withName(value): { + name: value, + }, +} From d0422e4486f6cdee1f66e3f2f3aeb31af0348f2b Mon Sep 17 00:00:00 2001 From: Duologic Date: Sun, 21 Apr 2024 13:58:45 +0200 Subject: [PATCH 03/17] remove obsolete file --- generator/cog_imports.libsonnet | 46 --------------------------------- 1 file changed, 46 deletions(-) delete mode 100644 generator/cog_imports.libsonnet diff --git a/generator/cog_imports.libsonnet b/generator/cog_imports.libsonnet deleted file mode 100644 index daa5fa2a..00000000 --- a/generator/cog_imports.libsonnet +++ /dev/null @@ -1,46 +0,0 @@ -[ - import '/home/duologic/git/grafana/cog/generated/accesspolicy.openapi.json', - import '/home/duologic/git/grafana/cog/generated/alertgroups.openapi.json', - import '/home/duologic/git/grafana/cog/generated/annotationslist.openapi.json', - import '/home/duologic/git/grafana/cog/generated/azuremonitor.openapi.json', - import '/home/duologic/git/grafana/cog/generated/barchart.openapi.json', - import '/home/duologic/git/grafana/cog/generated/bargauge.openapi.json', - import '/home/duologic/git/grafana/cog/generated/candlestick.openapi.json', - import '/home/duologic/git/grafana/cog/generated/canvas.openapi.json', - import '/home/duologic/git/grafana/cog/generated/cloudwatch.openapi.json', - import '/home/duologic/git/grafana/cog/generated/common.openapi.json', - import '/home/duologic/git/grafana/cog/generated/dashboardlist.openapi.json', - import '/home/duologic/git/grafana/cog/generated/dashboard.openapi.json', - import '/home/duologic/git/grafana/cog/generated/datagrid.openapi.json', - import '/home/duologic/git/grafana/cog/generated/debug.openapi.json', - import '/home/duologic/git/grafana/cog/generated/elasticsearch.openapi.json', - import '/home/duologic/git/grafana/cog/generated/gauge.openapi.json', - import '/home/duologic/git/grafana/cog/generated/geomap.openapi.json', - import '/home/duologic/git/grafana/cog/generated/googlecloudmonitoring.openapi.json', - import '/home/duologic/git/grafana/cog/generated/grafanapyroscope.openapi.json', - import '/home/duologic/git/grafana/cog/generated/heatmap.openapi.json', - import '/home/duologic/git/grafana/cog/generated/histogram.openapi.json', - import '/home/duologic/git/grafana/cog/generated/librarypanel.openapi.json', - import '/home/duologic/git/grafana/cog/generated/logs.openapi.json', - import '/home/duologic/git/grafana/cog/generated/loki.openapi.json', - import '/home/duologic/git/grafana/cog/generated/news.openapi.json', - import '/home/duologic/git/grafana/cog/generated/nodegraph.openapi.json', - import '/home/duologic/git/grafana/cog/generated/parca.openapi.json', - import '/home/duologic/git/grafana/cog/generated/piechart.openapi.json', - import '/home/duologic/git/grafana/cog/generated/preferences.openapi.json', - import '/home/duologic/git/grafana/cog/generated/prometheus.openapi.json', - import '/home/duologic/git/grafana/cog/generated/publicdashboard.openapi.json', - import '/home/duologic/git/grafana/cog/generated/rolebinding.openapi.json', - import '/home/duologic/git/grafana/cog/generated/role.openapi.json', - import '/home/duologic/git/grafana/cog/generated/statetimeline.openapi.json', - import '/home/duologic/git/grafana/cog/generated/stat.openapi.json', - import '/home/duologic/git/grafana/cog/generated/statushistory.openapi.json', - import '/home/duologic/git/grafana/cog/generated/table.openapi.json', - import '/home/duologic/git/grafana/cog/generated/team.openapi.json', - import '/home/duologic/git/grafana/cog/generated/tempo.openapi.json', - import '/home/duologic/git/grafana/cog/generated/testdata.openapi.json', - import '/home/duologic/git/grafana/cog/generated/text.openapi.json', - import '/home/duologic/git/grafana/cog/generated/timeseries.openapi.json', - import '/home/duologic/git/grafana/cog/generated/trend.openapi.json', - import '/home/duologic/git/grafana/cog/generated/xychart.openapi.json', -] From 20c1ca0c0fe3e0d9ce32c7fb928685d715790595 Mon Sep 17 00:00:00 2001 From: Duologic Date: Mon, 13 May 2024 14:32:54 +0200 Subject: [PATCH 04/17] fix(alerting): add required fields Fixes: https://github.com/grafana/grafonnet/issues/181 --- docs/API/alerting/ruleGroup/rule/index.md | 36 +++++++++++++++++++ .../clean/alerting/ruleGroup.libsonnet | 12 +++++++ .../docs/alerting/ruleGroup/rule/index.md | 36 +++++++++++++++++++ generator/alerting.libsonnet | 10 +++--- 4 files changed, 90 insertions(+), 4 deletions(-) diff --git a/docs/API/alerting/ruleGroup/rule/index.md b/docs/API/alerting/ruleGroup/rule/index.md index e93787c0..811a0440 100644 --- a/docs/API/alerting/ruleGroup/rule/index.md +++ b/docs/API/alerting/ruleGroup/rule/index.md @@ -14,12 +14,15 @@ * [`fn withData(value)`](#fn-withdata) * [`fn withDataMixin(value)`](#fn-withdatamixin) * [`fn withExecErrState(value)`](#fn-withexecerrstate) +* [`fn withFolderUID(value)`](#fn-withfolderuid) * [`fn withFor(value)`](#fn-withfor) * [`fn withIsPaused(value=true)`](#fn-withispaused) * [`fn withLabels(value)`](#fn-withlabels) * [`fn withLabelsMixin(value)`](#fn-withlabelsmixin) * [`fn withName(value)`](#fn-withname) * [`fn withNoDataState(value)`](#fn-withnodatastate) +* [`fn withOrgID(value)`](#fn-withorgid) +* [`fn withRuleGroup(value)`](#fn-withrulegroup) ## Fields @@ -90,6 +93,17 @@ PARAMETERS: - valid values: `"OK"`, `"Alerting"`, `"Error"` +### fn withFolderUID + +```jsonnet +withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + ### fn withFor ```jsonnet @@ -159,3 +173,25 @@ PARAMETERS: * **value** (`string`) - valid values: `"Alerting"`, `"NoData"`, `"OK"` + +### fn withOrgID + +```jsonnet +withOrgID(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withRuleGroup + +```jsonnet +withRuleGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet index a7550dae..38bd9a01 100644 --- a/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet +++ b/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet @@ -59,6 +59,10 @@ withExecErrState(value): { execErrState: value, }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + folderUID: value, + }, '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.' } }, withFor(value): { 'for': value, @@ -79,6 +83,14 @@ withNoDataState(value): { noDataState: value, }, + '#withOrgID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOrgID(value): { + orgID: value, + }, + '#withRuleGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRuleGroup(value): { + ruleGroup: value, + }, '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withTitle(value): { title: value, diff --git a/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md index e93787c0..811a0440 100644 --- a/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md +++ b/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md @@ -14,12 +14,15 @@ * [`fn withData(value)`](#fn-withdata) * [`fn withDataMixin(value)`](#fn-withdatamixin) * [`fn withExecErrState(value)`](#fn-withexecerrstate) +* [`fn withFolderUID(value)`](#fn-withfolderuid) * [`fn withFor(value)`](#fn-withfor) * [`fn withIsPaused(value=true)`](#fn-withispaused) * [`fn withLabels(value)`](#fn-withlabels) * [`fn withLabelsMixin(value)`](#fn-withlabelsmixin) * [`fn withName(value)`](#fn-withname) * [`fn withNoDataState(value)`](#fn-withnodatastate) +* [`fn withOrgID(value)`](#fn-withorgid) +* [`fn withRuleGroup(value)`](#fn-withrulegroup) ## Fields @@ -90,6 +93,17 @@ PARAMETERS: - valid values: `"OK"`, `"Alerting"`, `"Error"` +### fn withFolderUID + +```jsonnet +withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + ### fn withFor ```jsonnet @@ -159,3 +173,25 @@ PARAMETERS: * **value** (`string`) - valid values: `"Alerting"`, `"NoData"`, `"OK"` + +### fn withOrgID + +```jsonnet +withOrgID(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withRuleGroup + +```jsonnet +withRuleGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/generator/alerting.libsonnet b/generator/alerting.libsonnet index 238c4257..8eccc3dc 100644 --- a/generator/alerting.libsonnet +++ b/generator/alerting.libsonnet @@ -208,19 +208,21 @@ local utils = import './utils.libsonnet'; 'rules.withData', 'rules.withDataMixin', 'rules.withExecErrState', + 'rules.withFolderUID', 'rules.withFor', 'rules.withIsPaused', 'rules.withLabels', 'rules.withLabelsMixin', 'rules.withNoDataState', + 'rules.withOrgID', + 'rules.withRuleGroup', 'rules.withTitle', // rename to withName // Given by parent object, may be read-only!? - //'rules.withFolderUID', - //'rules.withId', - //'rules.withOrgID', //'rules.withProvenance', - //'rules.withRuleGroup', + + // Read-only + //'rules.withId', //'rules.withUid', //'rules.withUpdated', ], From 213e99f868c054f11fcdc197adbddd71115a03fa Mon Sep 17 00:00:00 2001 From: Duologic Date: Mon, 13 May 2024 14:37:06 +0200 Subject: [PATCH 05/17] fix: add insertNulls field Fixes https://github.com/grafana/grafonnet/issues/188 --- docs/API/panel/candlestick/index.md | 24 +++++++++++++++++++ docs/API/panel/table/index.md | 24 +++++++++++++++++++ docs/API/panel/timeSeries/index.md | 24 +++++++++++++++++++ docs/API/panel/trend/index.md | 24 +++++++++++++++++++ .../docs/panel/candlestick/index.md | 24 +++++++++++++++++++ .../docs/panel/table/index.md | 24 +++++++++++++++++++ .../docs/panel/timeSeries/index.md | 24 +++++++++++++++++++ .../docs/panel/trend/index.md | 24 +++++++++++++++++++ .../panel/candlestick.libsonnet | 20 ++++++++++++++++ gen/grafonnet-v11.0.0/panel/table.libsonnet | 24 +++++++++++++++++++ .../panel/timeSeries.libsonnet | 20 ++++++++++++++++ gen/grafonnet-v11.0.0/panel/trend.libsonnet | 20 ++++++++++++++++ 12 files changed, 276 insertions(+) diff --git a/docs/API/panel/candlestick/index.md b/docs/API/panel/candlestick/index.md index ab1accee..534a80df 100644 --- a/docs/API/panel/candlestick/index.md +++ b/docs/API/panel/candlestick/index.md @@ -35,6 +35,8 @@ grafonnet.panel.candlestick * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) @@ -395,6 +397,28 @@ PARAMETERS: * **value** (`object`) TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ###### fn fieldConfig.defaults.custom.withLineColor ```jsonnet diff --git a/docs/API/panel/table/index.md b/docs/API/panel/table/index.md index d5c25b8b..e8d83f0f 100644 --- a/docs/API/panel/table/index.md +++ b/docs/API/panel/table/index.md @@ -83,6 +83,8 @@ grafonnet.panel.table * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) @@ -866,6 +868,28 @@ PARAMETERS: - default value: `true` +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor ```jsonnet diff --git a/docs/API/panel/timeSeries/index.md b/docs/API/panel/timeSeries/index.md index 0868e660..92003ea3 100644 --- a/docs/API/panel/timeSeries/index.md +++ b/docs/API/panel/timeSeries/index.md @@ -35,6 +35,8 @@ grafonnet.panel.timeSeries * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) @@ -383,6 +385,28 @@ PARAMETERS: * **value** (`object`) TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ###### fn fieldConfig.defaults.custom.withLineColor ```jsonnet diff --git a/docs/API/panel/trend/index.md b/docs/API/panel/trend/index.md index 9a3dfabb..13205b34 100644 --- a/docs/API/panel/trend/index.md +++ b/docs/API/panel/trend/index.md @@ -35,6 +35,8 @@ grafonnet.panel.trend * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) @@ -378,6 +380,28 @@ PARAMETERS: * **value** (`object`) TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ###### fn fieldConfig.defaults.custom.withLineColor ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md index ab1accee..534a80df 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md @@ -35,6 +35,8 @@ grafonnet.panel.candlestick * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) @@ -395,6 +397,28 @@ PARAMETERS: * **value** (`object`) TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ###### fn fieldConfig.defaults.custom.withLineColor ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/index.md b/gen/grafonnet-v11.0.0/docs/panel/table/index.md index d5c25b8b..e8d83f0f 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/table/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/table/index.md @@ -83,6 +83,8 @@ grafonnet.panel.table * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) @@ -866,6 +868,28 @@ PARAMETERS: - default value: `true` +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md index 0868e660..92003ea3 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md @@ -35,6 +35,8 @@ grafonnet.panel.timeSeries * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) @@ -383,6 +385,28 @@ PARAMETERS: * **value** (`object`) TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ###### fn fieldConfig.defaults.custom.withLineColor ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md index 9a3dfabb..13205b34 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md @@ -35,6 +35,8 @@ grafonnet.panel.trend * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) @@ -378,6 +380,28 @@ PARAMETERS: * **value** (`object`) TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + ###### fn fieldConfig.defaults.custom.withLineColor ```jsonnet diff --git a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet index 721c4baa..50b4eb15 100644 --- a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet @@ -242,6 +242,26 @@ }, }, }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withLineColor(value): { fieldConfig+: { diff --git a/gen/grafonnet-v11.0.0/panel/table.libsonnet b/gen/grafonnet-v11.0.0/panel/table.libsonnet index cab12430..66ffec83 100644 --- a/gen/grafonnet-v11.0.0/panel/table.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/table.libsonnet @@ -395,6 +395,30 @@ }, }, }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + insertNulls: value, + }, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + insertNulls+: value, + }, + }, + }, + }, + }, '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withLineColor(value): { fieldConfig+: { diff --git a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet index 25525317..c583b6ce 100644 --- a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet @@ -242,6 +242,26 @@ }, }, }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withLineColor(value): { fieldConfig+: { diff --git a/gen/grafonnet-v11.0.0/panel/trend.libsonnet b/gen/grafonnet-v11.0.0/panel/trend.libsonnet index 1e4a1b65..e4cb8038 100644 --- a/gen/grafonnet-v11.0.0/panel/trend.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/trend.libsonnet @@ -242,6 +242,26 @@ }, }, }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withLineColor(value): { fieldConfig+: { From 5c49ca08ec286906a5d03a1b22f133eccb538748 Mon Sep 17 00:00:00 2001 From: Duologic Date: Mon, 13 May 2024 14:39:02 +0200 Subject: [PATCH 06/17] fix(dashboardList): showFolderNames property --- docs/API/panel/dashboardList/index.md | 13 +++++++++++++ .../docs/panel/dashboardList/index.md | 13 +++++++++++++ gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet | 6 ++++++ 3 files changed, 32 insertions(+) diff --git a/docs/API/panel/dashboardList/index.md b/docs/API/panel/dashboardList/index.md index a5139210..0f6501f0 100644 --- a/docs/API/panel/dashboardList/index.md +++ b/docs/API/panel/dashboardList/index.md @@ -23,6 +23,7 @@ grafonnet.panel.dashboardList * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) * [`fn withQuery(value="")`](#fn-optionswithquery) + * [`fn withShowFolderNames(value=true)`](#fn-optionswithshowfoldernames) * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) @@ -184,6 +185,18 @@ PARAMETERS: - default value: `""` +#### fn options.withShowFolderNames + +```jsonnet +options.withShowFolderNames(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + #### fn options.withShowHeadings ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md index a5139210..0f6501f0 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md @@ -23,6 +23,7 @@ grafonnet.panel.dashboardList * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) * [`fn withQuery(value="")`](#fn-optionswithquery) + * [`fn withShowFolderNames(value=true)`](#fn-optionswithshowfoldernames) * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) @@ -184,6 +185,18 @@ PARAMETERS: - default value: `""` +#### fn options.withShowFolderNames + +```jsonnet +options.withShowFolderNames(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + #### fn options.withShowHeadings ```jsonnet diff --git a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet index 9e7ccd1f..a4997b8c 100644 --- a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet @@ -47,6 +47,12 @@ query: value, }, }, + '#withShowFolderNames': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowFolderNames(value=true): { + options+: { + showFolderNames: value, + }, + }, '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, withShowHeadings(value=true): { options+: { From 83c4d5266fcd86e67552859593b0ab4dc9a1e565 Mon Sep 17 00:00:00 2001 From: Duologic Date: Tue, 14 May 2024 09:31:34 +0200 Subject: [PATCH 07/17] tests(examples): fix tests --- examples/redMethod/output.json | 8 ++++---- examples/runtimeDashboard/output.json | 22 +++++++++++----------- examples/runtimeDashboard/panels.libsonnet | 6 +++--- examples/simple/output.json | 2 +- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/examples/redMethod/output.json b/examples/redMethod/output.json index 8afdd136..730544ce 100644 --- a/examples/redMethod/output.json +++ b/examples/redMethod/output.json @@ -41,7 +41,7 @@ "y": 1 }, "id": 2, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -77,7 +77,7 @@ "y": 1 }, "id": 3, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -138,7 +138,7 @@ "y": 10 }, "id": 5, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -174,7 +174,7 @@ "y": 10 }, "id": 6, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { diff --git a/examples/runtimeDashboard/output.json b/examples/runtimeDashboard/output.json index 2634966f..14a5e663 100644 --- a/examples/runtimeDashboard/output.json +++ b/examples/runtimeDashboard/output.json @@ -50,7 +50,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -128,7 +128,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -200,7 +200,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -245,7 +245,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -295,7 +295,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -352,7 +352,7 @@ "unit": "s" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -422,7 +422,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -487,7 +487,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -534,7 +534,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -595,7 +595,7 @@ "unit": "s" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { @@ -665,7 +665,7 @@ "displayMode": "table" } }, - "pluginVersion": "v10.4.0", + "pluginVersion": "v11.0.0", "targets": [ { "datasource": { diff --git a/examples/runtimeDashboard/panels.libsonnet b/examples/runtimeDashboard/panels.libsonnet index fa71344d..7b45faf1 100644 --- a/examples/runtimeDashboard/panels.libsonnet +++ b/examples/runtimeDashboard/panels.libsonnet @@ -91,9 +91,9 @@ local g = import 'g.libsonnet'; + options.calculation.xBuckets.withMode('size') + options.calculation.xBuckets.withValue('1min') + options.withCellGap(2) - + options.color.HeatmapColorOptions.withMode('scheme') - + options.color.HeatmapColorOptions.withScheme('Spectral') - + options.color.HeatmapColorOptions.withSteps(128) + + options.color.withMode('scheme') + + options.color.withScheme('Spectral') + + options.color.withSteps(128) + options.yAxis.withDecimals(0) + options.yAxis.withUnit('s'), }, diff --git a/examples/simple/output.json b/examples/simple/output.json index 3708015b..095b138d 100644 --- a/examples/simple/output.json +++ b/examples/simple/output.json @@ -17,7 +17,7 @@ w: 24, }, id: 1, - pluginVersion: 'v10.4.0', + pluginVersion: 'v11.0.0', targets: [ { datasource: { From 04f7539254fa11a9eb32d00ed658c71702d8b688 Mon Sep 17 00:00:00 2001 From: Duologic Date: Wed, 22 May 2024 22:11:44 +0200 Subject: [PATCH 08/17] schema fixes --- custom/query/loki.libsonnet | 1 + custom/query/prometheus.libsonnet | 1 + custom/query/tempo.libsonnet | 1 + docs/API/accesspolicy/rules.md | 17 +- docs/API/panel/alertList/index.md | 574 +++++++++++++++++- docs/API/panel/barChart/index.md | 10 +- docs/API/panel/candlestick/index.md | 10 +- docs/API/panel/histogram/index.md | 10 +- docs/API/panel/stateTimeline/index.md | 10 +- docs/API/panel/statusHistory/index.md | 10 +- docs/API/panel/timeSeries/index.md | 10 +- docs/API/panel/trend/index.md | 10 +- docs/API/panel/xyChart/index.md | 10 +- docs/API/query/elasticsearch/index.md | 33 +- docs/API/query/googlecloudmonitoring.md | 17 +- docs/API/query/grafanapyroscope.md | 32 +- docs/API/query/loki.md | 34 +- docs/API/query/parca.md | 22 +- docs/API/query/prometheus.md | 28 +- docs/API/query/tempo/index.md | 15 - docs/API/role.md | 17 +- gen/grafonnet-v11.0.0/accesspolicy.libsonnet | 8 +- .../custom/query/loki.libsonnet | 1 + .../custom/query/prometheus.libsonnet | 1 + .../custom/query/tempo.libsonnet | 1 + .../docs/accesspolicy/rules.md | 17 +- .../docs/panel/alertList/index.md | 574 +++++++++++++++++- .../docs/panel/barChart/index.md | 10 +- .../docs/panel/candlestick/index.md | 10 +- .../docs/panel/histogram/index.md | 10 +- .../docs/panel/stateTimeline/index.md | 10 +- .../docs/panel/statusHistory/index.md | 10 +- .../docs/panel/timeSeries/index.md | 10 +- .../docs/panel/trend/index.md | 10 +- .../docs/panel/xyChart/index.md | 10 +- .../docs/query/elasticsearch/index.md | 33 +- .../docs/query/googlecloudmonitoring.md | 17 +- .../docs/query/grafanapyroscope.md | 32 +- gen/grafonnet-v11.0.0/docs/query/loki.md | 34 +- gen/grafonnet-v11.0.0/docs/query/parca.md | 22 +- .../docs/query/prometheus.md | 28 +- .../docs/query/tempo/index.md | 15 - gen/grafonnet-v11.0.0/docs/role.md | 17 +- .../panel/alertList.libsonnet | 326 +++++++++- .../panel/annotationsList.libsonnet | 2 +- .../panel/barChart.libsonnet | 6 +- .../panel/barGauge.libsonnet | 2 +- .../panel/candlestick.libsonnet | 6 +- gen/grafonnet-v11.0.0/panel/canvas.libsonnet | 2 +- .../panel/dashboardList.libsonnet | 2 +- .../panel/datagrid.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/debug.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/gauge.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/geomap.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/heatmap.libsonnet | 2 +- .../panel/histogram.libsonnet | 6 +- gen/grafonnet-v11.0.0/panel/logs.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/news.libsonnet | 2 +- .../panel/nodeGraph.libsonnet | 2 +- .../panel/pieChart.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/stat.libsonnet | 2 +- .../panel/stateTimeline.libsonnet | 6 +- .../panel/statusHistory.libsonnet | 6 +- gen/grafonnet-v11.0.0/panel/table.libsonnet | 2 +- gen/grafonnet-v11.0.0/panel/text.libsonnet | 2 +- .../panel/timeSeries.libsonnet | 6 +- gen/grafonnet-v11.0.0/panel/trend.libsonnet | 6 +- gen/grafonnet-v11.0.0/panel/xyChart.libsonnet | 6 +- .../query/elasticsearch.libsonnet | 24 +- .../query/googlecloudmonitoring.libsonnet | 10 +- .../query/grafanapyroscope.libsonnet | 24 +- gen/grafonnet-v11.0.0/query/loki.libsonnet | 24 +- gen/grafonnet-v11.0.0/query/parca.libsonnet | 14 +- .../query/prometheus.libsonnet | 22 +- gen/grafonnet-v11.0.0/role.libsonnet | 8 +- generator/panel.libsonnet | 18 +- generator/patches/schemas.libsonnet | 15 +- generator/utils.libsonnet | 18 - 78 files changed, 1866 insertions(+), 469 deletions(-) diff --git a/custom/query/loki.libsonnet b/custom/query/loki.libsonnet index 9c19f835..48311452 100644 --- a/custom/query/loki.libsonnet +++ b/custom/query/loki.libsonnet @@ -24,4 +24,5 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; uid: value, }, }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/custom/query/prometheus.libsonnet b/custom/query/prometheus.libsonnet index 3abe2212..68e1e057 100644 --- a/custom/query/prometheus.libsonnet +++ b/custom/query/prometheus.libsonnet @@ -44,4 +44,5 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; uid: value, }, }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/custom/query/tempo.libsonnet b/custom/query/tempo.libsonnet index debcb73a..f9fc9109 100644 --- a/custom/query/tempo.libsonnet +++ b/custom/query/tempo.libsonnet @@ -26,4 +26,5 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; uid: value, }, }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/docs/API/accesspolicy/rules.md b/docs/API/accesspolicy/rules.md index 86de7c06..f5763390 100644 --- a/docs/API/accesspolicy/rules.md +++ b/docs/API/accesspolicy/rules.md @@ -4,8 +4,7 @@ ## Index -* [`fn withKind(value)`](#fn-withkind) -* [`fn withKindMixin(value)`](#fn-withkindmixin) +* [`fn withKind(value="*")`](#fn-withkind) * [`fn withTarget(value)`](#fn-withtarget) * [`fn withVerb(value)`](#fn-withverb) * [`fn withVerbMixin(value)`](#fn-withverbmixin) @@ -15,23 +14,13 @@ ### fn withKind ```jsonnet -withKind(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The kind this rule applies to (dashboards, alert, etc) -### fn withKindMixin - -```jsonnet -withKindMixin(value) +withKind(value="*") ``` PARAMETERS: * **value** (`string`) + - default value: `"*"` The kind this rule applies to (dashboards, alert, etc) ### fn withTarget diff --git a/docs/API/panel/alertList/index.md b/docs/API/panel/alertList/index.md index 66807e33..50f35939 100644 --- a/docs/API/panel/alertList/index.md +++ b/docs/API/panel/alertList/index.md @@ -16,6 +16,56 @@ grafonnet.panel.alertList * [`obj libraryPanel`](#obj-librarypanel) * [`fn withName(value)`](#fn-librarypanelwithname) * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlertListOptions(value)`](#fn-optionswithalertlistoptions) + * [`fn withAlertListOptionsMixin(value)`](#fn-optionswithalertlistoptionsmixin) + * [`fn withUnifiedAlertListOptions(value)`](#fn-optionswithunifiedalertlistoptions) + * [`fn withUnifiedAlertListOptionsMixin(value)`](#fn-optionswithunifiedalertlistoptionsmixin) + * [`obj AlertListOptions`](#obj-optionsalertlistoptions) + * [`fn withAlertName(value)`](#fn-optionsalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsalertlistoptionswithdashboardalerts) + * [`fn withDashboardTitle(value)`](#fn-optionsalertlistoptionswithdashboardtitle) + * [`fn withFolderId(value)`](#fn-optionsalertlistoptionswithfolderid) + * [`fn withMaxItems(value)`](#fn-optionsalertlistoptionswithmaxitems) + * [`fn withShowOptions(value)`](#fn-optionsalertlistoptionswithshowoptions) + * [`fn withSortOrder(value)`](#fn-optionsalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsalertlistoptionswithstatefiltermixin) + * [`fn withTags(value)`](#fn-optionsalertlistoptionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionsalertlistoptionswithtagsmixin) + * [`obj stateFilter`](#obj-optionsalertlistoptionsstatefilter) + * [`fn withAlerting(value=true)`](#fn-optionsalertlistoptionsstatefilterwithalerting) + * [`fn withExecutionError(value=true)`](#fn-optionsalertlistoptionsstatefilterwithexecutionerror) + * [`fn withNoData(value=true)`](#fn-optionsalertlistoptionsstatefilterwithnodata) + * [`fn withOk(value=true)`](#fn-optionsalertlistoptionsstatefilterwithok) + * [`fn withPaused(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpaused) + * [`fn withPending(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpending) + * [`obj UnifiedAlertListOptions`](#obj-optionsunifiedalertlistoptions) + * [`fn withAlertInstanceLabelFilter(value)`](#fn-optionsunifiedalertlistoptionswithalertinstancelabelfilter) + * [`fn withAlertName(value)`](#fn-optionsunifiedalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsunifiedalertlistoptionswithdashboardalerts) + * [`fn withDatasource(value)`](#fn-optionsunifiedalertlistoptionswithdatasource) + * [`fn withFolder(value)`](#fn-optionsunifiedalertlistoptionswithfolder) + * [`fn withFolderMixin(value)`](#fn-optionsunifiedalertlistoptionswithfoldermixin) + * [`fn withGroupBy(value)`](#fn-optionsunifiedalertlistoptionswithgroupby) + * [`fn withGroupByMixin(value)`](#fn-optionsunifiedalertlistoptionswithgroupbymixin) + * [`fn withGroupMode(value)`](#fn-optionsunifiedalertlistoptionswithgroupmode) + * [`fn withMaxItems(value)`](#fn-optionsunifiedalertlistoptionswithmaxitems) + * [`fn withShowInstances(value=true)`](#fn-optionsunifiedalertlistoptionswithshowinstances) + * [`fn withSortOrder(value)`](#fn-optionsunifiedalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsunifiedalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsunifiedalertlistoptionswithstatefiltermixin) + * [`fn withViewMode(value)`](#fn-optionsunifiedalertlistoptionswithviewmode) + * [`obj folder`](#obj-optionsunifiedalertlistoptionsfolder) + * [`fn withId(value)`](#fn-optionsunifiedalertlistoptionsfolderwithid) + * [`fn withTitle(value)`](#fn-optionsunifiedalertlistoptionsfolderwithtitle) + * [`obj stateFilter`](#obj-optionsunifiedalertlistoptionsstatefilter) + * [`fn withError(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwitherror) + * [`fn withFiring(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithfiring) + * [`fn withInactive(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithinactive) + * [`fn withNoData(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnodata) + * [`fn withNormal(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnormal) + * [`fn withPending(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithpending) * [`obj panelOptions`](#obj-paneloptions) * [`fn withDescription(value)`](#fn-paneloptionswithdescription) * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) @@ -72,7 +122,7 @@ PARAMETERS: * **title** (`string`) -Creates a new alertlist panel with a title. +Creates a new AlertList panel with a title. ### obj libraryPanel @@ -98,6 +148,528 @@ PARAMETERS: * **value** (`string`) Library panel uid +### obj options + + +#### fn options.withAlertListOptions + +```jsonnet +options.withAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withAlertListOptionsMixin + +```jsonnet +options.withAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptions + +```jsonnet +options.withUnifiedAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptionsMixin + +```jsonnet +options.withUnifiedAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.AlertListOptions + + +##### fn options.AlertListOptions.withAlertName + +```jsonnet +options.AlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withDashboardAlerts + +```jsonnet +options.AlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.AlertListOptions.withDashboardTitle + +```jsonnet +options.AlertListOptions.withDashboardTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withFolderId + +```jsonnet +options.AlertListOptions.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withMaxItems + +```jsonnet +options.AlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withShowOptions + +```jsonnet +options.AlertListOptions.withShowOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"current"`, `"changes"` + + +##### fn options.AlertListOptions.withSortOrder + +```jsonnet +options.AlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.AlertListOptions.withStateFilter + +```jsonnet +options.AlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withStateFilterMixin + +```jsonnet +options.AlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withTags + +```jsonnet +options.AlertListOptions.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.AlertListOptions.withTagsMixin + +```jsonnet +options.AlertListOptions.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### obj options.AlertListOptions.stateFilter + + +###### fn options.AlertListOptions.stateFilter.withAlerting + +```jsonnet +options.AlertListOptions.stateFilter.withAlerting(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withExecutionError + +```jsonnet +options.AlertListOptions.stateFilter.withExecutionError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withNoData + +```jsonnet +options.AlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withOk + +```jsonnet +options.AlertListOptions.stateFilter.withOk(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPaused + +```jsonnet +options.AlertListOptions.stateFilter.withPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPending + +```jsonnet +options.AlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.UnifiedAlertListOptions + + +##### fn options.UnifiedAlertListOptions.withAlertInstanceLabelFilter + +```jsonnet +options.UnifiedAlertListOptions.withAlertInstanceLabelFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withAlertName + +```jsonnet +options.UnifiedAlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withDashboardAlerts + +```jsonnet +options.UnifiedAlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withDatasource + +```jsonnet +options.UnifiedAlertListOptions.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withFolder + +```jsonnet +options.UnifiedAlertListOptions.withFolder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withFolderMixin + +```jsonnet +options.UnifiedAlertListOptions.withFolderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withGroupBy + +```jsonnet +options.UnifiedAlertListOptions.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupByMixin + +```jsonnet +options.UnifiedAlertListOptions.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupMode + +```jsonnet +options.UnifiedAlertListOptions.withGroupMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"default"`, `"custom"` + + +##### fn options.UnifiedAlertListOptions.withMaxItems + +```jsonnet +options.UnifiedAlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.UnifiedAlertListOptions.withShowInstances + +```jsonnet +options.UnifiedAlertListOptions.withShowInstances(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withSortOrder + +```jsonnet +options.UnifiedAlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.UnifiedAlertListOptions.withStateFilter + +```jsonnet +options.UnifiedAlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withStateFilterMixin + +```jsonnet +options.UnifiedAlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withViewMode + +```jsonnet +options.UnifiedAlertListOptions.withViewMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"stat"` + + +##### obj options.UnifiedAlertListOptions.folder + + +###### fn options.UnifiedAlertListOptions.folder.withId + +```jsonnet +options.UnifiedAlertListOptions.folder.withId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.UnifiedAlertListOptions.folder.withTitle + +```jsonnet +options.UnifiedAlertListOptions.folder.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.UnifiedAlertListOptions.stateFilter + + +###### fn options.UnifiedAlertListOptions.stateFilter.withError + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withFiring + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withFiring(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withInactive + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withInactive(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNoData + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNormal + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNormal(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withPending + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + ### obj panelOptions diff --git a/docs/API/panel/barChart/index.md b/docs/API/panel/barChart/index.md index caf3c7f8..8865ac7d 100644 --- a/docs/API/panel/barChart/index.md +++ b/docs/API/panel/barChart/index.md @@ -68,8 +68,8 @@ grafonnet.panel.barChart * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -703,23 +703,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/candlestick/index.md b/docs/API/panel/candlestick/index.md index 534a80df..260c1250 100644 --- a/docs/API/panel/candlestick/index.md +++ b/docs/API/panel/candlestick/index.md @@ -100,8 +100,8 @@ grafonnet.panel.candlestick * [`fn withVolume(value)`](#fn-optionsfieldswithvolume) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -1057,23 +1057,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/histogram/index.md b/docs/API/panel/histogram/index.md index 0d098f74..a939871f 100644 --- a/docs/API/panel/histogram/index.md +++ b/docs/API/panel/histogram/index.md @@ -59,8 +59,8 @@ grafonnet.panel.histogram * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -584,23 +584,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/stateTimeline/index.md b/docs/API/panel/stateTimeline/index.md index e04563e7..6d71036f 100644 --- a/docs/API/panel/stateTimeline/index.md +++ b/docs/API/panel/stateTimeline/index.md @@ -40,8 +40,8 @@ grafonnet.panel.stateTimeline * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -368,23 +368,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/statusHistory/index.md b/docs/API/panel/statusHistory/index.md index 0d31d6a1..5f80aec6 100644 --- a/docs/API/panel/statusHistory/index.md +++ b/docs/API/panel/statusHistory/index.md @@ -39,8 +39,8 @@ grafonnet.panel.statusHistory * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -355,23 +355,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/timeSeries/index.md b/docs/API/panel/timeSeries/index.md index 92003ea3..0b30e977 100644 --- a/docs/API/panel/timeSeries/index.md +++ b/docs/API/panel/timeSeries/index.md @@ -85,8 +85,8 @@ grafonnet.panel.timeSeries * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -890,23 +890,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/trend/index.md b/docs/API/panel/trend/index.md index 13205b34..c0f4ff29 100644 --- a/docs/API/panel/trend/index.md +++ b/docs/API/panel/trend/index.md @@ -83,8 +83,8 @@ grafonnet.panel.trend * [`fn withXField(value)`](#fn-optionswithxfield) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -862,23 +862,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/panel/xyChart/index.md b/docs/API/panel/xyChart/index.md index 12137f35..42142405 100644 --- a/docs/API/panel/xyChart/index.md +++ b/docs/API/panel/xyChart/index.md @@ -91,8 +91,8 @@ grafonnet.panel.xyChart * [`fn withX(value)`](#fn-optionsdimswithx) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -916,23 +916,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/docs/API/query/elasticsearch/index.md b/docs/API/query/elasticsearch/index.md index d26292ae..a003cf53 100644 --- a/docs/API/query/elasticsearch/index.md +++ b/docs/API/query/elasticsearch/index.md @@ -343,7 +343,7 @@ PARAMETERS: * **value** (`string`) - +Alias pattern ### fn withBucketAggs ```jsonnet @@ -354,7 +354,7 @@ PARAMETERS: * **value** (`array`) - +List of bucket aggregations ### fn withBucketAggsMixin ```jsonnet @@ -365,7 +365,7 @@ PARAMETERS: * **value** (`array`) - +List of bucket aggregations ### fn withDatasource ```jsonnet @@ -376,7 +376,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withDatasourceMixin ```jsonnet @@ -387,7 +390,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withHide ```jsonnet @@ -399,7 +405,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withMetrics ```jsonnet @@ -410,7 +416,7 @@ PARAMETERS: * **value** (`array`) - +List of metric aggregations ### fn withMetricsMixin ```jsonnet @@ -421,7 +427,7 @@ PARAMETERS: * **value** (`array`) - +List of metric aggregations ### fn withQuery ```jsonnet @@ -432,7 +438,7 @@ PARAMETERS: * **value** (`string`) - +Lucene query ### fn withQueryType ```jsonnet @@ -443,7 +449,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRefId ```jsonnet @@ -454,7 +461,9 @@ PARAMETERS: * **value** (`string`) - +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. ### fn withTimeField ```jsonnet @@ -465,7 +474,7 @@ PARAMETERS: * **value** (`string`) - +Name of time field ### obj bucketAggs diff --git a/docs/API/query/googlecloudmonitoring.md b/docs/API/query/googlecloudmonitoring.md index f670470e..842503fc 100644 --- a/docs/API/query/googlecloudmonitoring.md +++ b/docs/API/query/googlecloudmonitoring.md @@ -53,8 +53,7 @@ grafonnet.query.googlecloudmonitoring * [`fn withTitle(value)`](#fn-timeserieslistwithtitle) * [`fn withView(value)`](#fn-timeserieslistwithview) * [`obj timeSeriesQuery`](#obj-timeseriesquery) - * [`fn withGraphPeriod(value)`](#fn-timeseriesquerywithgraphperiod) - * [`fn withGraphPeriodMixin(value)`](#fn-timeseriesquerywithgraphperiodmixin) + * [`fn withGraphPeriod(value="disabled")`](#fn-timeseriesquerywithgraphperiod) * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) @@ -581,23 +580,13 @@ Data view, defaults to FULL. #### fn timeSeriesQuery.withGraphPeriod ```jsonnet -timeSeriesQuery.withGraphPeriod(value) -``` - -PARAMETERS: - -* **value** (`string`) - -To disable the graphPeriod, it should explictly be set to 'disabled'. -#### fn timeSeriesQuery.withGraphPeriodMixin - -```jsonnet -timeSeriesQuery.withGraphPeriodMixin(value) +timeSeriesQuery.withGraphPeriod(value="disabled") ``` PARAMETERS: * **value** (`string`) + - default value: `"disabled"` To disable the graphPeriod, it should explictly be set to 'disabled'. #### fn timeSeriesQuery.withProjectName diff --git a/docs/API/query/grafanapyroscope.md b/docs/API/query/grafanapyroscope.md index 63a8f7a0..3f982fdc 100644 --- a/docs/API/query/grafanapyroscope.md +++ b/docs/API/query/grafanapyroscope.md @@ -29,7 +29,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withDatasourceMixin ```jsonnet @@ -40,7 +43,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withGroupBy ```jsonnet @@ -51,7 +57,7 @@ PARAMETERS: * **value** (`array`) - +Allows to group the results. ### fn withGroupByMixin ```jsonnet @@ -62,7 +68,7 @@ PARAMETERS: * **value** (`array`) - +Allows to group the results. ### fn withHide ```jsonnet @@ -74,7 +80,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withLabelSelector ```jsonnet @@ -86,7 +92,7 @@ PARAMETERS: * **value** (`string`) - default value: `"{}"` - +Specifies the query label selectors. ### fn withMaxNodes ```jsonnet @@ -97,7 +103,7 @@ PARAMETERS: * **value** (`integer`) - +Sets the maximum number of nodes in the flamegraph. ### fn withProfileTypeId ```jsonnet @@ -108,7 +114,7 @@ PARAMETERS: * **value** (`string`) - +Specifies the type of profile to query. ### fn withQueryType ```jsonnet @@ -119,7 +125,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRefId ```jsonnet @@ -130,7 +137,9 @@ PARAMETERS: * **value** (`string`) - +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. ### fn withSpanSelector ```jsonnet @@ -141,7 +150,7 @@ PARAMETERS: * **value** (`array`) - +Specifies the query span selectors. ### fn withSpanSelectorMixin ```jsonnet @@ -152,3 +161,4 @@ PARAMETERS: * **value** (`array`) +Specifies the query span selectors. \ No newline at end of file diff --git a/docs/API/query/loki.md b/docs/API/query/loki.md index f0246b80..2ebd28f2 100644 --- a/docs/API/query/loki.md +++ b/docs/API/query/loki.md @@ -6,7 +6,6 @@ grafonnet.query.loki * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExpr(value)`](#fn-withexpr) * [`fn withHide(value=true)`](#fn-withhide) @@ -44,17 +43,6 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - ### fn withEditorMode ```jsonnet @@ -77,7 +65,7 @@ PARAMETERS: * **value** (`string`) - +The LogQL query. ### fn withHide ```jsonnet @@ -89,7 +77,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withInstant ```jsonnet @@ -101,7 +89,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +@deprecated, now use queryType. ### fn withLegendFormat ```jsonnet @@ -112,7 +100,7 @@ PARAMETERS: * **value** (`string`) - +Used to override the name of the series. ### fn withMaxLines ```jsonnet @@ -123,7 +111,7 @@ PARAMETERS: * **value** (`integer`) - +Used to limit the number of log rows returned. ### fn withQueryType ```jsonnet @@ -134,7 +122,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRange ```jsonnet @@ -146,7 +135,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +@deprecated, now use queryType. ### fn withRefId ```jsonnet @@ -157,7 +146,9 @@ PARAMETERS: * **value** (`string`) - +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. ### fn withResolution ```jsonnet @@ -168,7 +159,7 @@ PARAMETERS: * **value** (`integer`) - +@deprecated, now use step. ### fn withStep ```jsonnet @@ -179,3 +170,4 @@ PARAMETERS: * **value** (`string`) +Used to set step value for range queries. \ No newline at end of file diff --git a/docs/API/query/parca.md b/docs/API/query/parca.md index 562caa77..8046ea47 100644 --- a/docs/API/query/parca.md +++ b/docs/API/query/parca.md @@ -24,7 +24,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withDatasourceMixin ```jsonnet @@ -35,7 +38,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withHide ```jsonnet @@ -47,7 +53,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withLabelSelector ```jsonnet @@ -59,7 +65,7 @@ PARAMETERS: * **value** (`string`) - default value: `"{}"` - +Specifies the query label selectors. ### fn withProfileTypeId ```jsonnet @@ -70,7 +76,7 @@ PARAMETERS: * **value** (`string`) - +Specifies the type of profile to query. ### fn withQueryType ```jsonnet @@ -81,7 +87,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRefId ```jsonnet @@ -92,3 +99,6 @@ PARAMETERS: * **value** (`string`) +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/docs/API/query/prometheus.md b/docs/API/query/prometheus.md index 054c00ae..df1b1462 100644 --- a/docs/API/query/prometheus.md +++ b/docs/API/query/prometheus.md @@ -6,7 +6,6 @@ grafonnet.query.prometheus * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExemplar(value=true)`](#fn-withexemplar) * [`fn withExpr(value)`](#fn-withexpr) @@ -45,17 +44,6 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - ### fn withEditorMode ```jsonnet @@ -79,7 +67,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +Execute an additional query to identify interesting raw samples relevant for the given expr ### fn withExpr ```jsonnet @@ -90,7 +78,7 @@ PARAMETERS: * **value** (`string`) - +The actual expression/query that will be evaluated by Prometheus ### fn withFormat ```jsonnet @@ -114,7 +102,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withInstant ```jsonnet @@ -126,7 +114,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +Returns only the latest value that Prometheus has scraped for the requested time series ### fn withInterval ```jsonnet @@ -171,7 +159,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRange ```jsonnet @@ -183,7 +172,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series ### fn withRefId ```jsonnet @@ -194,3 +183,6 @@ PARAMETERS: * **value** (`string`) +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/docs/API/query/tempo/index.md b/docs/API/query/tempo/index.md index 934fb7b3..c3d9877b 100644 --- a/docs/API/query/tempo/index.md +++ b/docs/API/query/tempo/index.md @@ -11,7 +11,6 @@ grafonnet.query.tempo * [`fn new(datasource, query, filters)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withFilters(value)`](#fn-withfilters) * [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) * [`fn withGroupBy(value)`](#fn-withgroupby) @@ -58,20 +57,6 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null ### fn withFilters ```jsonnet diff --git a/docs/API/role.md b/docs/API/role.md index bb77d199..b5b551cc 100644 --- a/docs/API/role.md +++ b/docs/API/role.md @@ -7,8 +7,7 @@ grafonnet.role * [`fn withDescription(value)`](#fn-withdescription) * [`fn withDisplayName(value)`](#fn-withdisplayname) * [`fn withGroupName(value)`](#fn-withgroupname) -* [`fn withHidden(value)`](#fn-withhidden) -* [`fn withHiddenMixin(value)`](#fn-withhiddenmixin) +* [`fn withHidden(value=true)`](#fn-withhidden) * [`fn withName(value)`](#fn-withname) ## Fields @@ -49,23 +48,13 @@ Name of the team. ### fn withHidden ```jsonnet -withHidden(value) -``` - -PARAMETERS: - -* **value** (`boolean`) - -Do not show this role -### fn withHiddenMixin - -```jsonnet -withHiddenMixin(value) +withHidden(value=true) ``` PARAMETERS: * **value** (`boolean`) + - default value: `true` Do not show this role ### fn withName diff --git a/gen/grafonnet-v11.0.0/accesspolicy.libsonnet b/gen/grafonnet-v11.0.0/accesspolicy.libsonnet index fa095db1..3a7dd8e8 100644 --- a/gen/grafonnet-v11.0.0/accesspolicy.libsonnet +++ b/gen/grafonnet-v11.0.0/accesspolicy.libsonnet @@ -47,14 +47,10 @@ rules+: { '#': { help: '', name: 'rules' }, - '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, - withKind(value): { + '#withKind': { 'function': { args: [{ default: '*', enums: null, name: 'value', type: ['string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, + withKind(value='*'): { kind: value, }, - '#withKindMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, - withKindMixin(value): { - kind+: value, - }, '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific sub-elements like "alert.rules" or "dashboard.permissions"????' } }, withTarget(value): { target: value, diff --git a/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet b/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet index 9c19f835..48311452 100644 --- a/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet +++ b/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet @@ -24,4 +24,5 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; uid: value, }, }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet b/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet index 3abe2212..68e1e057 100644 --- a/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet +++ b/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet @@ -44,4 +44,5 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; uid: value, }, }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet b/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet index debcb73a..f9fc9109 100644 --- a/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet +++ b/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet @@ -26,4 +26,5 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; uid: value, }, }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md b/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md index 86de7c06..f5763390 100644 --- a/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md +++ b/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md @@ -4,8 +4,7 @@ ## Index -* [`fn withKind(value)`](#fn-withkind) -* [`fn withKindMixin(value)`](#fn-withkindmixin) +* [`fn withKind(value="*")`](#fn-withkind) * [`fn withTarget(value)`](#fn-withtarget) * [`fn withVerb(value)`](#fn-withverb) * [`fn withVerbMixin(value)`](#fn-withverbmixin) @@ -15,23 +14,13 @@ ### fn withKind ```jsonnet -withKind(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The kind this rule applies to (dashboards, alert, etc) -### fn withKindMixin - -```jsonnet -withKindMixin(value) +withKind(value="*") ``` PARAMETERS: * **value** (`string`) + - default value: `"*"` The kind this rule applies to (dashboards, alert, etc) ### fn withTarget diff --git a/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md b/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md index 66807e33..50f35939 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md @@ -16,6 +16,56 @@ grafonnet.panel.alertList * [`obj libraryPanel`](#obj-librarypanel) * [`fn withName(value)`](#fn-librarypanelwithname) * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlertListOptions(value)`](#fn-optionswithalertlistoptions) + * [`fn withAlertListOptionsMixin(value)`](#fn-optionswithalertlistoptionsmixin) + * [`fn withUnifiedAlertListOptions(value)`](#fn-optionswithunifiedalertlistoptions) + * [`fn withUnifiedAlertListOptionsMixin(value)`](#fn-optionswithunifiedalertlistoptionsmixin) + * [`obj AlertListOptions`](#obj-optionsalertlistoptions) + * [`fn withAlertName(value)`](#fn-optionsalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsalertlistoptionswithdashboardalerts) + * [`fn withDashboardTitle(value)`](#fn-optionsalertlistoptionswithdashboardtitle) + * [`fn withFolderId(value)`](#fn-optionsalertlistoptionswithfolderid) + * [`fn withMaxItems(value)`](#fn-optionsalertlistoptionswithmaxitems) + * [`fn withShowOptions(value)`](#fn-optionsalertlistoptionswithshowoptions) + * [`fn withSortOrder(value)`](#fn-optionsalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsalertlistoptionswithstatefiltermixin) + * [`fn withTags(value)`](#fn-optionsalertlistoptionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionsalertlistoptionswithtagsmixin) + * [`obj stateFilter`](#obj-optionsalertlistoptionsstatefilter) + * [`fn withAlerting(value=true)`](#fn-optionsalertlistoptionsstatefilterwithalerting) + * [`fn withExecutionError(value=true)`](#fn-optionsalertlistoptionsstatefilterwithexecutionerror) + * [`fn withNoData(value=true)`](#fn-optionsalertlistoptionsstatefilterwithnodata) + * [`fn withOk(value=true)`](#fn-optionsalertlistoptionsstatefilterwithok) + * [`fn withPaused(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpaused) + * [`fn withPending(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpending) + * [`obj UnifiedAlertListOptions`](#obj-optionsunifiedalertlistoptions) + * [`fn withAlertInstanceLabelFilter(value)`](#fn-optionsunifiedalertlistoptionswithalertinstancelabelfilter) + * [`fn withAlertName(value)`](#fn-optionsunifiedalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsunifiedalertlistoptionswithdashboardalerts) + * [`fn withDatasource(value)`](#fn-optionsunifiedalertlistoptionswithdatasource) + * [`fn withFolder(value)`](#fn-optionsunifiedalertlistoptionswithfolder) + * [`fn withFolderMixin(value)`](#fn-optionsunifiedalertlistoptionswithfoldermixin) + * [`fn withGroupBy(value)`](#fn-optionsunifiedalertlistoptionswithgroupby) + * [`fn withGroupByMixin(value)`](#fn-optionsunifiedalertlistoptionswithgroupbymixin) + * [`fn withGroupMode(value)`](#fn-optionsunifiedalertlistoptionswithgroupmode) + * [`fn withMaxItems(value)`](#fn-optionsunifiedalertlistoptionswithmaxitems) + * [`fn withShowInstances(value=true)`](#fn-optionsunifiedalertlistoptionswithshowinstances) + * [`fn withSortOrder(value)`](#fn-optionsunifiedalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsunifiedalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsunifiedalertlistoptionswithstatefiltermixin) + * [`fn withViewMode(value)`](#fn-optionsunifiedalertlistoptionswithviewmode) + * [`obj folder`](#obj-optionsunifiedalertlistoptionsfolder) + * [`fn withId(value)`](#fn-optionsunifiedalertlistoptionsfolderwithid) + * [`fn withTitle(value)`](#fn-optionsunifiedalertlistoptionsfolderwithtitle) + * [`obj stateFilter`](#obj-optionsunifiedalertlistoptionsstatefilter) + * [`fn withError(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwitherror) + * [`fn withFiring(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithfiring) + * [`fn withInactive(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithinactive) + * [`fn withNoData(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnodata) + * [`fn withNormal(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnormal) + * [`fn withPending(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithpending) * [`obj panelOptions`](#obj-paneloptions) * [`fn withDescription(value)`](#fn-paneloptionswithdescription) * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) @@ -72,7 +122,7 @@ PARAMETERS: * **title** (`string`) -Creates a new alertlist panel with a title. +Creates a new AlertList panel with a title. ### obj libraryPanel @@ -98,6 +148,528 @@ PARAMETERS: * **value** (`string`) Library panel uid +### obj options + + +#### fn options.withAlertListOptions + +```jsonnet +options.withAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withAlertListOptionsMixin + +```jsonnet +options.withAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptions + +```jsonnet +options.withUnifiedAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptionsMixin + +```jsonnet +options.withUnifiedAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.AlertListOptions + + +##### fn options.AlertListOptions.withAlertName + +```jsonnet +options.AlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withDashboardAlerts + +```jsonnet +options.AlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.AlertListOptions.withDashboardTitle + +```jsonnet +options.AlertListOptions.withDashboardTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withFolderId + +```jsonnet +options.AlertListOptions.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withMaxItems + +```jsonnet +options.AlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withShowOptions + +```jsonnet +options.AlertListOptions.withShowOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"current"`, `"changes"` + + +##### fn options.AlertListOptions.withSortOrder + +```jsonnet +options.AlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.AlertListOptions.withStateFilter + +```jsonnet +options.AlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withStateFilterMixin + +```jsonnet +options.AlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withTags + +```jsonnet +options.AlertListOptions.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.AlertListOptions.withTagsMixin + +```jsonnet +options.AlertListOptions.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### obj options.AlertListOptions.stateFilter + + +###### fn options.AlertListOptions.stateFilter.withAlerting + +```jsonnet +options.AlertListOptions.stateFilter.withAlerting(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withExecutionError + +```jsonnet +options.AlertListOptions.stateFilter.withExecutionError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withNoData + +```jsonnet +options.AlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withOk + +```jsonnet +options.AlertListOptions.stateFilter.withOk(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPaused + +```jsonnet +options.AlertListOptions.stateFilter.withPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPending + +```jsonnet +options.AlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.UnifiedAlertListOptions + + +##### fn options.UnifiedAlertListOptions.withAlertInstanceLabelFilter + +```jsonnet +options.UnifiedAlertListOptions.withAlertInstanceLabelFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withAlertName + +```jsonnet +options.UnifiedAlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withDashboardAlerts + +```jsonnet +options.UnifiedAlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withDatasource + +```jsonnet +options.UnifiedAlertListOptions.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withFolder + +```jsonnet +options.UnifiedAlertListOptions.withFolder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withFolderMixin + +```jsonnet +options.UnifiedAlertListOptions.withFolderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withGroupBy + +```jsonnet +options.UnifiedAlertListOptions.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupByMixin + +```jsonnet +options.UnifiedAlertListOptions.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupMode + +```jsonnet +options.UnifiedAlertListOptions.withGroupMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"default"`, `"custom"` + + +##### fn options.UnifiedAlertListOptions.withMaxItems + +```jsonnet +options.UnifiedAlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.UnifiedAlertListOptions.withShowInstances + +```jsonnet +options.UnifiedAlertListOptions.withShowInstances(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withSortOrder + +```jsonnet +options.UnifiedAlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.UnifiedAlertListOptions.withStateFilter + +```jsonnet +options.UnifiedAlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withStateFilterMixin + +```jsonnet +options.UnifiedAlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withViewMode + +```jsonnet +options.UnifiedAlertListOptions.withViewMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"stat"` + + +##### obj options.UnifiedAlertListOptions.folder + + +###### fn options.UnifiedAlertListOptions.folder.withId + +```jsonnet +options.UnifiedAlertListOptions.folder.withId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.UnifiedAlertListOptions.folder.withTitle + +```jsonnet +options.UnifiedAlertListOptions.folder.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.UnifiedAlertListOptions.stateFilter + + +###### fn options.UnifiedAlertListOptions.stateFilter.withError + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withFiring + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withFiring(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withInactive + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withInactive(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNoData + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNormal + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNormal(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withPending + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + ### obj panelOptions diff --git a/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md b/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md index caf3c7f8..8865ac7d 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md @@ -68,8 +68,8 @@ grafonnet.panel.barChart * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -703,23 +703,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md index 534a80df..260c1250 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md @@ -100,8 +100,8 @@ grafonnet.panel.candlestick * [`fn withVolume(value)`](#fn-optionsfieldswithvolume) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -1057,23 +1057,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md b/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md index 0d098f74..a939871f 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md @@ -59,8 +59,8 @@ grafonnet.panel.histogram * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -584,23 +584,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md index e04563e7..6d71036f 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md @@ -40,8 +40,8 @@ grafonnet.panel.stateTimeline * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -368,23 +368,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md index 0d31d6a1..5f80aec6 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md @@ -39,8 +39,8 @@ grafonnet.panel.statusHistory * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -355,23 +355,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md index 92003ea3..0b30e977 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md @@ -85,8 +85,8 @@ grafonnet.panel.timeSeries * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -890,23 +890,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md index 13205b34..c0f4ff29 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md @@ -83,8 +83,8 @@ grafonnet.panel.trend * [`fn withXField(value)`](#fn-optionswithxfield) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -862,23 +862,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md b/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md index 12137f35..42142405 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md @@ -91,8 +91,8 @@ grafonnet.panel.xyChart * [`fn withX(value)`](#fn-optionsdimswithx) * [`obj legend`](#obj-optionslegend) * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) @@ -916,23 +916,25 @@ PARAMETERS: ##### fn options.legend.withCalcs ```jsonnet -options.legend.withCalcs(value) +options.legend.withCalcs(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withCalcsMixin ```jsonnet -options.legend.withCalcsMixin(value) +options.legend.withCalcsMixin(value=[]) ``` PARAMETERS: * **value** (`array`) + - default value: `[]` ##### fn options.legend.withDisplayMode diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md index d26292ae..a003cf53 100644 --- a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md @@ -343,7 +343,7 @@ PARAMETERS: * **value** (`string`) - +Alias pattern ### fn withBucketAggs ```jsonnet @@ -354,7 +354,7 @@ PARAMETERS: * **value** (`array`) - +List of bucket aggregations ### fn withBucketAggsMixin ```jsonnet @@ -365,7 +365,7 @@ PARAMETERS: * **value** (`array`) - +List of bucket aggregations ### fn withDatasource ```jsonnet @@ -376,7 +376,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withDatasourceMixin ```jsonnet @@ -387,7 +390,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withHide ```jsonnet @@ -399,7 +405,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withMetrics ```jsonnet @@ -410,7 +416,7 @@ PARAMETERS: * **value** (`array`) - +List of metric aggregations ### fn withMetricsMixin ```jsonnet @@ -421,7 +427,7 @@ PARAMETERS: * **value** (`array`) - +List of metric aggregations ### fn withQuery ```jsonnet @@ -432,7 +438,7 @@ PARAMETERS: * **value** (`string`) - +Lucene query ### fn withQueryType ```jsonnet @@ -443,7 +449,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRefId ```jsonnet @@ -454,7 +461,9 @@ PARAMETERS: * **value** (`string`) - +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. ### fn withTimeField ```jsonnet @@ -465,7 +474,7 @@ PARAMETERS: * **value** (`string`) - +Name of time field ### obj bucketAggs diff --git a/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md b/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md index f670470e..842503fc 100644 --- a/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md +++ b/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md @@ -53,8 +53,7 @@ grafonnet.query.googlecloudmonitoring * [`fn withTitle(value)`](#fn-timeserieslistwithtitle) * [`fn withView(value)`](#fn-timeserieslistwithview) * [`obj timeSeriesQuery`](#obj-timeseriesquery) - * [`fn withGraphPeriod(value)`](#fn-timeseriesquerywithgraphperiod) - * [`fn withGraphPeriodMixin(value)`](#fn-timeseriesquerywithgraphperiodmixin) + * [`fn withGraphPeriod(value="disabled")`](#fn-timeseriesquerywithgraphperiod) * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) @@ -581,23 +580,13 @@ Data view, defaults to FULL. #### fn timeSeriesQuery.withGraphPeriod ```jsonnet -timeSeriesQuery.withGraphPeriod(value) -``` - -PARAMETERS: - -* **value** (`string`) - -To disable the graphPeriod, it should explictly be set to 'disabled'. -#### fn timeSeriesQuery.withGraphPeriodMixin - -```jsonnet -timeSeriesQuery.withGraphPeriodMixin(value) +timeSeriesQuery.withGraphPeriod(value="disabled") ``` PARAMETERS: * **value** (`string`) + - default value: `"disabled"` To disable the graphPeriod, it should explictly be set to 'disabled'. #### fn timeSeriesQuery.withProjectName diff --git a/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md b/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md index 63a8f7a0..3f982fdc 100644 --- a/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md +++ b/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md @@ -29,7 +29,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withDatasourceMixin ```jsonnet @@ -40,7 +43,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withGroupBy ```jsonnet @@ -51,7 +57,7 @@ PARAMETERS: * **value** (`array`) - +Allows to group the results. ### fn withGroupByMixin ```jsonnet @@ -62,7 +68,7 @@ PARAMETERS: * **value** (`array`) - +Allows to group the results. ### fn withHide ```jsonnet @@ -74,7 +80,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withLabelSelector ```jsonnet @@ -86,7 +92,7 @@ PARAMETERS: * **value** (`string`) - default value: `"{}"` - +Specifies the query label selectors. ### fn withMaxNodes ```jsonnet @@ -97,7 +103,7 @@ PARAMETERS: * **value** (`integer`) - +Sets the maximum number of nodes in the flamegraph. ### fn withProfileTypeId ```jsonnet @@ -108,7 +114,7 @@ PARAMETERS: * **value** (`string`) - +Specifies the type of profile to query. ### fn withQueryType ```jsonnet @@ -119,7 +125,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRefId ```jsonnet @@ -130,7 +137,9 @@ PARAMETERS: * **value** (`string`) - +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. ### fn withSpanSelector ```jsonnet @@ -141,7 +150,7 @@ PARAMETERS: * **value** (`array`) - +Specifies the query span selectors. ### fn withSpanSelectorMixin ```jsonnet @@ -152,3 +161,4 @@ PARAMETERS: * **value** (`array`) +Specifies the query span selectors. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/loki.md b/gen/grafonnet-v11.0.0/docs/query/loki.md index f0246b80..2ebd28f2 100644 --- a/gen/grafonnet-v11.0.0/docs/query/loki.md +++ b/gen/grafonnet-v11.0.0/docs/query/loki.md @@ -6,7 +6,6 @@ grafonnet.query.loki * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExpr(value)`](#fn-withexpr) * [`fn withHide(value=true)`](#fn-withhide) @@ -44,17 +43,6 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - ### fn withEditorMode ```jsonnet @@ -77,7 +65,7 @@ PARAMETERS: * **value** (`string`) - +The LogQL query. ### fn withHide ```jsonnet @@ -89,7 +77,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withInstant ```jsonnet @@ -101,7 +89,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +@deprecated, now use queryType. ### fn withLegendFormat ```jsonnet @@ -112,7 +100,7 @@ PARAMETERS: * **value** (`string`) - +Used to override the name of the series. ### fn withMaxLines ```jsonnet @@ -123,7 +111,7 @@ PARAMETERS: * **value** (`integer`) - +Used to limit the number of log rows returned. ### fn withQueryType ```jsonnet @@ -134,7 +122,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRange ```jsonnet @@ -146,7 +135,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +@deprecated, now use queryType. ### fn withRefId ```jsonnet @@ -157,7 +146,9 @@ PARAMETERS: * **value** (`string`) - +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. ### fn withResolution ```jsonnet @@ -168,7 +159,7 @@ PARAMETERS: * **value** (`integer`) - +@deprecated, now use step. ### fn withStep ```jsonnet @@ -179,3 +170,4 @@ PARAMETERS: * **value** (`string`) +Used to set step value for range queries. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/parca.md b/gen/grafonnet-v11.0.0/docs/query/parca.md index 562caa77..8046ea47 100644 --- a/gen/grafonnet-v11.0.0/docs/query/parca.md +++ b/gen/grafonnet-v11.0.0/docs/query/parca.md @@ -24,7 +24,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withDatasourceMixin ```jsonnet @@ -35,7 +38,10 @@ PARAMETERS: * **value** (`object`) - +For mixed data sources the selected datasource is on the query level. +For non mixed scenarios this is undefined. +TODO find a better way to do this ^ that's friendly to schema +TODO this shouldn't be unknown but DataSourceRef | null ### fn withHide ```jsonnet @@ -47,7 +53,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withLabelSelector ```jsonnet @@ -59,7 +65,7 @@ PARAMETERS: * **value** (`string`) - default value: `"{}"` - +Specifies the query label selectors. ### fn withProfileTypeId ```jsonnet @@ -70,7 +76,7 @@ PARAMETERS: * **value** (`string`) - +Specifies the type of profile to query. ### fn withQueryType ```jsonnet @@ -81,7 +87,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRefId ```jsonnet @@ -92,3 +99,6 @@ PARAMETERS: * **value** (`string`) +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/prometheus.md b/gen/grafonnet-v11.0.0/docs/query/prometheus.md index 054c00ae..df1b1462 100644 --- a/gen/grafonnet-v11.0.0/docs/query/prometheus.md +++ b/gen/grafonnet-v11.0.0/docs/query/prometheus.md @@ -6,7 +6,6 @@ grafonnet.query.prometheus * [`fn new(datasource, expr)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withEditorMode(value)`](#fn-witheditormode) * [`fn withExemplar(value=true)`](#fn-withexemplar) * [`fn withExpr(value)`](#fn-withexpr) @@ -45,17 +44,6 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - ### fn withEditorMode ```jsonnet @@ -79,7 +67,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +Execute an additional query to identify interesting raw samples relevant for the given expr ### fn withExpr ```jsonnet @@ -90,7 +78,7 @@ PARAMETERS: * **value** (`string`) - +The actual expression/query that will be evaluated by Prometheus ### fn withFormat ```jsonnet @@ -114,7 +102,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. ### fn withInstant ```jsonnet @@ -126,7 +114,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +Returns only the latest value that Prometheus has scraped for the requested time series ### fn withInterval ```jsonnet @@ -171,7 +159,8 @@ PARAMETERS: * **value** (`string`) - +Specify the query flavor +TODO make this required and give it a default ### fn withRange ```jsonnet @@ -183,7 +172,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` - +Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series ### fn withRefId ```jsonnet @@ -194,3 +183,6 @@ PARAMETERS: * **value** (`string`) +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/tempo/index.md b/gen/grafonnet-v11.0.0/docs/query/tempo/index.md index 934fb7b3..c3d9877b 100644 --- a/gen/grafonnet-v11.0.0/docs/query/tempo/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/tempo/index.md @@ -11,7 +11,6 @@ grafonnet.query.tempo * [`fn new(datasource, query, filters)`](#fn-new) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withFilters(value)`](#fn-withfilters) * [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) * [`fn withGroupBy(value)`](#fn-withgroupby) @@ -58,20 +57,6 @@ PARAMETERS: * **value** (`string`) Set the datasource for this query. -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null ### fn withFilters ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/role.md b/gen/grafonnet-v11.0.0/docs/role.md index bb77d199..b5b551cc 100644 --- a/gen/grafonnet-v11.0.0/docs/role.md +++ b/gen/grafonnet-v11.0.0/docs/role.md @@ -7,8 +7,7 @@ grafonnet.role * [`fn withDescription(value)`](#fn-withdescription) * [`fn withDisplayName(value)`](#fn-withdisplayname) * [`fn withGroupName(value)`](#fn-withgroupname) -* [`fn withHidden(value)`](#fn-withhidden) -* [`fn withHiddenMixin(value)`](#fn-withhiddenmixin) +* [`fn withHidden(value=true)`](#fn-withhidden) * [`fn withName(value)`](#fn-withname) ## Fields @@ -49,23 +48,13 @@ Name of the team. ### fn withHidden ```jsonnet -withHidden(value) -``` - -PARAMETERS: - -* **value** (`boolean`) - -Do not show this role -### fn withHiddenMixin - -```jsonnet -withHiddenMixin(value) +withHidden(value=true) ``` PARAMETERS: * **value** (`boolean`) + - default value: `true` Do not show this role ### fn withName diff --git a/gen/grafonnet-v11.0.0/panel/alertList.libsonnet b/gen/grafonnet-v11.0.0/panel/alertList.libsonnet index da5434e6..e74ff7db 100644 --- a/gen/grafonnet-v11.0.0/panel/alertList.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/alertList.libsonnet @@ -6,14 +6,336 @@ { '#withType': { 'function': { args: [], help: '' } }, withType(): { - type: 'alertlist', + type: 'AlertList', }, }, + options+: + { + '#withAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptions(value): { + options+: { + AlertListOptions: value, + }, + }, + '#withAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptionsMixin(value): { + options+: { + AlertListOptions+: value, + }, + }, + AlertListOptions+: + { + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { + options+: { + alertName: value, + }, + }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { + options+: { + dashboardAlerts: value, + }, + }, + '#withDashboardTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDashboardTitle(value): { + options+: { + dashboardTitle: value, + }, + }, + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFolderId(value): { + options+: { + folderId: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { + options+: { + maxItems: value, + }, + }, + '#withShowOptions': { 'function': { args: [{ default: null, enums: ['current', 'changes'], name: 'value', type: ['string'] }], help: '' } }, + withShowOptions(value): { + options+: { + showOptions: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { + options+: { + stateFilter: value, + }, + }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { + options+: { + stateFilter+: value, + }, + }, + stateFilter+: + { + '#withAlerting': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAlerting(value=true): { + options+: { + stateFilter+: { + alerting: value, + }, + }, + }, + '#withExecutionError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withExecutionError(value=true): { + options+: { + stateFilter+: { + execution_error: value, + }, + }, + }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { + options+: { + stateFilter+: { + no_data: value, + }, + }, + }, + '#withOk': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOk(value=true): { + options+: { + stateFilter+: { + ok: value, + }, + }, + }, + '#withPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPaused(value=true): { + options+: { + stateFilter+: { + paused: value, + }, + }, + }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { + options+: { + stateFilter+: { + pending: value, + }, + }, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withUnifiedAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptions(value): { + options+: { + UnifiedAlertListOptions: value, + }, + }, + '#withUnifiedAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptionsMixin(value): { + options+: { + UnifiedAlertListOptions+: value, + }, + }, + UnifiedAlertListOptions+: + { + '#withAlertInstanceLabelFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertInstanceLabelFilter(value): { + options+: { + alertInstanceLabelFilter: value, + }, + }, + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { + options+: { + alertName: value, + }, + }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { + options+: { + dashboardAlerts: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatasource(value): { + options+: { + datasource: value, + }, + }, + '#withFolder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolder(value): { + options+: { + folder: value, + }, + }, + '#withFolderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolderMixin(value): { + options+: { + folder+: value, + }, + }, + folder+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withId(value): { + options+: { + folder+: { + id: value, + }, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + options+: { + folder+: { + title: value, + }, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + options+: { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + options+: { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupMode': { 'function': { args: [{ default: null, enums: ['default', 'custom'], name: 'value', type: ['string'] }], help: '' } }, + withGroupMode(value): { + options+: { + groupMode: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { + options+: { + maxItems: value, + }, + }, + '#withShowInstances': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowInstances(value=true): { + options+: { + showInstances: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { + options+: { + stateFilter: value, + }, + }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { + options+: { + stateFilter+: value, + }, + }, + stateFilter+: + { + '#withError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withError(value=true): { + options+: { + stateFilter+: { + 'error': value, + }, + }, + }, + '#withFiring': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFiring(value=true): { + options+: { + stateFilter+: { + firing: value, + }, + }, + }, + '#withInactive': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInactive(value=true): { + options+: { + stateFilter+: { + inactive: value, + }, + }, + }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { + options+: { + stateFilter+: { + noData: value, + }, + }, + }, + '#withNormal': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNormal(value=true): { + options+: { + stateFilter+: { + normal: value, + }, + }, + }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { + options+: { + stateFilter+: { + pending: value, + }, + }, + }, + }, + '#withViewMode': { 'function': { args: [{ default: null, enums: ['list', 'stat'], name: 'value', type: ['string'] }], help: '' } }, + withViewMode(value): { + options+: { + viewMode: value, + }, + }, + }, + }, } + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet b/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet index c44d746f..ccf1c124 100644 --- a/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet @@ -88,7 +88,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/barChart.libsonnet b/gen/grafonnet-v11.0.0/panel/barChart.libsonnet index af33b763..7fc1e1af 100644 --- a/gen/grafonnet-v11.0.0/panel/barChart.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/barChart.libsonnet @@ -343,7 +343,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -354,7 +354,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -547,7 +547,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet b/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet index 1560e5e7..5e20a610 100644 --- a/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet @@ -162,7 +162,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet index 50b4eb15..dc3026d2 100644 --- a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet @@ -707,7 +707,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -718,7 +718,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -844,7 +844,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/canvas.libsonnet b/gen/grafonnet-v11.0.0/panel/canvas.libsonnet index 2d7be5f0..79af6fd4 100644 --- a/gen/grafonnet-v11.0.0/panel/canvas.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/canvas.libsonnet @@ -538,7 +538,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet index a4997b8c..48d9cdd2 100644 --- a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet @@ -100,7 +100,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet b/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet index 6763f6d4..c93f7877 100644 --- a/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet @@ -22,7 +22,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/debug.libsonnet b/gen/grafonnet-v11.0.0/panel/debug.libsonnet index cc668311..3cc3f99c 100644 --- a/gen/grafonnet-v11.0.0/panel/debug.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/debug.libsonnet @@ -61,7 +61,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/gauge.libsonnet b/gen/grafonnet-v11.0.0/panel/gauge.libsonnet index 93b56530..02ebaff2 100644 --- a/gen/grafonnet-v11.0.0/panel/gauge.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/gauge.libsonnet @@ -144,7 +144,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/geomap.libsonnet b/gen/grafonnet-v11.0.0/panel/geomap.libsonnet index b0750681..b8e9cc6b 100644 --- a/gen/grafonnet-v11.0.0/panel/geomap.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/geomap.libsonnet @@ -480,7 +480,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet b/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet index bbd5fc04..2c974fc5 100644 --- a/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet @@ -833,7 +833,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/histogram.libsonnet b/gen/grafonnet-v11.0.0/panel/histogram.libsonnet index d875c920..cb8ce7af 100644 --- a/gen/grafonnet-v11.0.0/panel/histogram.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/histogram.libsonnet @@ -349,7 +349,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -360,7 +360,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -480,7 +480,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/logs.libsonnet b/gen/grafonnet-v11.0.0/panel/logs.libsonnet index 219e5146..a21ed84f 100644 --- a/gen/grafonnet-v11.0.0/panel/logs.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/logs.libsonnet @@ -70,7 +70,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/news.libsonnet b/gen/grafonnet-v11.0.0/panel/news.libsonnet index 734f07c2..eede4876 100644 --- a/gen/grafonnet-v11.0.0/panel/news.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/news.libsonnet @@ -28,7 +28,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet b/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet index 8ba36a4f..75e183af 100644 --- a/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet @@ -112,7 +112,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet b/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet index b5d13ddb..9ec5edc6 100644 --- a/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet @@ -374,7 +374,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/stat.libsonnet b/gen/grafonnet-v11.0.0/panel/stat.libsonnet index 9591569a..7b6b25b3 100644 --- a/gen/grafonnet-v11.0.0/panel/stat.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/stat.libsonnet @@ -150,7 +150,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet b/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet index 8978708c..bb9a3068 100644 --- a/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet @@ -125,7 +125,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -136,7 +136,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -303,7 +303,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet b/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet index bfe62828..b4a4987f 100644 --- a/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet @@ -125,7 +125,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -136,7 +136,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -297,7 +297,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/table.libsonnet b/gen/grafonnet-v11.0.0/panel/table.libsonnet index 66ffec83..a2535c48 100644 --- a/gen/grafonnet-v11.0.0/panel/table.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/table.libsonnet @@ -1292,7 +1292,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/text.libsonnet b/gen/grafonnet-v11.0.0/panel/text.libsonnet index 066fe626..2fd04fd0 100644 --- a/gen/grafonnet-v11.0.0/panel/text.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/text.libsonnet @@ -67,7 +67,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet index c583b6ce..ff275f6c 100644 --- a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet @@ -595,7 +595,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -606,7 +606,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -761,7 +761,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/trend.libsonnet b/gen/grafonnet-v11.0.0/panel/trend.libsonnet index e4cb8038..294cf2c1 100644 --- a/gen/grafonnet-v11.0.0/panel/trend.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/trend.libsonnet @@ -595,7 +595,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -606,7 +606,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -732,7 +732,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet b/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet index 868d0390..f8f3a2a2 100644 --- a/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet @@ -632,7 +632,7 @@ }, }, }, - '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcs(value): { options+: { legend+: { @@ -643,7 +643,7 @@ }, }, }, - '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, withCalcsMixin(value): { options+: { legend+: { @@ -1064,7 +1064,7 @@ + { panelOptions+: { '#withType':: { - + ignore: true, }, }, } diff --git a/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet b/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet index 7a4e3920..6f332726 100644 --- a/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet +++ b/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet @@ -1,18 +1,18 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.elasticsearch', name: 'elasticsearch' }, - '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alias pattern' } }, withAlias(value): { alias: value, }, - '#withBucketAggs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withBucketAggs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, withBucketAggs(value): { bucketAggs: (if std.isArray(value) then value else [value]), }, - '#withBucketAggsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withBucketAggsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, withBucketAggsMixin(value): { bucketAggs+: (if std.isArray(value) @@ -279,26 +279,26 @@ }, }, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasourceMixin(value): { datasource+: value, }, - '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, }, - '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, withMetrics(value): { metrics: (if std.isArray(value) then value else [value]), }, - '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, withMetricsMixin(value): { metrics+: (if std.isArray(value) @@ -1432,19 +1432,19 @@ }, }, }, - '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Lucene query' } }, withQuery(value): { query: value, }, - '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, withQueryType(value): { queryType: value, }, - '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, withRefId(value): { refId: value, }, - '#withTimeField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withTimeField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of time field' } }, withTimeField(value): { timeField: value, }, diff --git a/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet b/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet index c50a3aed..3723430a 100644 --- a/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet +++ b/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet @@ -270,18 +270,12 @@ }, timeSeriesQuery+: { - '#withGraphPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, - withGraphPeriod(value): { + '#withGraphPeriod': { 'function': { args: [{ default: 'disabled', enums: null, name: 'value', type: ['string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, + withGraphPeriod(value='disabled'): { timeSeriesQuery+: { graphPeriod: value, }, }, - '#withGraphPeriodMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, - withGraphPeriodMixin(value): { - timeSeriesQuery+: { - graphPeriod+: value, - }, - }, '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, withProjectName(value): { timeSeriesQuery+: { diff --git a/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet b/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet index 495e8b4e..b163b258 100644 --- a/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet +++ b/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet @@ -1,60 +1,60 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.grafanapyroscope', name: 'grafanapyroscope' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasourceMixin(value): { datasource+: value, }, - '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, withGroupBy(value): { groupBy: (if std.isArray(value) then value else [value]), }, - '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, withGroupByMixin(value): { groupBy+: (if std.isArray(value) then value else [value]), }, - '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, }, - '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, withLabelSelector(value='{}'): { labelSelector: value, }, - '#withMaxNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + '#withMaxNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the maximum number of nodes in the flamegraph.' } }, withMaxNodes(value): { maxNodes: value, }, - '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, withProfileTypeId(value): { profileTypeId: value, }, - '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, withQueryType(value): { queryType: value, }, - '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, withRefId(value): { refId: value, }, - '#withSpanSelector': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withSpanSelector': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Specifies the query span selectors.' } }, withSpanSelector(value): { spanSelector: (if std.isArray(value) then value else [value]), }, - '#withSpanSelectorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + '#withSpanSelectorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Specifies the query span selectors.' } }, withSpanSelectorMixin(value): { spanSelector+: (if std.isArray(value) diff --git a/gen/grafonnet-v11.0.0/query/loki.libsonnet b/gen/grafonnet-v11.0.0/query/loki.libsonnet index 97bb4511..2d77f4b5 100644 --- a/gen/grafonnet-v11.0.0/query/loki.libsonnet +++ b/gen/grafonnet-v11.0.0/query/loki.libsonnet @@ -1,11 +1,11 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.loki', name: 'loki' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasourceMixin(value): { datasource+: value, }, @@ -13,43 +13,43 @@ withEditorMode(value): { editorMode: value, }, - '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The LogQL query.' } }, withExpr(value): { expr: value, }, - '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, }, - '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, withInstant(value=true): { instant: value, }, - '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to override the name of the series.' } }, withLegendFormat(value): { legendFormat: value, }, - '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Used to limit the number of log rows returned.' } }, withMaxLines(value): { maxLines: value, }, - '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, withQueryType(value): { queryType: value, }, - '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, withRange(value=true): { range: value, }, - '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, withRefId(value): { refId: value, }, - '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '@deprecated, now use step.' } }, withResolution(value): { resolution: value, }, - '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to set step value for range queries.' } }, withStep(value): { step: value, }, diff --git a/gen/grafonnet-v11.0.0/query/parca.libsonnet b/gen/grafonnet-v11.0.0/query/parca.libsonnet index a591db67..8fc0e6a1 100644 --- a/gen/grafonnet-v11.0.0/query/parca.libsonnet +++ b/gen/grafonnet-v11.0.0/query/parca.libsonnet @@ -1,31 +1,31 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.parca', name: 'parca' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasourceMixin(value): { datasource+: value, }, - '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, }, - '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, withLabelSelector(value='{}'): { labelSelector: value, }, - '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, withProfileTypeId(value): { profileTypeId: value, }, - '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, withQueryType(value): { queryType: value, }, - '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, withRefId(value): { refId: value, }, diff --git a/gen/grafonnet-v11.0.0/query/prometheus.libsonnet b/gen/grafonnet-v11.0.0/query/prometheus.libsonnet index 694b7242..1d42ef3b 100644 --- a/gen/grafonnet-v11.0.0/query/prometheus.libsonnet +++ b/gen/grafonnet-v11.0.0/query/prometheus.libsonnet @@ -1,11 +1,11 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasourceMixin(value): { datasource+: value, }, @@ -13,11 +13,11 @@ withEditorMode(value): { editorMode: value, }, - '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Execute an additional query to identify interesting raw samples relevant for the given expr' } }, withExemplar(value=true): { exemplar: value, }, - '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The actual expression/query that will be evaluated by Prometheus' } }, withExpr(value): { expr: value, }, @@ -25,11 +25,11 @@ withFormat(value): { format: value, }, - '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, }, - '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns only the latest value that Prometheus has scraped for the requested time series' } }, withInstant(value=true): { instant: value, }, @@ -37,23 +37,23 @@ withInterval(value): { interval: value, }, - '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081' } }, withIntervalFactor(value): { intervalFactor: value, }, - '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname' } }, withLegendFormat(value): { legendFormat: value, }, - '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, withQueryType(value): { queryType: value, }, - '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series' } }, withRange(value=true): { range: value, }, - '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, withRefId(value): { refId: value, }, diff --git a/gen/grafonnet-v11.0.0/role.libsonnet b/gen/grafonnet-v11.0.0/role.libsonnet index 54d03bff..552f5a31 100644 --- a/gen/grafonnet-v11.0.0/role.libsonnet +++ b/gen/grafonnet-v11.0.0/role.libsonnet @@ -13,14 +13,10 @@ withGroupName(value): { groupName: value, }, - '#withHidden': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'boolean'] }], help: 'Do not show this role' } }, - withHidden(value): { + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Do not show this role' } }, + withHidden(value=true): { hidden: value, }, - '#withHiddenMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'boolean'] }], help: 'Do not show this role' } }, - withHiddenMixin(value): { - hidden+: value, - }, '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The role identifier `managed:builtins:editor:permissions`' } }, withName(value): { name: value, diff --git a/generator/panel.libsonnet b/generator/panel.libsonnet index 006c0330..8dce5898 100644 --- a/generator/panel.libsonnet +++ b/generator/panel.libsonnet @@ -53,7 +53,7 @@ local utils = import './utils.libsonnet'; }; local customSubSchema = subSchema - + self.setPanelTypeConstant(title) + + self.setPanelTypeConstant(schema) + self.hidePanelOptionsAndFieldConfig() + self.moveOptions(subSchema) + self.moveFieldConfig(subSchema); @@ -105,7 +105,12 @@ local utils = import './utils.libsonnet'; a.field.new( // Hide #withType from docs a.string.new('#withType'), - a.object.new([]) + a.object.new([ + a.field.new( + a.literal.new('ignore'), + a.literal.new('true') + ), + ]) ) + a.field.withHidden(), ]), @@ -113,16 +118,11 @@ local utils = import './utils.libsonnet'; + a.field.withAdditive(), ]).toString(), - setPanelTypeConstant(title): { + setPanelTypeConstant(schema): { type: 'object', properties+: { type: { - const: - std.get( - utils.irregularPluginNames, - std.asciiLower(title), - std.asciiLower(title), - ), + const: schema.info['x-schema-identifier'], }, }, }, diff --git a/generator/patches/schemas.libsonnet b/generator/patches/schemas.libsonnet index e5bc331d..2e8f1a28 100644 --- a/generator/patches/schemas.libsonnet +++ b/generator/patches/schemas.libsonnet @@ -112,16 +112,11 @@ local utils = import '../utils.libsonnet'; definitions: (import './custom_schemas/alertList.json').definitions, components: { schemas: { - AlertList: { - type: 'object', - properties: { - Options: { - oneOf: [ - { '$ref': '#/definitions/AlertListOptions' }, - { '$ref': '#/definitions/UnifiedAlertListOptions' }, - ], - }, - }, + Options: { + oneOf: [ + { '$ref': '#/definitions/AlertListOptions' }, + { '$ref': '#/definitions/UnifiedAlertListOptions' }, + ], }, }, }, diff --git a/generator/utils.libsonnet b/generator/utils.libsonnet index e135e4e3..07aba89d 100644 --- a/generator/utils.libsonnet +++ b/generator/utils.libsonnet @@ -34,24 +34,6 @@ local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; default=error 'field %s not found in ast' % title ).expr, - // Some plugins are named differently, this has been resolved in the Grafana code base but not reflected in the JSON schema. - // source: https://github.com/grafana/grafana/blob/0ee9d11a9148f517fed57bd4c9b840480993cf42/pkg/kindsys/report.go#L285 - irregularPluginNames: { - // Panel - alertgroups: 'alertGroups', - annotationslist: 'annolist', - dashboardlist: 'dashlist', - nodegraph: 'nodeGraph', - statetimeline: 'state-timeline', - statushistory: 'status-history', - tableold: 'table-old', - // Datasource - googlecloudmonitoring: 'cloud-monitoring', - azuremonitor: 'grafana-azure-monitor-datasource', - microsoftsqlserver: 'mssql', - postgresql: 'postgres', - }, - formatSchemaName(name): local split = xtd.camelcase.split(name); std.join( From 714cbffc4967cd13400c6705113b924a48ff70a8 Mon Sep 17 00:00:00 2001 From: Duologic Date: Wed, 22 May 2024 22:17:49 +0200 Subject: [PATCH 09/17] fix(query): generate with title mapping --- .../azureMonitor/dimensionFilters.md | 0 .../azureMonitor/resources.md | 0 .../azureTraces/filters.md | 0 .../{azuremonitor => azureMonitor}/index.md | 4 ++-- .../CloudWatchLogsQuery/logGroups.md | 0 .../QueryEditorFunctionExpression/parameters.md | 0 .../sql/orderBy/parameters.md | 0 .../sql/select/parameters.md | 0 .../query/{cloudwatch => cloudWatch}/index.md | 4 ++-- .../API/query/googleCloudMonitoring.md | 4 ++-- .../API/query/grafanaPyroscope.md | 4 ++-- docs/API/query/index.md | 8 ++++---- .../azureMonitor/dimensionFilters.md | 0 .../azureMonitor/resources.md | 0 .../azureTraces/filters.md | 0 .../{azuremonitor => azureMonitor}/index.md | 4 ++-- .../CloudWatchLogsQuery/logGroups.md | 0 .../QueryEditorFunctionExpression/parameters.md | 0 .../sql/orderBy/parameters.md | 0 .../sql/select/parameters.md | 0 .../query/{cloudwatch => cloudWatch}/index.md | 4 ++-- .../docs/query/googleCloudMonitoring.md | 4 ++-- .../docs/query/grafanaPyroscope.md | 4 ++-- gen/grafonnet-v11.0.0/docs/query/index.md | 8 ++++---- gen/grafonnet-v11.0.0/query.libsonnet | 8 ++++---- ...monitor.libsonnet => azureMonitor.libsonnet} | 2 +- ...loudwatch.libsonnet => cloudWatch.libsonnet} | 2 +- ...ibsonnet => googleCloudMonitoring.libsonnet} | 2 +- ...ope.libsonnet => grafanaPyroscope.libsonnet} | 2 +- generator/panel.libsonnet | 6 +++++- generator/query.libsonnet | 17 ++++++++++++++--- 31 files changed, 51 insertions(+), 36 deletions(-) rename docs/API/query/{azuremonitor => azureMonitor}/azureMonitor/dimensionFilters.md (100%) rename docs/API/query/{azuremonitor => azureMonitor}/azureMonitor/resources.md (100%) rename docs/API/query/{azuremonitor => azureMonitor}/azureTraces/filters.md (100%) rename docs/API/query/{azuremonitor => azureMonitor}/index.md (99%) rename docs/API/query/{cloudwatch => cloudWatch}/CloudWatchLogsQuery/logGroups.md (100%) rename docs/API/query/{cloudwatch => cloudWatch}/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md (100%) rename docs/API/query/{cloudwatch => cloudWatch}/CloudWatchMetricsQuery/sql/orderBy/parameters.md (100%) rename docs/API/query/{cloudwatch => cloudWatch}/CloudWatchMetricsQuery/sql/select/parameters.md (100%) rename docs/API/query/{cloudwatch => cloudWatch}/index.md (99%) rename gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md => docs/API/query/googleCloudMonitoring.md (99%) rename gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md => docs/API/query/grafanaPyroscope.md (98%) rename gen/grafonnet-v11.0.0/docs/query/{azuremonitor => azureMonitor}/azureMonitor/dimensionFilters.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{azuremonitor => azureMonitor}/azureMonitor/resources.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{azuremonitor => azureMonitor}/azureTraces/filters.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{azuremonitor => azureMonitor}/index.md (99%) rename gen/grafonnet-v11.0.0/docs/query/{cloudwatch => cloudWatch}/CloudWatchLogsQuery/logGroups.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{cloudwatch => cloudWatch}/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{cloudwatch => cloudWatch}/CloudWatchMetricsQuery/sql/orderBy/parameters.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{cloudwatch => cloudWatch}/CloudWatchMetricsQuery/sql/select/parameters.md (100%) rename gen/grafonnet-v11.0.0/docs/query/{cloudwatch => cloudWatch}/index.md (99%) rename docs/API/query/googlecloudmonitoring.md => gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md (99%) rename docs/API/query/grafanapyroscope.md => gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md (98%) rename gen/grafonnet-v11.0.0/query/{azuremonitor.libsonnet => azureMonitor.libsonnet} (99%) rename gen/grafonnet-v11.0.0/query/{cloudwatch.libsonnet => cloudWatch.libsonnet} (99%) rename gen/grafonnet-v11.0.0/query/{googlecloudmonitoring.libsonnet => googleCloudMonitoring.libsonnet} (99%) rename gen/grafonnet-v11.0.0/query/{grafanapyroscope.libsonnet => grafanaPyroscope.libsonnet} (97%) diff --git a/docs/API/query/azuremonitor/azureMonitor/dimensionFilters.md b/docs/API/query/azureMonitor/azureMonitor/dimensionFilters.md similarity index 100% rename from docs/API/query/azuremonitor/azureMonitor/dimensionFilters.md rename to docs/API/query/azureMonitor/azureMonitor/dimensionFilters.md diff --git a/docs/API/query/azuremonitor/azureMonitor/resources.md b/docs/API/query/azureMonitor/azureMonitor/resources.md similarity index 100% rename from docs/API/query/azuremonitor/azureMonitor/resources.md rename to docs/API/query/azureMonitor/azureMonitor/resources.md diff --git a/docs/API/query/azuremonitor/azureTraces/filters.md b/docs/API/query/azureMonitor/azureTraces/filters.md similarity index 100% rename from docs/API/query/azuremonitor/azureTraces/filters.md rename to docs/API/query/azureMonitor/azureTraces/filters.md diff --git a/docs/API/query/azuremonitor/index.md b/docs/API/query/azureMonitor/index.md similarity index 99% rename from docs/API/query/azuremonitor/index.md rename to docs/API/query/azureMonitor/index.md index 1355e0ef..382a9afd 100644 --- a/docs/API/query/azuremonitor/index.md +++ b/docs/API/query/azureMonitor/index.md @@ -1,6 +1,6 @@ -# azuremonitor +# azureMonitor -grafonnet.query.azuremonitor +grafonnet.query.azureMonitor ## Subpackages diff --git a/docs/API/query/cloudwatch/CloudWatchLogsQuery/logGroups.md b/docs/API/query/cloudWatch/CloudWatchLogsQuery/logGroups.md similarity index 100% rename from docs/API/query/cloudwatch/CloudWatchLogsQuery/logGroups.md rename to docs/API/query/cloudWatch/CloudWatchLogsQuery/logGroups.md diff --git a/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md similarity index 100% rename from docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md rename to docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md diff --git a/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md similarity index 100% rename from docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md rename to docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md diff --git a/docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md b/docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md similarity index 100% rename from docs/API/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md rename to docs/API/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md diff --git a/docs/API/query/cloudwatch/index.md b/docs/API/query/cloudWatch/index.md similarity index 99% rename from docs/API/query/cloudwatch/index.md rename to docs/API/query/cloudWatch/index.md index d6b1381c..eff3563f 100644 --- a/docs/API/query/cloudwatch/index.md +++ b/docs/API/query/cloudWatch/index.md @@ -1,6 +1,6 @@ -# cloudwatch +# cloudWatch -grafonnet.query.cloudwatch +grafonnet.query.cloudWatch ## Subpackages diff --git a/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md b/docs/API/query/googleCloudMonitoring.md similarity index 99% rename from gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md rename to docs/API/query/googleCloudMonitoring.md index 842503fc..c711f29a 100644 --- a/gen/grafonnet-v11.0.0/docs/query/googlecloudmonitoring.md +++ b/docs/API/query/googleCloudMonitoring.md @@ -1,6 +1,6 @@ -# googlecloudmonitoring +# googleCloudMonitoring -grafonnet.query.googlecloudmonitoring +grafonnet.query.googleCloudMonitoring ## Index diff --git a/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md b/docs/API/query/grafanaPyroscope.md similarity index 98% rename from gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md rename to docs/API/query/grafanaPyroscope.md index 3f982fdc..87b31d94 100644 --- a/gen/grafonnet-v11.0.0/docs/query/grafanapyroscope.md +++ b/docs/API/query/grafanaPyroscope.md @@ -1,6 +1,6 @@ -# grafanapyroscope +# grafanaPyroscope -grafonnet.query.grafanapyroscope +grafonnet.query.grafanaPyroscope ## Index diff --git a/docs/API/query/index.md b/docs/API/query/index.md index 270e0a83..cc978b69 100644 --- a/docs/API/query/index.md +++ b/docs/API/query/index.md @@ -4,11 +4,11 @@ grafonnet.query ## Subpackages -* [azuremonitor](azuremonitor/index.md) -* [cloudwatch](cloudwatch/index.md) +* [azureMonitor](azureMonitor/index.md) +* [cloudWatch](cloudWatch/index.md) * [elasticsearch](elasticsearch/index.md) -* [googlecloudmonitoring](googlecloudmonitoring.md) -* [grafanapyroscope](grafanapyroscope.md) +* [googleCloudMonitoring](googleCloudMonitoring.md) +* [grafanaPyroscope](grafanaPyroscope.md) * [loki](loki.md) * [parca](parca.md) * [prometheus](prometheus.md) diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/dimensionFilters.md b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/dimensionFilters.md rename to gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/resources.md b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/resources.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureMonitor/resources.md rename to gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/resources.md diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureTraces/filters.md b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureTraces/filters.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/azuremonitor/azureTraces/filters.md rename to gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureTraces/filters.md diff --git a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md similarity index 99% rename from gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md rename to gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md index 1355e0ef..382a9afd 100644 --- a/gen/grafonnet-v11.0.0/docs/query/azuremonitor/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md @@ -1,6 +1,6 @@ -# azuremonitor +# azureMonitor -grafonnet.query.azuremonitor +grafonnet.query.azureMonitor ## Subpackages diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchLogsQuery/logGroups.md b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchLogsQuery/logGroups.md rename to gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md rename to gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md rename to gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md similarity index 100% rename from gen/grafonnet-v11.0.0/docs/query/cloudwatch/CloudWatchMetricsQuery/sql/select/parameters.md rename to gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md similarity index 99% rename from gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md rename to gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md index d6b1381c..eff3563f 100644 --- a/gen/grafonnet-v11.0.0/docs/query/cloudwatch/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md @@ -1,6 +1,6 @@ -# cloudwatch +# cloudWatch -grafonnet.query.cloudwatch +grafonnet.query.cloudWatch ## Subpackages diff --git a/docs/API/query/googlecloudmonitoring.md b/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md similarity index 99% rename from docs/API/query/googlecloudmonitoring.md rename to gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md index 842503fc..c711f29a 100644 --- a/docs/API/query/googlecloudmonitoring.md +++ b/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md @@ -1,6 +1,6 @@ -# googlecloudmonitoring +# googleCloudMonitoring -grafonnet.query.googlecloudmonitoring +grafonnet.query.googleCloudMonitoring ## Index diff --git a/docs/API/query/grafanapyroscope.md b/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md similarity index 98% rename from docs/API/query/grafanapyroscope.md rename to gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md index 3f982fdc..87b31d94 100644 --- a/docs/API/query/grafanapyroscope.md +++ b/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md @@ -1,6 +1,6 @@ -# grafanapyroscope +# grafanaPyroscope -grafonnet.query.grafanapyroscope +grafonnet.query.grafanaPyroscope ## Index diff --git a/gen/grafonnet-v11.0.0/docs/query/index.md b/gen/grafonnet-v11.0.0/docs/query/index.md index 270e0a83..cc978b69 100644 --- a/gen/grafonnet-v11.0.0/docs/query/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/index.md @@ -4,11 +4,11 @@ grafonnet.query ## Subpackages -* [azuremonitor](azuremonitor/index.md) -* [cloudwatch](cloudwatch/index.md) +* [azureMonitor](azureMonitor/index.md) +* [cloudWatch](cloudWatch/index.md) * [elasticsearch](elasticsearch/index.md) -* [googlecloudmonitoring](googlecloudmonitoring.md) -* [grafanapyroscope](grafanapyroscope.md) +* [googleCloudMonitoring](googleCloudMonitoring.md) +* [grafanaPyroscope](grafanaPyroscope.md) * [loki](loki.md) * [parca](parca.md) * [prometheus](prometheus.md) diff --git a/gen/grafonnet-v11.0.0/query.libsonnet b/gen/grafonnet-v11.0.0/query.libsonnet index 27a01fa9..69d4e766 100644 --- a/gen/grafonnet-v11.0.0/query.libsonnet +++ b/gen/grafonnet-v11.0.0/query.libsonnet @@ -1,11 +1,11 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query', name: 'query' }, - azuremonitor: import 'query/azuremonitor.libsonnet', - cloudwatch: import 'query/cloudwatch.libsonnet', + azureMonitor: import 'query/azureMonitor.libsonnet', + cloudWatch: import 'query/cloudWatch.libsonnet', elasticsearch: import 'query/elasticsearch.libsonnet', - googlecloudmonitoring: import 'query/googlecloudmonitoring.libsonnet', - grafanapyroscope: import 'query/grafanapyroscope.libsonnet', + googleCloudMonitoring: import 'query/googleCloudMonitoring.libsonnet', + grafanaPyroscope: import 'query/grafanaPyroscope.libsonnet', loki: import 'query/loki.libsonnet', parca: import 'query/parca.libsonnet', prometheus: import 'query/prometheus.libsonnet', diff --git a/gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet b/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet similarity index 99% rename from gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet rename to gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet index 03370ff8..13b4d100 100644 --- a/gen/grafonnet-v11.0.0/query/azuremonitor.libsonnet +++ b/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet @@ -1,6 +1,6 @@ // This file is generated, do not manually edit. { - '#': { help: 'grafonnet.query.azuremonitor', name: 'azuremonitor' }, + '#': { help: 'grafonnet.query.azureMonitor', name: 'azureMonitor' }, '#withAzureLogAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, withAzureLogAnalytics(value): { azureLogAnalytics: value, diff --git a/gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet b/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet similarity index 99% rename from gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet rename to gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet index 5675f743..21a8604e 100644 --- a/gen/grafonnet-v11.0.0/query/cloudwatch.libsonnet +++ b/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet @@ -1,6 +1,6 @@ // This file is generated, do not manually edit. { - '#': { help: 'grafonnet.query.cloudwatch', name: 'cloudwatch' }, + '#': { help: 'grafonnet.query.cloudWatch', name: 'cloudWatch' }, CloudWatchAnnotationQuery+: { '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, diff --git a/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet b/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet similarity index 99% rename from gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet rename to gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet index 3723430a..adc0e162 100644 --- a/gen/grafonnet-v11.0.0/query/googlecloudmonitoring.libsonnet +++ b/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet @@ -1,6 +1,6 @@ // This file is generated, do not manually edit. { - '#': { help: 'grafonnet.query.googlecloudmonitoring', name: 'googlecloudmonitoring' }, + '#': { help: 'grafonnet.query.googleCloudMonitoring', name: 'googleCloudMonitoring' }, '#withAliasBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.' } }, withAliasBy(value): { aliasBy: value, diff --git a/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet b/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet similarity index 97% rename from gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet rename to gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet index b163b258..8c66a691 100644 --- a/gen/grafonnet-v11.0.0/query/grafanapyroscope.libsonnet +++ b/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet @@ -1,6 +1,6 @@ // This file is generated, do not manually edit. { - '#': { help: 'grafonnet.query.grafanapyroscope', name: 'grafanapyroscope' }, + '#': { help: 'grafonnet.query.grafanaPyroscope', name: 'grafanaPyroscope' }, '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, withDatasource(value): { datasource: value, diff --git a/generator/panel.libsonnet b/generator/panel.libsonnet index 8dce5898..01cfe3bb 100644 --- a/generator/panel.libsonnet +++ b/generator/panel.libsonnet @@ -96,7 +96,11 @@ local utils = import './utils.libsonnet'; a.import_statement.new('../panel.libsonnet'), ).toString() + '\n +' - + utils.addDoc(refactored, std.get(root.titleMapping, std.asciiLower(title), title), 'panel.').toString() + + utils.addDoc( + refactored, + std.get(root.titleMapping, std.asciiLower(title), title), + 'panel.' + ).toString() + '\n +' + a.object.new([ a.field.new( diff --git a/generator/query.libsonnet b/generator/query.libsonnet index 3f2cbe61..54de3c92 100644 --- a/generator/query.libsonnet +++ b/generator/query.libsonnet @@ -8,6 +8,13 @@ local utils = import './utils.libsonnet'; { local root = self, + titleMapping: { + azuremonitor: 'azureMonitor', + cloudwatch: 'cloudWatch', + googlecloudmonitoring: 'googleCloudMonitoring', + grafanapyroscope: 'grafanaPyroscope', + }, + render(schemas): local files = self.getFilesForSchemas(schemas); { 'query.libsonnet': root.queryIndex(files) } @@ -19,7 +26,7 @@ local utils = import './utils.libsonnet'; getFilesForSchemas(schemas): std.foldl( function(acc, schema) - local title = schema.info.title; + local title = std.get(root.titleMapping, std.asciiLower(schema.info.title), schema.info.title); acc + [{ title: title, path: 'query/' + title + '.libsonnet', @@ -32,7 +39,7 @@ local utils = import './utils.libsonnet'; generateLib(schema): local title = schema.info.title; local customSchema = - schema + { + schema { components+: { schemas+: std.get(fixes, title, {}), }, @@ -51,7 +58,11 @@ local utils = import './utils.libsonnet'; title, ); - utils.addDoc(ast, title, 'query.').toString() + utils.addDoc( + ast, + std.get(root.titleMapping, std.asciiLower(title), title), + 'query.' + ).toString() + (if std.member(self.hasCustom, title) then '\n +' From dab5be103cdd8fe98d8b6e8649d3352ce83144e2 Mon Sep 17 00:00:00 2001 From: Duologic Date: Thu, 23 May 2024 14:13:59 +0200 Subject: [PATCH 10/17] fix(query): bring back testData --- docs/API/query/index.md | 1 + docs/API/query/testData/csvWave.md | 56 + docs/API/query/testData/index.md | 1119 +++++++++++++++++ gen/grafonnet-v11.0.0/docs/query/index.md | 1 + .../docs/query/testData/csvWave.md | 56 + .../docs/query/testData/index.md | 1119 +++++++++++++++++ gen/grafonnet-v11.0.0/query.libsonnet | 1 + .../query/testData.libsonnet | 493 ++++++++ generator/query.libsonnet | 1 + 9 files changed, 2847 insertions(+) create mode 100644 docs/API/query/testData/csvWave.md create mode 100644 docs/API/query/testData/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/testData/index.md create mode 100644 gen/grafonnet-v11.0.0/query/testData.libsonnet diff --git a/docs/API/query/index.md b/docs/API/query/index.md index cc978b69..c36150f0 100644 --- a/docs/API/query/index.md +++ b/docs/API/query/index.md @@ -13,3 +13,4 @@ grafonnet.query * [parca](parca.md) * [prometheus](prometheus.md) * [tempo](tempo/index.md) +* [testData](testData/index.md) diff --git a/docs/API/query/testData/csvWave.md b/docs/API/query/testData/csvWave.md new file mode 100644 index 00000000..8927e1cc --- /dev/null +++ b/docs/API/query/testData/csvWave.md @@ -0,0 +1,56 @@ +# csvWave + + + +## Index + +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeStep(value)`](#fn-withtimestep) +* [`fn withValuesCSV(value)`](#fn-withvaluescsv) + +## Fields + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeStep + +```jsonnet +withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withValuesCSV + +```jsonnet +withValuesCSV(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/API/query/testData/index.md b/docs/API/query/testData/index.md new file mode 100644 index 00000000..d63b5ea9 --- /dev/null +++ b/docs/API/query/testData/index.md @@ -0,0 +1,1119 @@ +# testData + +grafonnet.query.testData + +## Subpackages + +* [csvWave](csvWave.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withChannel(value)`](#fn-withchannel) +* [`fn withCsvContent(value)`](#fn-withcsvcontent) +* [`fn withCsvFileName(value)`](#fn-withcsvfilename) +* [`fn withCsvWave(value)`](#fn-withcsvwave) +* [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withDropPercent(value)`](#fn-withdroppercent) +* [`fn withErrorType(value)`](#fn-witherrortype) +* [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLevelColumn(value=true)`](#fn-withlevelcolumn) +* [`fn withLines(value)`](#fn-withlines) +* [`fn withMax(value)`](#fn-withmax) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withMin(value)`](#fn-withmin) +* [`fn withNodes(value)`](#fn-withnodes) +* [`fn withNodesMixin(value)`](#fn-withnodesmixin) +* [`fn withNoise(value)`](#fn-withnoise) +* [`fn withPoints(value)`](#fn-withpoints) +* [`fn withPointsMixin(value)`](#fn-withpointsmixin) +* [`fn withPulseWave(value)`](#fn-withpulsewave) +* [`fn withPulseWaveMixin(value)`](#fn-withpulsewavemixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawFrameContent(value)`](#fn-withrawframecontent) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withScenarioId(value)`](#fn-withscenarioid) +* [`fn withSeriesCount(value)`](#fn-withseriescount) +* [`fn withSim(value)`](#fn-withsim) +* [`fn withSimMixin(value)`](#fn-withsimmixin) +* [`fn withSpanCount(value)`](#fn-withspancount) +* [`fn withSpread(value)`](#fn-withspread) +* [`fn withStartValue(value)`](#fn-withstartvalue) +* [`fn withStream(value)`](#fn-withstream) +* [`fn withStreamMixin(value)`](#fn-withstreammixin) +* [`fn withStringInput(value)`](#fn-withstringinput) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withUsa(value)`](#fn-withusa) +* [`fn withUsaMixin(value)`](#fn-withusamixin) +* [`fn withWithNil(value=true)`](#fn-withwithnil) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj nodes`](#obj-nodes) + * [`fn withCount(value)`](#fn-nodeswithcount) + * [`fn withSeed(value)`](#fn-nodeswithseed) + * [`fn withType(value)`](#fn-nodeswithtype) +* [`obj pulseWave`](#obj-pulsewave) + * [`fn withOffCount(value)`](#fn-pulsewavewithoffcount) + * [`fn withOffValue(value)`](#fn-pulsewavewithoffvalue) + * [`fn withOnCount(value)`](#fn-pulsewavewithoncount) + * [`fn withOnValue(value)`](#fn-pulsewavewithonvalue) + * [`fn withTimeStep(value)`](#fn-pulsewavewithtimestep) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj sim`](#obj-sim) + * [`fn withConfig(value)`](#fn-simwithconfig) + * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) + * [`fn withKey(value)`](#fn-simwithkey) + * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) + * [`fn withLast(value=true)`](#fn-simwithlast) + * [`fn withStream(value=true)`](#fn-simwithstream) + * [`obj key`](#obj-simkey) + * [`fn withTick(value)`](#fn-simkeywithtick) + * [`fn withType(value)`](#fn-simkeywithtype) + * [`fn withUid(value)`](#fn-simkeywithuid) +* [`obj stream`](#obj-stream) + * [`fn withBands(value)`](#fn-streamwithbands) + * [`fn withNoise(value)`](#fn-streamwithnoise) + * [`fn withSpeed(value)`](#fn-streamwithspeed) + * [`fn withSpread(value)`](#fn-streamwithspread) + * [`fn withType(value)`](#fn-streamwithtype) + * [`fn withUrl(value)`](#fn-streamwithurl) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) +* [`obj usa`](#obj-usa) + * [`fn withFields(value)`](#fn-usawithfields) + * [`fn withFieldsMixin(value)`](#fn-usawithfieldsmixin) + * [`fn withMode(value)`](#fn-usawithmode) + * [`fn withPeriod(value)`](#fn-usawithperiod) + * [`fn withStates(value)`](#fn-usawithstates) + * [`fn withStatesMixin(value)`](#fn-usawithstatesmixin) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withChannel + +```jsonnet +withChannel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used for live query +### fn withCsvContent + +```jsonnet +withCsvContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvFileName + +```jsonnet +withCsvFileName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvWave + +```jsonnet +withCsvWave(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withCsvWaveMixin + +```jsonnet +withCsvWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDropPercent + +```jsonnet +withDropPercent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Drop percentage (the chance we will lose a point 0-100) +### fn withErrorType + +```jsonnet +withErrorType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"frontend_exception"`, `"frontend_observable"`, `"server_panic"` + +Possible enum values: + - `"frontend_exception"` + - `"frontend_observable"` + - `"server_panic"` +### fn withFlamegraphDiff + +```jsonnet +withFlamegraphDiff(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withLevelColumn + +```jsonnet +withLevelColumn(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLines + +```jsonnet +withLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withMax + +```jsonnet +withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withMin + +```jsonnet +withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withNodes + +```jsonnet +withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNodesMixin + +```jsonnet +withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNoise + +```jsonnet +withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withPoints + +```jsonnet +withPoints(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPointsMixin + +```jsonnet +withPointsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPulseWave + +```jsonnet +withPulseWave(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPulseWaveMixin + +```jsonnet +withPulseWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRawFrameContent + +```jsonnet +withRawFrameContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScenarioId + +```jsonnet +withScenarioId(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"annotations"`, `"arrow"`, `"csv_content"`, `"csv_file"`, `"csv_metric_values"`, `"datapoints_outside_range"`, `"exponential_heatmap_bucket_data"`, `"flame_graph"`, `"grafana_api"`, `"linear_heatmap_bucket_data"`, `"live"`, `"logs"`, `"manual_entry"`, `"no_data_points"`, `"node_graph"`, `"predictable_csv_wave"`, `"predictable_pulse"`, `"random_walk"`, `"random_walk_table"`, `"random_walk_with_error"`, `"raw_frame"`, `"server_error_500"`, `"simulation"`, `"slow_query"`, `"streaming_client"`, `"table_static"`, `"trace"`, `"usa"`, `"variables-query"` + +Possible enum values: + - `"annotations"` + - `"arrow"` + - `"csv_content"` + - `"csv_file"` + - `"csv_metric_values"` + - `"datapoints_outside_range"` + - `"exponential_heatmap_bucket_data"` + - `"flame_graph"` + - `"grafana_api"` + - `"linear_heatmap_bucket_data"` + - `"live"` + - `"logs"` + - `"manual_entry"` + - `"no_data_points"` + - `"node_graph"` + - `"predictable_csv_wave"` + - `"predictable_pulse"` + - `"random_walk"` + - `"random_walk_table"` + - `"random_walk_with_error"` + - `"raw_frame"` + - `"server_error_500"` + - `"simulation"` + - `"slow_query"` + - `"streaming_client"` + - `"table_static"` + - `"trace"` + - `"usa"` + - `"variables-query"` +### fn withSeriesCount + +```jsonnet +withSeriesCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSim + +```jsonnet +withSim(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSimMixin + +```jsonnet +withSimMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSpanCount + +```jsonnet +withSpanCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSpread + +```jsonnet +withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStartValue + +```jsonnet +withStartValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStream + +```jsonnet +withStream(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStreamMixin + +```jsonnet +withStreamMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStringInput + +```jsonnet +withStringInput(value) +``` + +PARAMETERS: + +* **value** (`string`) + +common parameter used by many query types +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsa + +```jsonnet +withUsa(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsaMixin + +```jsonnet +withUsaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withWithNil + +```jsonnet +withWithNil(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj nodes + + +#### fn nodes.withCount + +```jsonnet +nodes.withCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withSeed + +```jsonnet +nodes.withSeed(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withType + +```jsonnet +nodes.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"random"`, `"random edges"`, `"response_medium"`, `"response_small"`, `"feature_showcase"` + +Possible enum values: + - `"random"` + - `"random edges"` + - `"response_medium"` + - `"response_small"` + - `"feature_showcase"` +### obj pulseWave + + +#### fn pulseWave.withOffCount + +```jsonnet +pulseWave.withOffCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOffValue + +```jsonnet +pulseWave.withOffValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withOnCount + +```jsonnet +pulseWave.withOnCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOnValue + +```jsonnet +pulseWave.withOnValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withTimeStep + +```jsonnet +pulseWave.withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj sim + + +#### fn sim.withConfig + +```jsonnet +sim.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withConfigMixin + +```jsonnet +sim.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKey + +```jsonnet +sim.withKey(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKeyMixin + +```jsonnet +sim.withKeyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withLast + +```jsonnet +sim.withLast(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn sim.withStream + +```jsonnet +sim.withStream(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj sim.key + + +##### fn sim.key.withTick + +```jsonnet +sim.key.withTick(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn sim.key.withType + +```jsonnet +sim.key.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn sim.key.withUid + +```jsonnet +sim.key.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj stream + + +#### fn stream.withBands + +```jsonnet +stream.withBands(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn stream.withNoise + +```jsonnet +stream.withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpeed + +```jsonnet +stream.withSpeed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpread + +```jsonnet +stream.withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withType + +```jsonnet +stream.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fetch"`, `"logs"`, `"signal"`, `"traces"` + +Possible enum values: + - `"fetch"` + - `"logs"` + - `"signal"` + - `"traces"` +#### fn stream.withUrl + +```jsonnet +stream.withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. +### obj usa + + +#### fn usa.withFields + +```jsonnet +usa.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withFieldsMixin + +```jsonnet +usa.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withMode + +```jsonnet +usa.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withPeriod + +```jsonnet +usa.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withStates + +```jsonnet +usa.withStates(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withStatesMixin + +```jsonnet +usa.withStatesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/index.md b/gen/grafonnet-v11.0.0/docs/query/index.md index cc978b69..c36150f0 100644 --- a/gen/grafonnet-v11.0.0/docs/query/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/index.md @@ -13,3 +13,4 @@ grafonnet.query * [parca](parca.md) * [prometheus](prometheus.md) * [tempo](tempo/index.md) +* [testData](testData/index.md) diff --git a/gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md b/gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md new file mode 100644 index 00000000..8927e1cc --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md @@ -0,0 +1,56 @@ +# csvWave + + + +## Index + +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeStep(value)`](#fn-withtimestep) +* [`fn withValuesCSV(value)`](#fn-withvaluescsv) + +## Fields + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeStep + +```jsonnet +withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withValuesCSV + +```jsonnet +withValuesCSV(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/testData/index.md b/gen/grafonnet-v11.0.0/docs/query/testData/index.md new file mode 100644 index 00000000..d63b5ea9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/testData/index.md @@ -0,0 +1,1119 @@ +# testData + +grafonnet.query.testData + +## Subpackages + +* [csvWave](csvWave.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withChannel(value)`](#fn-withchannel) +* [`fn withCsvContent(value)`](#fn-withcsvcontent) +* [`fn withCsvFileName(value)`](#fn-withcsvfilename) +* [`fn withCsvWave(value)`](#fn-withcsvwave) +* [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withDropPercent(value)`](#fn-withdroppercent) +* [`fn withErrorType(value)`](#fn-witherrortype) +* [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLevelColumn(value=true)`](#fn-withlevelcolumn) +* [`fn withLines(value)`](#fn-withlines) +* [`fn withMax(value)`](#fn-withmax) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withMin(value)`](#fn-withmin) +* [`fn withNodes(value)`](#fn-withnodes) +* [`fn withNodesMixin(value)`](#fn-withnodesmixin) +* [`fn withNoise(value)`](#fn-withnoise) +* [`fn withPoints(value)`](#fn-withpoints) +* [`fn withPointsMixin(value)`](#fn-withpointsmixin) +* [`fn withPulseWave(value)`](#fn-withpulsewave) +* [`fn withPulseWaveMixin(value)`](#fn-withpulsewavemixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawFrameContent(value)`](#fn-withrawframecontent) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withScenarioId(value)`](#fn-withscenarioid) +* [`fn withSeriesCount(value)`](#fn-withseriescount) +* [`fn withSim(value)`](#fn-withsim) +* [`fn withSimMixin(value)`](#fn-withsimmixin) +* [`fn withSpanCount(value)`](#fn-withspancount) +* [`fn withSpread(value)`](#fn-withspread) +* [`fn withStartValue(value)`](#fn-withstartvalue) +* [`fn withStream(value)`](#fn-withstream) +* [`fn withStreamMixin(value)`](#fn-withstreammixin) +* [`fn withStringInput(value)`](#fn-withstringinput) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withUsa(value)`](#fn-withusa) +* [`fn withUsaMixin(value)`](#fn-withusamixin) +* [`fn withWithNil(value=true)`](#fn-withwithnil) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj nodes`](#obj-nodes) + * [`fn withCount(value)`](#fn-nodeswithcount) + * [`fn withSeed(value)`](#fn-nodeswithseed) + * [`fn withType(value)`](#fn-nodeswithtype) +* [`obj pulseWave`](#obj-pulsewave) + * [`fn withOffCount(value)`](#fn-pulsewavewithoffcount) + * [`fn withOffValue(value)`](#fn-pulsewavewithoffvalue) + * [`fn withOnCount(value)`](#fn-pulsewavewithoncount) + * [`fn withOnValue(value)`](#fn-pulsewavewithonvalue) + * [`fn withTimeStep(value)`](#fn-pulsewavewithtimestep) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj sim`](#obj-sim) + * [`fn withConfig(value)`](#fn-simwithconfig) + * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) + * [`fn withKey(value)`](#fn-simwithkey) + * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) + * [`fn withLast(value=true)`](#fn-simwithlast) + * [`fn withStream(value=true)`](#fn-simwithstream) + * [`obj key`](#obj-simkey) + * [`fn withTick(value)`](#fn-simkeywithtick) + * [`fn withType(value)`](#fn-simkeywithtype) + * [`fn withUid(value)`](#fn-simkeywithuid) +* [`obj stream`](#obj-stream) + * [`fn withBands(value)`](#fn-streamwithbands) + * [`fn withNoise(value)`](#fn-streamwithnoise) + * [`fn withSpeed(value)`](#fn-streamwithspeed) + * [`fn withSpread(value)`](#fn-streamwithspread) + * [`fn withType(value)`](#fn-streamwithtype) + * [`fn withUrl(value)`](#fn-streamwithurl) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) +* [`obj usa`](#obj-usa) + * [`fn withFields(value)`](#fn-usawithfields) + * [`fn withFieldsMixin(value)`](#fn-usawithfieldsmixin) + * [`fn withMode(value)`](#fn-usawithmode) + * [`fn withPeriod(value)`](#fn-usawithperiod) + * [`fn withStates(value)`](#fn-usawithstates) + * [`fn withStatesMixin(value)`](#fn-usawithstatesmixin) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withChannel + +```jsonnet +withChannel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used for live query +### fn withCsvContent + +```jsonnet +withCsvContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvFileName + +```jsonnet +withCsvFileName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvWave + +```jsonnet +withCsvWave(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withCsvWaveMixin + +```jsonnet +withCsvWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDropPercent + +```jsonnet +withDropPercent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Drop percentage (the chance we will lose a point 0-100) +### fn withErrorType + +```jsonnet +withErrorType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"frontend_exception"`, `"frontend_observable"`, `"server_panic"` + +Possible enum values: + - `"frontend_exception"` + - `"frontend_observable"` + - `"server_panic"` +### fn withFlamegraphDiff + +```jsonnet +withFlamegraphDiff(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withLevelColumn + +```jsonnet +withLevelColumn(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLines + +```jsonnet +withLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withMax + +```jsonnet +withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withMin + +```jsonnet +withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withNodes + +```jsonnet +withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNodesMixin + +```jsonnet +withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNoise + +```jsonnet +withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withPoints + +```jsonnet +withPoints(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPointsMixin + +```jsonnet +withPointsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPulseWave + +```jsonnet +withPulseWave(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPulseWaveMixin + +```jsonnet +withPulseWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRawFrameContent + +```jsonnet +withRawFrameContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScenarioId + +```jsonnet +withScenarioId(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"annotations"`, `"arrow"`, `"csv_content"`, `"csv_file"`, `"csv_metric_values"`, `"datapoints_outside_range"`, `"exponential_heatmap_bucket_data"`, `"flame_graph"`, `"grafana_api"`, `"linear_heatmap_bucket_data"`, `"live"`, `"logs"`, `"manual_entry"`, `"no_data_points"`, `"node_graph"`, `"predictable_csv_wave"`, `"predictable_pulse"`, `"random_walk"`, `"random_walk_table"`, `"random_walk_with_error"`, `"raw_frame"`, `"server_error_500"`, `"simulation"`, `"slow_query"`, `"streaming_client"`, `"table_static"`, `"trace"`, `"usa"`, `"variables-query"` + +Possible enum values: + - `"annotations"` + - `"arrow"` + - `"csv_content"` + - `"csv_file"` + - `"csv_metric_values"` + - `"datapoints_outside_range"` + - `"exponential_heatmap_bucket_data"` + - `"flame_graph"` + - `"grafana_api"` + - `"linear_heatmap_bucket_data"` + - `"live"` + - `"logs"` + - `"manual_entry"` + - `"no_data_points"` + - `"node_graph"` + - `"predictable_csv_wave"` + - `"predictable_pulse"` + - `"random_walk"` + - `"random_walk_table"` + - `"random_walk_with_error"` + - `"raw_frame"` + - `"server_error_500"` + - `"simulation"` + - `"slow_query"` + - `"streaming_client"` + - `"table_static"` + - `"trace"` + - `"usa"` + - `"variables-query"` +### fn withSeriesCount + +```jsonnet +withSeriesCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSim + +```jsonnet +withSim(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSimMixin + +```jsonnet +withSimMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSpanCount + +```jsonnet +withSpanCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSpread + +```jsonnet +withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStartValue + +```jsonnet +withStartValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStream + +```jsonnet +withStream(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStreamMixin + +```jsonnet +withStreamMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStringInput + +```jsonnet +withStringInput(value) +``` + +PARAMETERS: + +* **value** (`string`) + +common parameter used by many query types +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsa + +```jsonnet +withUsa(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsaMixin + +```jsonnet +withUsaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withWithNil + +```jsonnet +withWithNil(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj nodes + + +#### fn nodes.withCount + +```jsonnet +nodes.withCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withSeed + +```jsonnet +nodes.withSeed(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withType + +```jsonnet +nodes.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"random"`, `"random edges"`, `"response_medium"`, `"response_small"`, `"feature_showcase"` + +Possible enum values: + - `"random"` + - `"random edges"` + - `"response_medium"` + - `"response_small"` + - `"feature_showcase"` +### obj pulseWave + + +#### fn pulseWave.withOffCount + +```jsonnet +pulseWave.withOffCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOffValue + +```jsonnet +pulseWave.withOffValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withOnCount + +```jsonnet +pulseWave.withOnCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOnValue + +```jsonnet +pulseWave.withOnValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withTimeStep + +```jsonnet +pulseWave.withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj sim + + +#### fn sim.withConfig + +```jsonnet +sim.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withConfigMixin + +```jsonnet +sim.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKey + +```jsonnet +sim.withKey(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKeyMixin + +```jsonnet +sim.withKeyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withLast + +```jsonnet +sim.withLast(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn sim.withStream + +```jsonnet +sim.withStream(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj sim.key + + +##### fn sim.key.withTick + +```jsonnet +sim.key.withTick(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn sim.key.withType + +```jsonnet +sim.key.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn sim.key.withUid + +```jsonnet +sim.key.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj stream + + +#### fn stream.withBands + +```jsonnet +stream.withBands(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn stream.withNoise + +```jsonnet +stream.withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpeed + +```jsonnet +stream.withSpeed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpread + +```jsonnet +stream.withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withType + +```jsonnet +stream.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fetch"`, `"logs"`, `"signal"`, `"traces"` + +Possible enum values: + - `"fetch"` + - `"logs"` + - `"signal"` + - `"traces"` +#### fn stream.withUrl + +```jsonnet +stream.withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. +### obj usa + + +#### fn usa.withFields + +```jsonnet +usa.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withFieldsMixin + +```jsonnet +usa.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withMode + +```jsonnet +usa.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withPeriod + +```jsonnet +usa.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withStates + +```jsonnet +usa.withStates(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withStatesMixin + +```jsonnet +usa.withStatesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/gen/grafonnet-v11.0.0/query.libsonnet b/gen/grafonnet-v11.0.0/query.libsonnet index 69d4e766..42cbcef7 100644 --- a/gen/grafonnet-v11.0.0/query.libsonnet +++ b/gen/grafonnet-v11.0.0/query.libsonnet @@ -10,4 +10,5 @@ parca: import 'query/parca.libsonnet', prometheus: import 'query/prometheus.libsonnet', tempo: import 'query/tempo.libsonnet', + testData: import 'query/testData.libsonnet', } diff --git a/gen/grafonnet-v11.0.0/query/testData.libsonnet b/gen/grafonnet-v11.0.0/query/testData.libsonnet new file mode 100644 index 00000000..bd04f11f --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/testData.libsonnet @@ -0,0 +1,493 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.testData', name: 'testData' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlias(value): { + alias: value, + }, + '#withChannel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used for live query' } }, + withChannel(value): { + channel: value, + }, + '#withCsvContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvContent(value): { + csvContent: value, + }, + '#withCsvFileName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvFileName(value): { + csvFileName: value, + }, + '#withCsvWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWave(value): { + csvWave: + (if std.isArray(value) + then value + else [value]), + }, + '#withCsvWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWaveMixin(value): { + csvWave+: + (if std.isArray(value) + then value + else [value]), + }, + csvWave+: + { + '#': { help: '', name: 'csvWave' }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { + timeStep: value, + }, + '#withValuesCSV': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValuesCSV(value): { + valuesCSV: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The datasource plugin type' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDropPercent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Drop percentage (the chance we will lose a point 0-100)' } }, + withDropPercent(value): { + dropPercent: value, + }, + '#withErrorType': { 'function': { args: [{ default: null, enums: ['frontend_exception', 'frontend_observable', 'server_panic'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"frontend_exception"` \n - `"frontend_observable"` \n - `"server_panic"` ' } }, + withErrorType(value): { + errorType: value, + }, + '#withFlamegraphDiff': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFlamegraphDiff(value=true): { + flamegraphDiff: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLevelColumn': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLevelColumn(value=true): { + levelColumn: value, + }, + '#withLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLines(value): { + lines: value, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + max: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + min: value, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { + nodes: value, + }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { + nodes+: value, + }, + nodes+: + { + '#withCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withCount(value): { + nodes+: { + count: value, + }, + }, + '#withSeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeed(value): { + nodes+: { + seed: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['random', 'random edges', 'response_medium', 'response_small', 'feature_showcase'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"random"` \n - `"random edges"` \n - `"response_medium"` \n - `"response_small"` \n - `"feature_showcase"` ' } }, + withType(value): { + nodes+: { + type: value, + }, + }, + }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withNoise(value): { + noise: value, + }, + '#withPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPoints(value): { + points: + (if std.isArray(value) + then value + else [value]), + }, + '#withPointsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPointsMixin(value): { + points+: + (if std.isArray(value) + then value + else [value]), + }, + '#withPulseWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWave(value): { + pulseWave: value, + }, + '#withPulseWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWaveMixin(value): { + pulseWave+: value, + }, + pulseWave+: + { + '#withOffCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOffCount(value): { + pulseWave+: { + offCount: value, + }, + }, + '#withOffValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOffValue(value): { + pulseWave+: { + offValue: value, + }, + }, + '#withOnCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOnCount(value): { + pulseWave+: { + onCount: value, + }, + }, + '#withOnValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOnValue(value): { + pulseWave+: { + onValue: value, + }, + }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { + pulseWave+: { + timeStep: value, + }, + }, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawFrameContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawFrameContent(value): { + rawFrameContent: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withScenarioId': { 'function': { args: [{ default: null, enums: ['annotations', 'arrow', 'csv_content', 'csv_file', 'csv_metric_values', 'datapoints_outside_range', 'exponential_heatmap_bucket_data', 'flame_graph', 'grafana_api', 'linear_heatmap_bucket_data', 'live', 'logs', 'manual_entry', 'no_data_points', 'node_graph', 'predictable_csv_wave', 'predictable_pulse', 'random_walk', 'random_walk_table', 'random_walk_with_error', 'raw_frame', 'server_error_500', 'simulation', 'slow_query', 'streaming_client', 'table_static', 'trace', 'usa', 'variables-query'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"annotations"` \n - `"arrow"` \n - `"csv_content"` \n - `"csv_file"` \n - `"csv_metric_values"` \n - `"datapoints_outside_range"` \n - `"exponential_heatmap_bucket_data"` \n - `"flame_graph"` \n - `"grafana_api"` \n - `"linear_heatmap_bucket_data"` \n - `"live"` \n - `"logs"` \n - `"manual_entry"` \n - `"no_data_points"` \n - `"node_graph"` \n - `"predictable_csv_wave"` \n - `"predictable_pulse"` \n - `"random_walk"` \n - `"random_walk_table"` \n - `"random_walk_with_error"` \n - `"raw_frame"` \n - `"server_error_500"` \n - `"simulation"` \n - `"slow_query"` \n - `"streaming_client"` \n - `"table_static"` \n - `"trace"` \n - `"usa"` \n - `"variables-query"` ' } }, + withScenarioId(value): { + scenarioId: value, + }, + '#withSeriesCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeriesCount(value): { + seriesCount: value, + }, + '#withSim': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSim(value): { + sim: value, + }, + '#withSimMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSimMixin(value): { + sim+: value, + }, + sim+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfig(value): { + sim+: { + config: value, + }, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfigMixin(value): { + sim+: { + config+: value, + }, + }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKey(value): { + sim+: { + key: value, + }, + }, + '#withKeyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKeyMixin(value): { + sim+: { + key+: value, + }, + }, + key+: + { + '#withTick': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTick(value): { + sim+: { + key+: { + tick: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sim+: { + key+: { + type: value, + }, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUid(value): { + sim+: { + key+: { + uid: value, + }, + }, + }, + }, + '#withLast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLast(value=true): { + sim+: { + last: value, + }, + }, + '#withStream': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withStream(value=true): { + sim+: { + stream: value, + }, + }, + }, + '#withSpanCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSpanCount(value): { + spanCount: value, + }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpread(value): { + spread: value, + }, + '#withStartValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withStartValue(value): { + startValue: value, + }, + '#withStream': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStream(value): { + stream: value, + }, + '#withStreamMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStreamMixin(value): { + stream+: value, + }, + stream+: + { + '#withBands': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withBands(value): { + stream+: { + bands: value, + }, + }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withNoise(value): { + stream+: { + noise: value, + }, + }, + '#withSpeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpeed(value): { + stream+: { + speed: value, + }, + }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpread(value): { + stream+: { + spread: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['fetch', 'logs', 'signal', 'traces'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"fetch"` \n - `"logs"` \n - `"signal"` \n - `"traces"` ' } }, + withType(value): { + stream+: { + type: value, + }, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUrl(value): { + stream+: { + url: value, + }, + }, + }, + '#withStringInput': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'common parameter used by many query types' } }, + withStringInput(value): { + stringInput: value, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withUsa': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsa(value): { + usa: value, + }, + '#withUsaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsaMixin(value): { + usa+: value, + }, + usa+: + { + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { + usa+: { + fields: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { + usa+: { + fields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + usa+: { + mode: value, + }, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPeriod(value): { + usa+: { + period: value, + }, + }, + '#withStates': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStates(value): { + usa+: { + states: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withStatesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStatesMixin(value): { + usa+: { + states+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWithNil': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWithNil(value=true): { + withNil: value, + }, +} diff --git a/generator/query.libsonnet b/generator/query.libsonnet index 54de3c92..f316da54 100644 --- a/generator/query.libsonnet +++ b/generator/query.libsonnet @@ -13,6 +13,7 @@ local utils = import './utils.libsonnet'; cloudwatch: 'cloudWatch', googlecloudmonitoring: 'googleCloudMonitoring', grafanapyroscope: 'grafanaPyroscope', + testdata: 'testData', }, render(schemas): From 37d17b1a8208a7539c2dbcd1a40469421bbc8ba4 Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 09:37:59 +0200 Subject: [PATCH 11/17] feat: add expr query --- custom/query/expr.libsonnet | 12 + .../expr/TypeClassicConditions/conditions.md | 205 ++++ .../query/expr/TypeClassicConditions/index.md | 312 ++++++ docs/API/query/expr/TypeMath.md | 296 ++++++ docs/API/query/expr/TypeReduce.md | 372 +++++++ docs/API/query/expr/TypeResample.md | 345 +++++++ docs/API/query/expr/TypeSql.md | 296 ++++++ .../query/expr/TypeThreshold/conditions.md | 163 +++ docs/API/query/expr/TypeThreshold/index.md | 324 ++++++ docs/API/query/expr/index.md | 12 + docs/API/query/index.md | 1 + .../custom/query/expr.libsonnet | 12 + .../expr/TypeClassicConditions/conditions.md | 205 ++++ .../query/expr/TypeClassicConditions/index.md | 312 ++++++ .../docs/query/expr/TypeMath.md | 296 ++++++ .../docs/query/expr/TypeReduce.md | 372 +++++++ .../docs/query/expr/TypeResample.md | 345 +++++++ .../docs/query/expr/TypeSql.md | 296 ++++++ .../query/expr/TypeThreshold/conditions.md | 163 +++ .../docs/query/expr/TypeThreshold/index.md | 324 ++++++ .../docs/query/expr/index.md | 12 + gen/grafonnet-v11.0.0/docs/query/index.md | 1 + gen/grafonnet-v11.0.0/query.libsonnet | 1 + gen/grafonnet-v11.0.0/query/expr.libsonnet | 960 ++++++++++++++++++ generator/query.libsonnet | 6 + 25 files changed, 5643 insertions(+) create mode 100644 custom/query/expr.libsonnet create mode 100644 docs/API/query/expr/TypeClassicConditions/conditions.md create mode 100644 docs/API/query/expr/TypeClassicConditions/index.md create mode 100644 docs/API/query/expr/TypeMath.md create mode 100644 docs/API/query/expr/TypeReduce.md create mode 100644 docs/API/query/expr/TypeResample.md create mode 100644 docs/API/query/expr/TypeSql.md create mode 100644 docs/API/query/expr/TypeThreshold/conditions.md create mode 100644 docs/API/query/expr/TypeThreshold/index.md create mode 100644 docs/API/query/expr/index.md create mode 100644 gen/grafonnet-v11.0.0/custom/query/expr.libsonnet create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/expr/index.md create mode 100644 gen/grafonnet-v11.0.0/query/expr.libsonnet diff --git a/custom/query/expr.libsonnet b/custom/query/expr.libsonnet new file mode 100644 index 00000000..02417b6c --- /dev/null +++ b/custom/query/expr.libsonnet @@ -0,0 +1,12 @@ +{ + '#': { + help: 'Server Side Expression operations for grafonnet.alerting.ruleGroup.rule', + name: 'expr', + }, + TypeMath+: { '#': { help: 'grafonnet.query.expr.TypeMath', name: 'TypeMath' } }, + TypeReduce+: { '#': { help: 'grafonnet.query.expr.TypeReduce', name: 'TypeReduce' } }, + TypeResample+: { '#': { help: 'grafonnet.query.expr.TypeResample', name: 'TypeResample' } }, + TypeClassicConditions+: { '#': { help: 'grafonnet.query.expr.TypeClassicConditions', name: 'TypeClassicConditions' } }, + TypeThreshold+: { '#': { help: 'grafonnet.query.expr.TypeThreshold', name: 'TypeThreshold' } }, + TypeSql+: { '#': { help: 'grafonnet.query.expr.TypeSql', name: 'TypeSql' } }, +} diff --git a/docs/API/query/expr/TypeClassicConditions/conditions.md b/docs/API/query/expr/TypeClassicConditions/conditions.md new file mode 100644 index 00000000..8ad01477 --- /dev/null +++ b/docs/API/query/expr/TypeClassicConditions/conditions.md @@ -0,0 +1,205 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withOperatorMixin(value)`](#fn-withoperatormixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryMixin(value)`](#fn-withquerymixin) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withReducerMixin(value)`](#fn-withreducermixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj operator`](#obj-operator) + * [`fn withType(value)`](#fn-operatorwithtype) +* [`obj query`](#obj-query) + * [`fn withParams(value)`](#fn-querywithparams) + * [`fn withParamsMixin(value)`](#fn-querywithparamsmixin) +* [`obj reducer`](#obj-reducer) + * [`fn withType(value)`](#fn-reducerwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperatorMixin + +```jsonnet +withOperatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryMixin + +```jsonnet +withQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducerMixin + +```jsonnet +withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +e.g. "gt" +### obj operator + + +#### fn operator.withType + +```jsonnet +operator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + + +### obj query + + +#### fn query.withParams + +```jsonnet +query.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn query.withParamsMixin + +```jsonnet +query.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj reducer + + +#### fn reducer.withType + +```jsonnet +reducer.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/API/query/expr/TypeClassicConditions/index.md b/docs/API/query/expr/TypeClassicConditions/index.md new file mode 100644 index 00000000..5678c5e5 --- /dev/null +++ b/docs/API/query/expr/TypeClassicConditions/index.md @@ -0,0 +1,312 @@ +# TypeClassicConditions + +grafonnet.query.expr.TypeClassicConditions + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/docs/API/query/expr/TypeMath.md b/docs/API/query/expr/TypeMath.md new file mode 100644 index 00000000..705953ec --- /dev/null +++ b/docs/API/query/expr/TypeMath.md @@ -0,0 +1,296 @@ +# TypeMath + +grafonnet.query.expr.TypeMath + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +General math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/docs/API/query/expr/TypeReduce.md b/docs/API/query/expr/TypeReduce.md new file mode 100644 index 00000000..f918e40c --- /dev/null +++ b/docs/API/query/expr/TypeReduce.md @@ -0,0 +1,372 @@ +# TypeReduce + +grafonnet.query.expr.TypeReduce + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj settings`](#obj-settings) + * [`fn withMode(value)`](#fn-settingswithmode) + * [`fn withReplaceWithValue(value)`](#fn-settingswithreplacewithvalue) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"` + +The reducer +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj settings + + +#### fn settings.withMode + +```jsonnet +settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"dropNN"`, `"replaceNN"` + +Non-number reduce behavior +Possible enum values: + - `"dropNN"` Drop non-numbers + - `"replaceNN"` Replace non-numbers +#### fn settings.withReplaceWithValue + +```jsonnet +settings.withReplaceWithValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Only valid when mode is replace +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/docs/API/query/expr/TypeResample.md b/docs/API/query/expr/TypeResample.md new file mode 100644 index 00000000..de08c47c --- /dev/null +++ b/docs/API/query/expr/TypeResample.md @@ -0,0 +1,345 @@ +# TypeResample + +grafonnet.query.expr.TypeResample + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withDownsampler(value)`](#fn-withdownsampler) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`fn withUpsampler(value)`](#fn-withupsampler) +* [`fn withWindow(value)`](#fn-withwindow) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDownsampler + +```jsonnet +withDownsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"` + +The downsample function +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### fn withUpsampler + +```jsonnet +withUpsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pad"`, `"backfilling"`, `"fillna"` + +The upsample function +Possible enum values: + - `"pad"` Use the last seen value + - `"backfilling"` backfill + - `"fillna"` Do not fill values (nill) +### fn withWindow + +```jsonnet +withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The time duration +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/docs/API/query/expr/TypeSql.md b/docs/API/query/expr/TypeSql.md new file mode 100644 index 00000000..97c38517 --- /dev/null +++ b/docs/API/query/expr/TypeSql.md @@ -0,0 +1,296 @@ +# TypeSql + +grafonnet.query.expr.TypeSql + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/docs/API/query/expr/TypeThreshold/conditions.md b/docs/API/query/expr/TypeThreshold/conditions.md new file mode 100644 index 00000000..554ddb92 --- /dev/null +++ b/docs/API/query/expr/TypeThreshold/conditions.md @@ -0,0 +1,163 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withLoadedDimensions(value)`](#fn-withloadeddimensions) +* [`fn withLoadedDimensionsMixin(value)`](#fn-withloadeddimensionsmixin) +* [`fn withUnloadEvaluator(value)`](#fn-withunloadevaluator) +* [`fn withUnloadEvaluatorMixin(value)`](#fn-withunloadevaluatormixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj unloadEvaluator`](#obj-unloadevaluator) + * [`fn withParams(value)`](#fn-unloadevaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-unloadevaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-unloadevaluatorwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensions + +```jsonnet +withLoadedDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensionsMixin + +```jsonnet +withLoadedDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluator + +```jsonnet +withUnloadEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluatorMixin + +```jsonnet +withUnloadEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" +### obj unloadEvaluator + + +#### fn unloadEvaluator.withParams + +```jsonnet +unloadEvaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withParamsMixin + +```jsonnet +unloadEvaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withType + +```jsonnet +unloadEvaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" \ No newline at end of file diff --git a/docs/API/query/expr/TypeThreshold/index.md b/docs/API/query/expr/TypeThreshold/index.md new file mode 100644 index 00000000..9c020f81 --- /dev/null +++ b/docs/API/query/expr/TypeThreshold/index.md @@ -0,0 +1,324 @@ +# TypeThreshold + +grafonnet.query.expr.TypeThreshold + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/docs/API/query/expr/index.md b/docs/API/query/expr/index.md new file mode 100644 index 00000000..a89a72a1 --- /dev/null +++ b/docs/API/query/expr/index.md @@ -0,0 +1,12 @@ +# expr + +Server Side Expression operations for grafonnet.alerting.ruleGroup.rule + +## Subpackages + +* [TypeClassicConditions](TypeClassicConditions/index.md) +* [TypeMath](TypeMath.md) +* [TypeReduce](TypeReduce.md) +* [TypeResample](TypeResample.md) +* [TypeSql](TypeSql.md) +* [TypeThreshold](TypeThreshold/index.md) diff --git a/docs/API/query/index.md b/docs/API/query/index.md index c36150f0..2e381972 100644 --- a/docs/API/query/index.md +++ b/docs/API/query/index.md @@ -7,6 +7,7 @@ grafonnet.query * [azureMonitor](azureMonitor/index.md) * [cloudWatch](cloudWatch/index.md) * [elasticsearch](elasticsearch/index.md) +* [expr](expr/index.md) * [googleCloudMonitoring](googleCloudMonitoring.md) * [grafanaPyroscope](grafanaPyroscope.md) * [loki](loki.md) diff --git a/gen/grafonnet-v11.0.0/custom/query/expr.libsonnet b/gen/grafonnet-v11.0.0/custom/query/expr.libsonnet new file mode 100644 index 00000000..02417b6c --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/expr.libsonnet @@ -0,0 +1,12 @@ +{ + '#': { + help: 'Server Side Expression operations for grafonnet.alerting.ruleGroup.rule', + name: 'expr', + }, + TypeMath+: { '#': { help: 'grafonnet.query.expr.TypeMath', name: 'TypeMath' } }, + TypeReduce+: { '#': { help: 'grafonnet.query.expr.TypeReduce', name: 'TypeReduce' } }, + TypeResample+: { '#': { help: 'grafonnet.query.expr.TypeResample', name: 'TypeResample' } }, + TypeClassicConditions+: { '#': { help: 'grafonnet.query.expr.TypeClassicConditions', name: 'TypeClassicConditions' } }, + TypeThreshold+: { '#': { help: 'grafonnet.query.expr.TypeThreshold', name: 'TypeThreshold' } }, + TypeSql+: { '#': { help: 'grafonnet.query.expr.TypeSql', name: 'TypeSql' } }, +} diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md new file mode 100644 index 00000000..8ad01477 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md @@ -0,0 +1,205 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withOperatorMixin(value)`](#fn-withoperatormixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryMixin(value)`](#fn-withquerymixin) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withReducerMixin(value)`](#fn-withreducermixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj operator`](#obj-operator) + * [`fn withType(value)`](#fn-operatorwithtype) +* [`obj query`](#obj-query) + * [`fn withParams(value)`](#fn-querywithparams) + * [`fn withParamsMixin(value)`](#fn-querywithparamsmixin) +* [`obj reducer`](#obj-reducer) + * [`fn withType(value)`](#fn-reducerwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperatorMixin + +```jsonnet +withOperatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryMixin + +```jsonnet +withQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducerMixin + +```jsonnet +withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +e.g. "gt" +### obj operator + + +#### fn operator.withType + +```jsonnet +operator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + + +### obj query + + +#### fn query.withParams + +```jsonnet +query.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn query.withParamsMixin + +```jsonnet +query.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj reducer + + +#### fn reducer.withType + +```jsonnet +reducer.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md new file mode 100644 index 00000000..5678c5e5 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md @@ -0,0 +1,312 @@ +# TypeClassicConditions + +grafonnet.query.expr.TypeClassicConditions + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md new file mode 100644 index 00000000..705953ec --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md @@ -0,0 +1,296 @@ +# TypeMath + +grafonnet.query.expr.TypeMath + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +General math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md new file mode 100644 index 00000000..f918e40c --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md @@ -0,0 +1,372 @@ +# TypeReduce + +grafonnet.query.expr.TypeReduce + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj settings`](#obj-settings) + * [`fn withMode(value)`](#fn-settingswithmode) + * [`fn withReplaceWithValue(value)`](#fn-settingswithreplacewithvalue) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"` + +The reducer +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj settings + + +#### fn settings.withMode + +```jsonnet +settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"dropNN"`, `"replaceNN"` + +Non-number reduce behavior +Possible enum values: + - `"dropNN"` Drop non-numbers + - `"replaceNN"` Replace non-numbers +#### fn settings.withReplaceWithValue + +```jsonnet +settings.withReplaceWithValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Only valid when mode is replace +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md new file mode 100644 index 00000000..de08c47c --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md @@ -0,0 +1,345 @@ +# TypeResample + +grafonnet.query.expr.TypeResample + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withDownsampler(value)`](#fn-withdownsampler) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`fn withUpsampler(value)`](#fn-withupsampler) +* [`fn withWindow(value)`](#fn-withwindow) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDownsampler + +```jsonnet +withDownsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"` + +The downsample function +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### fn withUpsampler + +```jsonnet +withUpsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pad"`, `"backfilling"`, `"fillna"` + +The upsample function +Possible enum values: + - `"pad"` Use the last seen value + - `"backfilling"` backfill + - `"fillna"` Do not fill values (nill) +### fn withWindow + +```jsonnet +withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The time duration +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md new file mode 100644 index 00000000..97c38517 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md @@ -0,0 +1,296 @@ +# TypeSql + +grafonnet.query.expr.TypeSql + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md new file mode 100644 index 00000000..554ddb92 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md @@ -0,0 +1,163 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withLoadedDimensions(value)`](#fn-withloadeddimensions) +* [`fn withLoadedDimensionsMixin(value)`](#fn-withloadeddimensionsmixin) +* [`fn withUnloadEvaluator(value)`](#fn-withunloadevaluator) +* [`fn withUnloadEvaluatorMixin(value)`](#fn-withunloadevaluatormixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj unloadEvaluator`](#obj-unloadevaluator) + * [`fn withParams(value)`](#fn-unloadevaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-unloadevaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-unloadevaluatorwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensions + +```jsonnet +withLoadedDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensionsMixin + +```jsonnet +withLoadedDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluator + +```jsonnet +withUnloadEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluatorMixin + +```jsonnet +withUnloadEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" +### obj unloadEvaluator + + +#### fn unloadEvaluator.withParams + +```jsonnet +unloadEvaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withParamsMixin + +```jsonnet +unloadEvaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withType + +```jsonnet +unloadEvaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md b/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md new file mode 100644 index 00000000..9c020f81 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md @@ -0,0 +1,324 @@ +# TypeThreshold + +grafonnet.query.expr.TypeThreshold + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/expr/index.md b/gen/grafonnet-v11.0.0/docs/query/expr/index.md new file mode 100644 index 00000000..a89a72a1 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/expr/index.md @@ -0,0 +1,12 @@ +# expr + +Server Side Expression operations for grafonnet.alerting.ruleGroup.rule + +## Subpackages + +* [TypeClassicConditions](TypeClassicConditions/index.md) +* [TypeMath](TypeMath.md) +* [TypeReduce](TypeReduce.md) +* [TypeResample](TypeResample.md) +* [TypeSql](TypeSql.md) +* [TypeThreshold](TypeThreshold/index.md) diff --git a/gen/grafonnet-v11.0.0/docs/query/index.md b/gen/grafonnet-v11.0.0/docs/query/index.md index c36150f0..2e381972 100644 --- a/gen/grafonnet-v11.0.0/docs/query/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/index.md @@ -7,6 +7,7 @@ grafonnet.query * [azureMonitor](azureMonitor/index.md) * [cloudWatch](cloudWatch/index.md) * [elasticsearch](elasticsearch/index.md) +* [expr](expr/index.md) * [googleCloudMonitoring](googleCloudMonitoring.md) * [grafanaPyroscope](grafanaPyroscope.md) * [loki](loki.md) diff --git a/gen/grafonnet-v11.0.0/query.libsonnet b/gen/grafonnet-v11.0.0/query.libsonnet index 42cbcef7..129a0ea0 100644 --- a/gen/grafonnet-v11.0.0/query.libsonnet +++ b/gen/grafonnet-v11.0.0/query.libsonnet @@ -4,6 +4,7 @@ azureMonitor: import 'query/azureMonitor.libsonnet', cloudWatch: import 'query/cloudWatch.libsonnet', elasticsearch: import 'query/elasticsearch.libsonnet', + expr: import 'query/expr.libsonnet', googleCloudMonitoring: import 'query/googleCloudMonitoring.libsonnet', grafanaPyroscope: import 'query/grafanaPyroscope.libsonnet', loki: import 'query/loki.libsonnet', diff --git a/gen/grafonnet-v11.0.0/query/expr.libsonnet b/gen/grafonnet-v11.0.0/query/expr.libsonnet new file mode 100644 index 00000000..e181b171 --- /dev/null +++ b/gen/grafonnet-v11.0.0/query/expr.libsonnet @@ -0,0 +1,960 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.expr', name: 'expr' }, + TypeMath+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'General math expression' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'math', + }, + }, + TypeReduce+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reference to single query result' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: ['sum', 'mean', 'min', 'max', 'count', 'last'], name: 'value', type: ['string'] }], help: 'The reducer\nPossible enum values:\n - `"sum"` \n - `"mean"` \n - `"min"` \n - `"max"` \n - `"count"` \n - `"last"` ' } }, + withReducer(value): { + reducer: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Reducer Options' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Reducer Options' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['dropNN', 'replaceNN'], name: 'value', type: ['string'] }], help: 'Non-number reduce behavior\nPossible enum values:\n - `"dropNN"` Drop non-numbers\n - `"replaceNN"` Replace non-numbers' } }, + withMode(value): { + settings+: { + mode: value, + }, + }, + '#withReplaceWithValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Only valid when mode is replace' } }, + withReplaceWithValue(value): { + settings+: { + replaceWithValue: value, + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'reduce', + }, + }, + TypeResample+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDownsampler': { 'function': { args: [{ default: null, enums: ['sum', 'mean', 'min', 'max', 'count', 'last'], name: 'value', type: ['string'] }], help: 'The downsample function\nPossible enum values:\n - `"sum"` \n - `"mean"` \n - `"min"` \n - `"max"` \n - `"count"` \n - `"last"` ' } }, + withDownsampler(value): { + downsampler: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The math expression' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'resample', + }, + '#withUpsampler': { 'function': { args: [{ default: null, enums: ['pad', 'backfilling', 'fillna'], name: 'value', type: ['string'] }], help: 'The upsample function\nPossible enum values:\n - `"pad"` Use the last seen value\n - `"backfilling"` backfill\n - `"fillna"` Do not fill values (nill)' } }, + withUpsampler(value): { + upsampler: value, + }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The time duration' } }, + withWindow(value): { + window: value, + }, + }, + TypeClassicConditions+: + { + '#withConditions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConditions(value): { + conditions: + (if std.isArray(value) + then value + else [value]), + }, + '#withConditionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConditionsMixin(value): { + conditions+: + (if std.isArray(value) + then value + else [value]), + }, + conditions+: + { + '#': { help: '', name: 'conditions' }, + '#withEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluator(value): { + evaluator: value, + }, + '#withEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluatorMixin(value): { + evaluator+: value, + }, + evaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + evaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + evaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + evaluator+: { + type: value, + }, + }, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOperator(value): { + operator: value, + }, + '#withOperatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOperatorMixin(value): { + operator+: value, + }, + operator+: + { + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + operator+: { + type: value, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQuery(value): { + query: value, + }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryMixin(value): { + query+: value, + }, + query+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + query+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + query+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withReducer(value): { + reducer: value, + }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withReducerMixin(value): { + reducer+: value, + }, + reducer+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + reducer+: { + type: value, + }, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'classic_conditions', + }, + }, + TypeThreshold+: + { + '#withConditions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Threshold Conditions' } }, + withConditions(value): { + conditions: + (if std.isArray(value) + then value + else [value]), + }, + '#withConditionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Threshold Conditions' } }, + withConditionsMixin(value): { + conditions+: + (if std.isArray(value) + then value + else [value]), + }, + conditions+: + { + '#': { help: '', name: 'conditions' }, + '#withEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluator(value): { + evaluator: value, + }, + '#withEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluatorMixin(value): { + evaluator+: value, + }, + evaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + evaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + evaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['gt', 'lt', 'within_range', 'outside_range'], name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + evaluator+: { + type: value, + }, + }, + }, + '#withLoadedDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLoadedDimensions(value): { + loadedDimensions: value, + }, + '#withLoadedDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLoadedDimensionsMixin(value): { + loadedDimensions+: value, + }, + '#withUnloadEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnloadEvaluator(value): { + unloadEvaluator: value, + }, + '#withUnloadEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnloadEvaluatorMixin(value): { + unloadEvaluator+: value, + }, + unloadEvaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + unloadEvaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + unloadEvaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['gt', 'lt', 'within_range', 'outside_range'], name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + unloadEvaluator+: { + type: value, + }, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reference to single query result' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'threshold', + }, + }, + TypeSql+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'sql', + }, + }, +} ++ (import '../custom/query/expr.libsonnet') diff --git a/generator/query.libsonnet b/generator/query.libsonnet index f316da54..14efb47f 100644 --- a/generator/query.libsonnet +++ b/generator/query.libsonnet @@ -114,6 +114,11 @@ local utils = import './utils.libsonnet'; }, }, }, + expr: { + dataquery: { + '$ref': '#/components/schemas/expr', + }, + }, }, queryIndex(files): @@ -142,5 +147,6 @@ local utils = import './utils.libsonnet'; 'loki', 'prometheus', 'tempo', + 'expr', ], } From 231b88631954abfba694dd55ad279fc1c51fa3a1 Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 10:09:37 +0200 Subject: [PATCH 12/17] fix(query): add custom withDatasource function for most datasources --- custom/query/azureMonitor.libsonnet | 17 +++++ custom/query/cloudWatch.libsonnet | 23 +++++++ custom/query/googleCloudMonitoring.libsonnet | 17 +++++ custom/query/grafanaPyroscope.libsonnet | 17 +++++ custom/query/parca.libsonnet | 17 +++++ custom/query/testData.libsonnet | 17 +++++ docs/API/query/azureMonitor/index.md | 22 +------ docs/API/query/cloudWatch/index.md | 66 ++----------------- docs/API/query/googleCloudMonitoring.md | 22 +------ docs/API/query/grafanaPyroscope.md | 22 +------ docs/API/query/parca.md | 22 +------ docs/API/query/testData/index.md | 16 +---- .../custom/query/azureMonitor.libsonnet | 17 +++++ .../custom/query/cloudWatch.libsonnet | 23 +++++++ .../query/googleCloudMonitoring.libsonnet | 17 +++++ .../custom/query/grafanaPyroscope.libsonnet | 17 +++++ .../custom/query/parca.libsonnet | 17 +++++ .../custom/query/testData.libsonnet | 17 +++++ .../docs/query/azureMonitor/index.md | 22 +------ .../docs/query/cloudWatch/index.md | 66 ++----------------- .../docs/query/googleCloudMonitoring.md | 22 +------ .../docs/query/grafanaPyroscope.md | 22 +------ gen/grafonnet-v11.0.0/docs/query/parca.md | 22 +------ .../docs/query/testData/index.md | 16 +---- .../query/azureMonitor.libsonnet | 1 + .../query/cloudWatch.libsonnet | 1 + .../query/googleCloudMonitoring.libsonnet | 1 + .../query/grafanaPyroscope.libsonnet | 1 + gen/grafonnet-v11.0.0/query/parca.libsonnet | 1 + .../query/testData.libsonnet | 1 + generator/query.libsonnet | 20 ++++-- 31 files changed, 267 insertions(+), 315 deletions(-) create mode 100644 custom/query/azureMonitor.libsonnet create mode 100644 custom/query/cloudWatch.libsonnet create mode 100644 custom/query/googleCloudMonitoring.libsonnet create mode 100644 custom/query/grafanaPyroscope.libsonnet create mode 100644 custom/query/parca.libsonnet create mode 100644 custom/query/testData.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/parca.libsonnet create mode 100644 gen/grafonnet-v11.0.0/custom/query/testData.libsonnet diff --git a/custom/query/azureMonitor.libsonnet b/custom/query/azureMonitor.libsonnet new file mode 100644 index 00000000..89264496 --- /dev/null +++ b/custom/query/azureMonitor.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafana-azure-monitor-datasource', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/custom/query/cloudWatch.libsonnet b/custom/query/cloudWatch.libsonnet new file mode 100644 index 00000000..208ee652 --- /dev/null +++ b/custom/query/cloudWatch.libsonnet @@ -0,0 +1,23 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local withDatasourceStub = { + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloudwatch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, + }, + + CloudWatchAnnotationQuery+: withDatasourceStub, + CloudWatchLogsQuery+: withDatasourceStub, + CloudWatchMetricsQuery+: withDatasourceStub, +} diff --git a/custom/query/googleCloudMonitoring.libsonnet b/custom/query/googleCloudMonitoring.libsonnet new file mode 100644 index 00000000..1adaa99a --- /dev/null +++ b/custom/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloud-monitoring', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/custom/query/grafanaPyroscope.libsonnet b/custom/query/grafanaPyroscope.libsonnet new file mode 100644 index 00000000..2f528210 --- /dev/null +++ b/custom/query/grafanaPyroscope.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafanapyroscope', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/custom/query/parca.libsonnet b/custom/query/parca.libsonnet new file mode 100644 index 00000000..35c454ec --- /dev/null +++ b/custom/query/parca.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'parca', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/custom/query/testData.libsonnet b/custom/query/testData.libsonnet new file mode 100644 index 00000000..b482dbc9 --- /dev/null +++ b/custom/query/testData.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(): { + datasource+: { + type: 'datasource', + uid: 'grafana', + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/docs/API/query/azureMonitor/index.md b/docs/API/query/azureMonitor/index.md index 382a9afd..f60f70e1 100644 --- a/docs/API/query/azureMonitor/index.md +++ b/docs/API/query/azureMonitor/index.md @@ -19,7 +19,6 @@ grafonnet.query.azureMonitor * [`fn withAzureTraces(value)`](#fn-withazuretraces) * [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) * [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) * [`fn withHide(value=true)`](#fn-withhide) @@ -245,26 +244,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withGrafanaTemplateVariableFn ```jsonnet diff --git a/docs/API/query/cloudWatch/index.md b/docs/API/query/cloudWatch/index.md index eff3563f..71a7abec 100644 --- a/docs/API/query/cloudWatch/index.md +++ b/docs/API/query/cloudWatch/index.md @@ -16,7 +16,6 @@ grafonnet.query.cloudWatch * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-cloudwatchannotationquerywithdatasourcemixin) * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) @@ -34,7 +33,6 @@ grafonnet.query.cloudWatch * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) * [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-cloudwatchlogsquerywithdatasourcemixin) * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) @@ -52,7 +50,6 @@ grafonnet.query.cloudWatch * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-cloudwatchmetricsquerywithdatasourcemixin) * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) @@ -176,26 +173,9 @@ CloudWatchAnnotationQuery.withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -#### fn CloudWatchAnnotationQuery.withDatasourceMixin - -```jsonnet -CloudWatchAnnotationQuery.withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. #### fn CloudWatchAnnotationQuery.withDimensions ```jsonnet @@ -379,26 +359,9 @@ CloudWatchLogsQuery.withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -#### fn CloudWatchLogsQuery.withDatasourceMixin - -```jsonnet -CloudWatchLogsQuery.withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. #### fn CloudWatchLogsQuery.withExpression ```jsonnet @@ -581,26 +544,9 @@ CloudWatchMetricsQuery.withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -#### fn CloudWatchMetricsQuery.withDatasourceMixin - -```jsonnet -CloudWatchMetricsQuery.withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. #### fn CloudWatchMetricsQuery.withDimensions ```jsonnet diff --git a/docs/API/query/googleCloudMonitoring.md b/docs/API/query/googleCloudMonitoring.md index c711f29a..b728940f 100644 --- a/docs/API/query/googleCloudMonitoring.md +++ b/docs/API/query/googleCloudMonitoring.md @@ -6,7 +6,6 @@ grafonnet.query.googleCloudMonitoring * [`fn withAliasBy(value)`](#fn-withaliasby) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withIntervalMs(value)`](#fn-withintervalms) * [`fn withPromQLQuery(value)`](#fn-withpromqlquery) @@ -78,26 +77,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withHide ```jsonnet diff --git a/docs/API/query/grafanaPyroscope.md b/docs/API/query/grafanaPyroscope.md index 87b31d94..c150bba7 100644 --- a/docs/API/query/grafanaPyroscope.md +++ b/docs/API/query/grafanaPyroscope.md @@ -5,7 +5,6 @@ grafonnet.query.grafanaPyroscope ## Index * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withGroupBy(value)`](#fn-withgroupby) * [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) * [`fn withHide(value=true)`](#fn-withhide) @@ -27,26 +26,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withGroupBy ```jsonnet diff --git a/docs/API/query/parca.md b/docs/API/query/parca.md index 8046ea47..03c73bfe 100644 --- a/docs/API/query/parca.md +++ b/docs/API/query/parca.md @@ -5,7 +5,6 @@ grafonnet.query.parca ## Index * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) @@ -22,26 +21,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withHide ```jsonnet diff --git a/docs/API/query/testData/index.md b/docs/API/query/testData/index.md index d63b5ea9..f1c88286 100644 --- a/docs/API/query/testData/index.md +++ b/docs/API/query/testData/index.md @@ -15,7 +15,6 @@ grafonnet.query.testData * [`fn withCsvWave(value)`](#fn-withcsvwave) * [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withDropPercent(value)`](#fn-withdroppercent) * [`fn withErrorType(value)`](#fn-witherrortype) * [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) @@ -177,20 +176,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - - -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - +* **value** (`string`) +Set the datasource for this query. ### fn withDropPercent ```jsonnet diff --git a/gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet b/gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet new file mode 100644 index 00000000..89264496 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafana-azure-monitor-datasource', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet b/gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet new file mode 100644 index 00000000..208ee652 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet @@ -0,0 +1,23 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local withDatasourceStub = { + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloudwatch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, + }, + + CloudWatchAnnotationQuery+: withDatasourceStub, + CloudWatchLogsQuery+: withDatasourceStub, + CloudWatchMetricsQuery+: withDatasourceStub, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet b/gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet new file mode 100644 index 00000000..1adaa99a --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloud-monitoring', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet b/gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet new file mode 100644 index 00000000..2f528210 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafanapyroscope', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/parca.libsonnet b/gen/grafonnet-v11.0.0/custom/query/parca.libsonnet new file mode 100644 index 00000000..35c454ec --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/parca.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'parca', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/gen/grafonnet-v11.0.0/custom/query/testData.libsonnet b/gen/grafonnet-v11.0.0/custom/query/testData.libsonnet new file mode 100644 index 00000000..b482dbc9 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/testData.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(): { + datasource+: { + type: 'datasource', + uid: 'grafana', + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md index 382a9afd..f60f70e1 100644 --- a/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md @@ -19,7 +19,6 @@ grafonnet.query.azureMonitor * [`fn withAzureTraces(value)`](#fn-withazuretraces) * [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) * [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) * [`fn withHide(value=true)`](#fn-withhide) @@ -245,26 +244,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withGrafanaTemplateVariableFn ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md index eff3563f..71a7abec 100644 --- a/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md @@ -16,7 +16,6 @@ grafonnet.query.cloudWatch * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-cloudwatchannotationquerywithdatasourcemixin) * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) @@ -34,7 +33,6 @@ grafonnet.query.cloudWatch * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) * [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-cloudwatchlogsquerywithdatasourcemixin) * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) @@ -52,7 +50,6 @@ grafonnet.query.cloudWatch * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-cloudwatchmetricsquerywithdatasourcemixin) * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) @@ -176,26 +173,9 @@ CloudWatchAnnotationQuery.withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -#### fn CloudWatchAnnotationQuery.withDatasourceMixin - -```jsonnet -CloudWatchAnnotationQuery.withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. #### fn CloudWatchAnnotationQuery.withDimensions ```jsonnet @@ -379,26 +359,9 @@ CloudWatchLogsQuery.withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -#### fn CloudWatchLogsQuery.withDatasourceMixin - -```jsonnet -CloudWatchLogsQuery.withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. #### fn CloudWatchLogsQuery.withExpression ```jsonnet @@ -581,26 +544,9 @@ CloudWatchMetricsQuery.withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -#### fn CloudWatchMetricsQuery.withDatasourceMixin - -```jsonnet -CloudWatchMetricsQuery.withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. #### fn CloudWatchMetricsQuery.withDimensions ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md b/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md index c711f29a..b728940f 100644 --- a/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md +++ b/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md @@ -6,7 +6,6 @@ grafonnet.query.googleCloudMonitoring * [`fn withAliasBy(value)`](#fn-withaliasby) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withIntervalMs(value)`](#fn-withintervalms) * [`fn withPromQLQuery(value)`](#fn-withpromqlquery) @@ -78,26 +77,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withHide ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md b/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md index 87b31d94..c150bba7 100644 --- a/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md +++ b/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md @@ -5,7 +5,6 @@ grafonnet.query.grafanaPyroscope ## Index * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withGroupBy(value)`](#fn-withgroupby) * [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) * [`fn withHide(value=true)`](#fn-withhide) @@ -27,26 +26,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withGroupBy ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/query/parca.md b/gen/grafonnet-v11.0.0/docs/query/parca.md index 8046ea47..03c73bfe 100644 --- a/gen/grafonnet-v11.0.0/docs/query/parca.md +++ b/gen/grafonnet-v11.0.0/docs/query/parca.md @@ -5,7 +5,6 @@ grafonnet.query.parca ## Index * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) @@ -22,26 +21,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withHide ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/query/testData/index.md b/gen/grafonnet-v11.0.0/docs/query/testData/index.md index d63b5ea9..f1c88286 100644 --- a/gen/grafonnet-v11.0.0/docs/query/testData/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/testData/index.md @@ -15,7 +15,6 @@ grafonnet.query.testData * [`fn withCsvWave(value)`](#fn-withcsvwave) * [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withDropPercent(value)`](#fn-withdroppercent) * [`fn withErrorType(value)`](#fn-witherrortype) * [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) @@ -177,20 +176,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - - -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - +* **value** (`string`) +Set the datasource for this query. ### fn withDropPercent ```jsonnet diff --git a/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet b/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet index 13b4d100..0188b394 100644 --- a/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet +++ b/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet @@ -857,3 +857,4 @@ else [value]), }, } ++ (import '../custom/query/azureMonitor.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet b/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet index 21a8604e..fa54d6e1 100644 --- a/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet +++ b/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet @@ -690,3 +690,4 @@ }, }, } ++ (import '../custom/query/cloudWatch.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet b/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet index adc0e162..478a49cd 100644 --- a/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet +++ b/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet @@ -290,3 +290,4 @@ }, }, } ++ (import '../custom/query/googleCloudMonitoring.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet b/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet index 8c66a691..67a75664 100644 --- a/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet +++ b/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet @@ -62,3 +62,4 @@ else [value]), }, } ++ (import '../custom/query/grafanaPyroscope.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/parca.libsonnet b/gen/grafonnet-v11.0.0/query/parca.libsonnet index 8fc0e6a1..94f6f231 100644 --- a/gen/grafonnet-v11.0.0/query/parca.libsonnet +++ b/gen/grafonnet-v11.0.0/query/parca.libsonnet @@ -30,3 +30,4 @@ refId: value, }, } ++ (import '../custom/query/parca.libsonnet') diff --git a/gen/grafonnet-v11.0.0/query/testData.libsonnet b/gen/grafonnet-v11.0.0/query/testData.libsonnet index bd04f11f..a0bdee57 100644 --- a/gen/grafonnet-v11.0.0/query/testData.libsonnet +++ b/gen/grafonnet-v11.0.0/query/testData.libsonnet @@ -491,3 +491,4 @@ withNil: value, }, } ++ (import '../custom/query/testData.libsonnet') diff --git a/generator/query.libsonnet b/generator/query.libsonnet index 14efb47f..012f27c3 100644 --- a/generator/query.libsonnet +++ b/generator/query.libsonnet @@ -38,7 +38,7 @@ local utils = import './utils.libsonnet'; ), generateLib(schema): - local title = schema.info.title; + local title = std.get(root.titleMapping, std.asciiLower(schema.info.title), schema.info.title); local customSchema = schema { components+: { @@ -61,7 +61,7 @@ local utils = import './utils.libsonnet'; utils.addDoc( ast, - std.get(root.titleMapping, std.asciiLower(title), title), + title, 'query.' ).toString() + (if std.member(self.hasCustom, title) @@ -74,7 +74,7 @@ local utils = import './utils.libsonnet'; // FIXME: Some schemas follow a different structure, temporarily covering for this. local fixes = { - cloudwatch: { + cloudWatch: { dataquery: { type: 'object', oneOf: [ @@ -91,7 +91,7 @@ local utils = import './utils.libsonnet'; }, }, }, - azuremonitor: { + azureMonitor: { dataquery: { '$ref': '#/components/schemas/AzureMonitorQuery', }, @@ -101,12 +101,12 @@ local utils = import './utils.libsonnet'; '$ref': '#/components/schemas/TempoQuery', }, }, - googlecloudmonitoring: { + googleCloudMonitoring: { dataquery: { '$ref': '#/components/schemas/CloudMonitoringQuery', }, }, - testdata: { + testData: { dataquery+: { properties+: { // `points` is an array of arrays, this renders awkwardly with CRDsonnet @@ -144,9 +144,15 @@ local utils = import './utils.libsonnet'; ).toString(), hasCustom: [ + 'azureMonitor', + 'cloudWatch', + 'expr', + 'googleCloudMonitoring', + 'grafanaPyroscope', 'loki', + 'parca', 'prometheus', 'tempo', - 'expr', + 'testData', ], } From 87bb847696fc8d04f94587bc9000860f0a479fe1 Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 10:29:33 +0200 Subject: [PATCH 13/17] fix(elasticsearch): move subsections into docs packages --- custom/query/elasticsearch.libsonnet | 4 + .../query/elasticsearch/bucketAggs/index.md | 567 +++ docs/API/query/elasticsearch/index.md | 3103 +---------------- docs/API/query/elasticsearch/metrics/index.md | 2547 ++++++++++++++ .../custom/query/elasticsearch.libsonnet | 4 + .../query/elasticsearch/bucketAggs/index.md | 567 +++ .../docs/query/elasticsearch/index.md | 3103 +---------------- .../docs/query/elasticsearch/metrics/index.md | 2547 ++++++++++++++ .../query/elasticsearch.libsonnet | 1 + generator/query.libsonnet | 1 + 10 files changed, 6244 insertions(+), 6200 deletions(-) create mode 100644 custom/query/elasticsearch.libsonnet create mode 100644 docs/API/query/elasticsearch/bucketAggs/index.md create mode 100644 docs/API/query/elasticsearch/metrics/index.md create mode 100644 gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet create mode 100644 gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md create mode 100644 gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md diff --git a/custom/query/elasticsearch.libsonnet b/custom/query/elasticsearch.libsonnet new file mode 100644 index 00000000..e4f71117 --- /dev/null +++ b/custom/query/elasticsearch.libsonnet @@ -0,0 +1,4 @@ +{ + bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, + metrics+: { '#': { help: '', name: 'metrics' } }, +} diff --git a/docs/API/query/elasticsearch/bucketAggs/index.md b/docs/API/query/elasticsearch/bucketAggs/index.md new file mode 100644 index 00000000..f98cbdea --- /dev/null +++ b/docs/API/query/elasticsearch/bucketAggs/index.md @@ -0,0 +1,567 @@ +# bucketAggs + + + +## Subpackages + +* [Filters.settings.filters](Filters/settings/filters.md) + +## Index + +* [`obj DateHistogram`](#obj-datehistogram) + * [`fn withField(value)`](#fn-datehistogramwithfield) + * [`fn withId(value)`](#fn-datehistogramwithid) + * [`fn withSettings(value)`](#fn-datehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-datehistogramwithsettingsmixin) + * [`fn withType()`](#fn-datehistogramwithtype) + * [`obj settings`](#obj-datehistogramsettings) + * [`fn withInterval(value)`](#fn-datehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-datehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-datehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-datehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-datehistogramsettingswithtrimedges) +* [`obj Filters`](#obj-filters) + * [`fn withId(value)`](#fn-filterswithid) + * [`fn withSettings(value)`](#fn-filterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-filterswithsettingsmixin) + * [`fn withType()`](#fn-filterswithtype) + * [`obj settings`](#obj-filterssettings) + * [`fn withFilters(value)`](#fn-filterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-filterssettingswithfiltersmixin) +* [`obj GeoHashGrid`](#obj-geohashgrid) + * [`fn withField(value)`](#fn-geohashgridwithfield) + * [`fn withId(value)`](#fn-geohashgridwithid) + * [`fn withSettings(value)`](#fn-geohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-geohashgridwithsettingsmixin) + * [`fn withType()`](#fn-geohashgridwithtype) + * [`obj settings`](#obj-geohashgridsettings) + * [`fn withPrecision(value)`](#fn-geohashgridsettingswithprecision) +* [`obj Histogram`](#obj-histogram) + * [`fn withField(value)`](#fn-histogramwithfield) + * [`fn withId(value)`](#fn-histogramwithid) + * [`fn withSettings(value)`](#fn-histogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-histogramwithsettingsmixin) + * [`fn withType()`](#fn-histogramwithtype) + * [`obj settings`](#obj-histogramsettings) + * [`fn withInterval(value)`](#fn-histogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-histogramsettingswithmindoccount) +* [`obj Nested`](#obj-nested) + * [`fn withField(value)`](#fn-nestedwithfield) + * [`fn withId(value)`](#fn-nestedwithid) + * [`fn withSettings(value)`](#fn-nestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-nestedwithsettingsmixin) + * [`fn withType()`](#fn-nestedwithtype) +* [`obj Terms`](#obj-terms) + * [`fn withField(value)`](#fn-termswithfield) + * [`fn withId(value)`](#fn-termswithid) + * [`fn withSettings(value)`](#fn-termswithsettings) + * [`fn withSettingsMixin(value)`](#fn-termswithsettingsmixin) + * [`fn withType()`](#fn-termswithtype) + * [`obj settings`](#obj-termssettings) + * [`fn withMinDocCount(value)`](#fn-termssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-termssettingswithmissing) + * [`fn withOrder(value)`](#fn-termssettingswithorder) + * [`fn withOrderBy(value)`](#fn-termssettingswithorderby) + * [`fn withSize(value)`](#fn-termssettingswithsize) + +## Fields + +### obj DateHistogram + + +#### fn DateHistogram.withField + +```jsonnet +DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withId + +```jsonnet +DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withSettings + +```jsonnet +DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withSettingsMixin + +```jsonnet +DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withType + +```jsonnet +DateHistogram.withType() +``` + + + +#### obj DateHistogram.settings + + +##### fn DateHistogram.settings.withInterval + +```jsonnet +DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withMinDocCount + +```jsonnet +DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withOffset + +```jsonnet +DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTimeZone + +```jsonnet +DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTrimEdges + +```jsonnet +DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Filters + + +#### fn Filters.withId + +```jsonnet +Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Filters.withSettings + +```jsonnet +Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withSettingsMixin + +```jsonnet +Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withType + +```jsonnet +Filters.withType() +``` + + + +#### obj Filters.settings + + +##### fn Filters.settings.withFilters + +```jsonnet +Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn Filters.settings.withFiltersMixin + +```jsonnet +Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj GeoHashGrid + + +#### fn GeoHashGrid.withField + +```jsonnet +GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withId + +```jsonnet +GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withSettings + +```jsonnet +GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withSettingsMixin + +```jsonnet +GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withType + +```jsonnet +GeoHashGrid.withType() +``` + + + +#### obj GeoHashGrid.settings + + +##### fn GeoHashGrid.settings.withPrecision + +```jsonnet +GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Histogram + + +#### fn Histogram.withField + +```jsonnet +Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withId + +```jsonnet +Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withSettings + +```jsonnet +Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withSettingsMixin + +```jsonnet +Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withType + +```jsonnet +Histogram.withType() +``` + + + +#### obj Histogram.settings + + +##### fn Histogram.settings.withInterval + +```jsonnet +Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Histogram.settings.withMinDocCount + +```jsonnet +Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Nested + + +#### fn Nested.withField + +```jsonnet +Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withId + +```jsonnet +Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withSettings + +```jsonnet +Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withSettingsMixin + +```jsonnet +Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withType + +```jsonnet +Nested.withType() +``` + + + +### obj Terms + + +#### fn Terms.withField + +```jsonnet +Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withId + +```jsonnet +Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withSettings + +```jsonnet +Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withSettingsMixin + +```jsonnet +Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withType + +```jsonnet +Terms.withType() +``` + + + +#### obj Terms.settings + + +##### fn Terms.settings.withMinDocCount + +```jsonnet +Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withMissing + +```jsonnet +Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withOrder + +```jsonnet +Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +##### fn Terms.settings.withOrderBy + +```jsonnet +Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withSize + +```jsonnet +Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/API/query/elasticsearch/index.md b/docs/API/query/elasticsearch/index.md index a003cf53..f613269c 100644 --- a/docs/API/query/elasticsearch/index.md +++ b/docs/API/query/elasticsearch/index.md @@ -4,9 +4,8 @@ grafonnet.query.elasticsearch ## Subpackages -* [bucketAggs.Filters.settings.filters](bucketAggs/Filters/settings/filters.md) -* [metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables](metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md) -* [metrics.PipelineMetricAggregation.BucketScript.pipelineVariables](metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md) +* [bucketAggs](bucketAggs/index.md) +* [metrics](metrics/index.md) ## Index @@ -22,314 +21,6 @@ grafonnet.query.elasticsearch * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) * [`fn withTimeField(value)`](#fn-withtimefield) -* [`obj bucketAggs`](#obj-bucketaggs) - * [`obj DateHistogram`](#obj-bucketaggsdatehistogram) - * [`fn withField(value)`](#fn-bucketaggsdatehistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggsdatehistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggsdatehistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsdatehistogramwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsdatehistogramwithtype) - * [`obj settings`](#obj-bucketaggsdatehistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggsdatehistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggsdatehistogramsettingswithmindoccount) - * [`fn withOffset(value)`](#fn-bucketaggsdatehistogramsettingswithoffset) - * [`fn withTimeZone(value)`](#fn-bucketaggsdatehistogramsettingswithtimezone) - * [`fn withTrimEdges(value)`](#fn-bucketaggsdatehistogramsettingswithtrimedges) - * [`obj Filters`](#obj-bucketaggsfilters) - * [`fn withId(value)`](#fn-bucketaggsfilterswithid) - * [`fn withSettings(value)`](#fn-bucketaggsfilterswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsfilterswithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsfilterswithtype) - * [`obj settings`](#obj-bucketaggsfilterssettings) - * [`fn withFilters(value)`](#fn-bucketaggsfilterssettingswithfilters) - * [`fn withFiltersMixin(value)`](#fn-bucketaggsfilterssettingswithfiltersmixin) - * [`obj GeoHashGrid`](#obj-bucketaggsgeohashgrid) - * [`fn withField(value)`](#fn-bucketaggsgeohashgridwithfield) - * [`fn withId(value)`](#fn-bucketaggsgeohashgridwithid) - * [`fn withSettings(value)`](#fn-bucketaggsgeohashgridwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsgeohashgridwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsgeohashgridwithtype) - * [`obj settings`](#obj-bucketaggsgeohashgridsettings) - * [`fn withPrecision(value)`](#fn-bucketaggsgeohashgridsettingswithprecision) - * [`obj Histogram`](#obj-bucketaggshistogram) - * [`fn withField(value)`](#fn-bucketaggshistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggshistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggshistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggshistogramwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggshistogramwithtype) - * [`obj settings`](#obj-bucketaggshistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggshistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggshistogramsettingswithmindoccount) - * [`obj Nested`](#obj-bucketaggsnested) - * [`fn withField(value)`](#fn-bucketaggsnestedwithfield) - * [`fn withId(value)`](#fn-bucketaggsnestedwithid) - * [`fn withSettings(value)`](#fn-bucketaggsnestedwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsnestedwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsnestedwithtype) - * [`obj Terms`](#obj-bucketaggsterms) - * [`fn withField(value)`](#fn-bucketaggstermswithfield) - * [`fn withId(value)`](#fn-bucketaggstermswithid) - * [`fn withSettings(value)`](#fn-bucketaggstermswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggstermswithsettingsmixin) - * [`fn withType()`](#fn-bucketaggstermswithtype) - * [`obj settings`](#obj-bucketaggstermssettings) - * [`fn withMinDocCount(value)`](#fn-bucketaggstermssettingswithmindoccount) - * [`fn withMissing(value)`](#fn-bucketaggstermssettingswithmissing) - * [`fn withOrder(value)`](#fn-bucketaggstermssettingswithorder) - * [`fn withOrderBy(value)`](#fn-bucketaggstermssettingswithorderby) - * [`fn withSize(value)`](#fn-bucketaggstermssettingswithsize) -* [`obj metrics`](#obj-metrics) - * [`obj Count`](#obj-metricscount) - * [`fn withHide(value=true)`](#fn-metricscountwithhide) - * [`fn withId(value)`](#fn-metricscountwithid) - * [`fn withType()`](#fn-metricscountwithtype) - * [`obj MetricAggregationWithSettings`](#obj-metricsmetricaggregationwithsettings) - * [`obj Average`](#obj-metricsmetricaggregationwithsettingsaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsaveragewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsaveragesettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsaveragesettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingsscriptwithinline) - * [`obj BucketScript`](#obj-metricsmetricaggregationwithsettingsbucketscript) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricsmetricaggregationwithsettingscumulativesum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingscumulativesumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingscumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricsmetricaggregationwithsettingsderivative) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsderivativewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsderivativewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsderivativesettings) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsderivativesettingswithunit) - * [`obj ExtendedStats`](#obj-metricsmetricaggregationwithsettingsextendedstats) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithid) - * [`fn withMeta(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmeta) - * [`fn withMetaMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmetamixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsextendedstatswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsextendedstatssettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscriptmixin) - * [`fn withSigma(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithsigma) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsextendedstatssettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingsscriptwithinline) - * [`obj Logs`](#obj-metricsmetricaggregationwithsettingslogs) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingslogswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingslogswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingslogswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingslogssettings) - * [`fn withLimit(value)`](#fn-metricsmetricaggregationwithsettingslogssettingswithlimit) - * [`obj Max`](#obj-metricsmetricaggregationwithsettingsmax) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmaxwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmaxwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmaxsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmaxsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingsscriptwithinline) - * [`obj Min`](#obj-metricsmetricaggregationwithsettingsmin) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsminwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsminwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsminwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsminwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsminsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsminsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsminsettingsscriptwithinline) - * [`obj MovingAverage`](#obj-metricsmetricaggregationwithsettingsmovingaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithtype) - * [`obj MovingFunction`](#obj-metricsmetricaggregationwithsettingsmovingfunction) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) - * [`fn withShift(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithshift) - * [`fn withWindow(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithwindow) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) - * [`obj Percentiles`](#obj-metricsmetricaggregationwithsettingspercentiles) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingspercentileswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingspercentileswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingspercentilessettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithmissing) - * [`fn withPercents(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercents) - * [`fn withPercentsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercentsmixin) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingspercentilessettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingsscriptwithinline) - * [`obj Rate`](#obj-metricsmetricaggregationwithsettingsrate) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsratewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsratewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsratewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsratewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsratesettings) - * [`fn withMode(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithmode) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithunit) - * [`obj RawData`](#obj-metricsmetricaggregationwithsettingsrawdata) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdatawithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdatawithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdatasettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdatasettingswithsize) - * [`obj RawDocument`](#obj-metricsmetricaggregationwithsettingsrawdocument) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdocumentsettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentsettingswithsize) - * [`obj SerialDiff`](#obj-metricsmetricaggregationwithsettingsserialdiff) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsserialdiffwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsserialdiffsettings) - * [`fn withLag(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffsettingswithlag) - * [`obj Sum`](#obj-metricsmetricaggregationwithsettingssum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingssumwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingssumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingssumwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingssumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingssumsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingssumsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingssumsettingsscriptwithinline) - * [`obj TopMetrics`](#obj-metricsmetricaggregationwithsettingstopmetrics) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingstopmetricswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingstopmetricswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingstopmetricssettings) - * [`fn withMetrics(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetrics) - * [`fn withMetricsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetricsmixin) - * [`fn withOrder(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorder) - * [`fn withOrderBy(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorderby) - * [`obj UniqueCount`](#obj-metricsmetricaggregationwithsettingsuniquecount) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsuniquecountwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsuniquecountsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithmissing) - * [`fn withPrecisionThreshold(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) - * [`obj PipelineMetricAggregation`](#obj-metricspipelinemetricaggregation) - * [`obj BucketScript`](#obj-metricspipelinemetricaggregationbucketscript) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationbucketscriptwithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricspipelinemetricaggregationbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricspipelinemetricaggregationcumulativesum) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithfield) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationcumulativesumwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationcumulativesumwithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationcumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricspipelinemetricaggregationcumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricspipelinemetricaggregationderivative) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationderivativewithfield) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationderivativewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationderivativewithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationderivativewithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationderivativesettings) - * [`fn withUnit(value)`](#fn-metricspipelinemetricaggregationderivativesettingswithunit) - * [`obj MovingAverage`](#obj-metricspipelinemetricaggregationmovingaverage) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationmovingaveragewithtype) ## Fields @@ -474,2792 +165,4 @@ PARAMETERS: * **value** (`string`) -Name of time field -### obj bucketAggs - - -#### obj bucketAggs.DateHistogram - - -##### fn bucketAggs.DateHistogram.withField - -```jsonnet -bucketAggs.DateHistogram.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.DateHistogram.withId - -```jsonnet -bucketAggs.DateHistogram.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.DateHistogram.withSettings - -```jsonnet -bucketAggs.DateHistogram.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.DateHistogram.withSettingsMixin - -```jsonnet -bucketAggs.DateHistogram.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.DateHistogram.withType - -```jsonnet -bucketAggs.DateHistogram.withType() -``` - - - -##### obj bucketAggs.DateHistogram.settings - - -###### fn bucketAggs.DateHistogram.settings.withInterval - -```jsonnet -bucketAggs.DateHistogram.settings.withInterval(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withMinDocCount - -```jsonnet -bucketAggs.DateHistogram.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withOffset - -```jsonnet -bucketAggs.DateHistogram.settings.withOffset(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withTimeZone - -```jsonnet -bucketAggs.DateHistogram.settings.withTimeZone(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withTrimEdges - -```jsonnet -bucketAggs.DateHistogram.settings.withTrimEdges(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj bucketAggs.Filters - - -##### fn bucketAggs.Filters.withId - -```jsonnet -bucketAggs.Filters.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Filters.withSettings - -```jsonnet -bucketAggs.Filters.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Filters.withSettingsMixin - -```jsonnet -bucketAggs.Filters.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Filters.withType - -```jsonnet -bucketAggs.Filters.withType() -``` - - - -##### obj bucketAggs.Filters.settings - - -###### fn bucketAggs.Filters.settings.withFilters - -```jsonnet -bucketAggs.Filters.settings.withFilters(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn bucketAggs.Filters.settings.withFiltersMixin - -```jsonnet -bucketAggs.Filters.settings.withFiltersMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -#### obj bucketAggs.GeoHashGrid - - -##### fn bucketAggs.GeoHashGrid.withField - -```jsonnet -bucketAggs.GeoHashGrid.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.GeoHashGrid.withId - -```jsonnet -bucketAggs.GeoHashGrid.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.GeoHashGrid.withSettings - -```jsonnet -bucketAggs.GeoHashGrid.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.GeoHashGrid.withSettingsMixin - -```jsonnet -bucketAggs.GeoHashGrid.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.GeoHashGrid.withType - -```jsonnet -bucketAggs.GeoHashGrid.withType() -``` - - - -##### obj bucketAggs.GeoHashGrid.settings - - -###### fn bucketAggs.GeoHashGrid.settings.withPrecision - -```jsonnet -bucketAggs.GeoHashGrid.settings.withPrecision(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj bucketAggs.Histogram - - -##### fn bucketAggs.Histogram.withField - -```jsonnet -bucketAggs.Histogram.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Histogram.withId - -```jsonnet -bucketAggs.Histogram.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Histogram.withSettings - -```jsonnet -bucketAggs.Histogram.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Histogram.withSettingsMixin - -```jsonnet -bucketAggs.Histogram.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Histogram.withType - -```jsonnet -bucketAggs.Histogram.withType() -``` - - - -##### obj bucketAggs.Histogram.settings - - -###### fn bucketAggs.Histogram.settings.withInterval - -```jsonnet -bucketAggs.Histogram.settings.withInterval(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Histogram.settings.withMinDocCount - -```jsonnet -bucketAggs.Histogram.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj bucketAggs.Nested - - -##### fn bucketAggs.Nested.withField - -```jsonnet -bucketAggs.Nested.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Nested.withId - -```jsonnet -bucketAggs.Nested.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Nested.withSettings - -```jsonnet -bucketAggs.Nested.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Nested.withSettingsMixin - -```jsonnet -bucketAggs.Nested.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Nested.withType - -```jsonnet -bucketAggs.Nested.withType() -``` - - - -#### obj bucketAggs.Terms - - -##### fn bucketAggs.Terms.withField - -```jsonnet -bucketAggs.Terms.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Terms.withId - -```jsonnet -bucketAggs.Terms.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Terms.withSettings - -```jsonnet -bucketAggs.Terms.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Terms.withSettingsMixin - -```jsonnet -bucketAggs.Terms.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Terms.withType - -```jsonnet -bucketAggs.Terms.withType() -``` - - - -##### obj bucketAggs.Terms.settings - - -###### fn bucketAggs.Terms.settings.withMinDocCount - -```jsonnet -bucketAggs.Terms.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Terms.settings.withMissing - -```jsonnet -bucketAggs.Terms.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Terms.settings.withOrder - -```jsonnet -bucketAggs.Terms.settings.withOrder(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"desc"`, `"asc"` - - -###### fn bucketAggs.Terms.settings.withOrderBy - -```jsonnet -bucketAggs.Terms.settings.withOrderBy(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Terms.settings.withSize - -```jsonnet -bucketAggs.Terms.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj metrics - - -#### obj metrics.Count - - -##### fn metrics.Count.withHide - -```jsonnet -metrics.Count.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn metrics.Count.withId - -```jsonnet -metrics.Count.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn metrics.Count.withType - -```jsonnet -metrics.Count.withType() -``` - - - -#### obj metrics.MetricAggregationWithSettings - - -##### obj metrics.MetricAggregationWithSettings.Average - - -###### fn metrics.MetricAggregationWithSettings.Average.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Average.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Average.settings - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Average.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Average.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.BucketScript - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withId - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withType - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.BucketScript.settings - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.BucketScript.settings.script - - -######## fn metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.CumulativeSum - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withField - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withId - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withType - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.CumulativeSum.settings - - -####### fn metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Derivative - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Derivative.settings - - -####### fn metrics.MetricAggregationWithSettings.Derivative.settings.withUnit - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.ExtendedStats - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withField - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withId - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMeta - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withMeta(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withType - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings.script - - -######## fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Logs - - -###### fn metrics.MetricAggregationWithSettings.Logs.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Logs.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Logs.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Logs.settings - - -####### fn metrics.MetricAggregationWithSettings.Logs.settings.withLimit - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.settings.withLimit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Max - - -###### fn metrics.MetricAggregationWithSettings.Max.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Max.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Max.settings - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Max.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Max.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Min - - -###### fn metrics.MetricAggregationWithSettings.Min.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Min.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Min.settings - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Min.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Min.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.MovingAverage - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withField - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withId - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withType - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withType() -``` - - - -##### obj metrics.MetricAggregationWithSettings.MovingFunction - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withField - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withId - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withType - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.MovingFunction.settings - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### obj metrics.MetricAggregationWithSettings.MovingFunction.settings.script - - -######## fn metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Percentiles - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Percentiles.settings - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Percentiles.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Rate - - -###### fn metrics.MetricAggregationWithSettings.Rate.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Rate.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Rate.settings - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withMode - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.settings.withMode(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withUnit - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.RawData - - -###### fn metrics.MetricAggregationWithSettings.RawData.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.RawData.withId - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawData.withType - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawData.settings - - -####### fn metrics.MetricAggregationWithSettings.RawData.settings.withSize - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.RawDocument - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withId - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withType - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawDocument.settings - - -####### fn metrics.MetricAggregationWithSettings.RawDocument.settings.withSize - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.SerialDiff - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withField - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withId - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withType - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.SerialDiff.settings - - -####### fn metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Sum - - -###### fn metrics.MetricAggregationWithSettings.Sum.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Sum.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Sum.settings - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Sum.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Sum.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.TopMetrics - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withId - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withType - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.TopMetrics.settings - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.UniqueCount - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withField - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withId - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withType - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.UniqueCount.settings - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj metrics.PipelineMetricAggregation - - -##### obj metrics.PipelineMetricAggregation.BucketScript - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withHide - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withId - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withType - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withType() -``` - - - -###### obj metrics.PipelineMetricAggregation.BucketScript.settings - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScript - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.PipelineMetricAggregation.BucketScript.settings.script - - -######## fn metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.PipelineMetricAggregation.CumulativeSum - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withField - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withHide - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withId - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withType - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withType() -``` - - - -###### obj metrics.PipelineMetricAggregation.CumulativeSum.settings - - -####### fn metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.PipelineMetricAggregation.Derivative - - -###### fn metrics.PipelineMetricAggregation.Derivative.withField - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withHide - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.Derivative.withId - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withPipelineAgg - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withType - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withType() -``` - - - -###### obj metrics.PipelineMetricAggregation.Derivative.settings - - -####### fn metrics.PipelineMetricAggregation.Derivative.settings.withUnit - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.PipelineMetricAggregation.MovingAverage - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withField - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withHide - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withId - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withType - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withType() -``` - - +Name of time field \ No newline at end of file diff --git a/docs/API/query/elasticsearch/metrics/index.md b/docs/API/query/elasticsearch/metrics/index.md new file mode 100644 index 00000000..fc18efe3 --- /dev/null +++ b/docs/API/query/elasticsearch/metrics/index.md @@ -0,0 +1,2547 @@ +# metrics + + + +## Subpackages + +* [MetricAggregationWithSettings.BucketScript.pipelineVariables](MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [PipelineMetricAggregation.BucketScript.pipelineVariables](PipelineMetricAggregation/BucketScript/pipelineVariables.md) + +## Index + +* [`obj Count`](#obj-count) + * [`fn withHide(value=true)`](#fn-countwithhide) + * [`fn withId(value)`](#fn-countwithid) + * [`fn withType()`](#fn-countwithtype) +* [`obj MetricAggregationWithSettings`](#obj-metricaggregationwithsettings) + * [`obj Average`](#obj-metricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) +* [`obj PipelineMetricAggregation`](#obj-pipelinemetricaggregation) + * [`obj BucketScript`](#obj-pipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-pipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-pipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-pipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-pipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-pipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-pipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-pipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-pipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-pipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-pipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-pipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationmovingaveragewithtype) + +## Fields + +### obj Count + + +#### fn Count.withHide + +```jsonnet +Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn Count.withId + +```jsonnet +Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Count.withType + +```jsonnet +Count.withType() +``` + + + +### obj MetricAggregationWithSettings + + +#### obj MetricAggregationWithSettings.Average + + +##### fn MetricAggregationWithSettings.Average.withField + +```jsonnet +MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withHide + +```jsonnet +MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Average.withId + +```jsonnet +MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withSettings + +```jsonnet +MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withType + +```jsonnet +MetricAggregationWithSettings.Average.withType() +``` + + + +##### obj MetricAggregationWithSettings.Average.settings + + +###### fn MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Average.settings.script + + +####### fn MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.BucketScript + + +##### fn MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +MetricAggregationWithSettings.BucketScript.withType() +``` + + + +##### obj MetricAggregationWithSettings.BucketScript.settings + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.BucketScript.settings.script + + +####### fn MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.CumulativeSum + + +##### fn MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withType() +``` + + + +##### obj MetricAggregationWithSettings.CumulativeSum.settings + + +###### fn MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Derivative + + +##### fn MetricAggregationWithSettings.Derivative.withField + +```jsonnet +MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Derivative.withId + +```jsonnet +MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withType + +```jsonnet +MetricAggregationWithSettings.Derivative.withType() +``` + + + +##### obj MetricAggregationWithSettings.Derivative.settings + + +###### fn MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.ExtendedStats + + +##### fn MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withType() +``` + + + +##### obj MetricAggregationWithSettings.ExtendedStats.settings + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.ExtendedStats.settings.script + + +####### fn MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Logs + + +##### fn MetricAggregationWithSettings.Logs.withHide + +```jsonnet +MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Logs.withId + +```jsonnet +MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withType + +```jsonnet +MetricAggregationWithSettings.Logs.withType() +``` + + + +##### obj MetricAggregationWithSettings.Logs.settings + + +###### fn MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Max + + +##### fn MetricAggregationWithSettings.Max.withField + +```jsonnet +MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withHide + +```jsonnet +MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Max.withId + +```jsonnet +MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withSettings + +```jsonnet +MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withType + +```jsonnet +MetricAggregationWithSettings.Max.withType() +``` + + + +##### obj MetricAggregationWithSettings.Max.settings + + +###### fn MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Max.settings.script + + +####### fn MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Min + + +##### fn MetricAggregationWithSettings.Min.withField + +```jsonnet +MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withHide + +```jsonnet +MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Min.withId + +```jsonnet +MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withSettings + +```jsonnet +MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withType + +```jsonnet +MetricAggregationWithSettings.Min.withType() +``` + + + +##### obj MetricAggregationWithSettings.Min.settings + + +###### fn MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Min.settings.script + + +####### fn MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.MovingAverage + + +##### fn MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withType() +``` + + + +#### obj MetricAggregationWithSettings.MovingFunction + + +##### fn MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withType() +``` + + + +##### obj MetricAggregationWithSettings.MovingFunction.settings + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.MovingFunction.settings.script + + +####### fn MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Percentiles + + +##### fn MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +MetricAggregationWithSettings.Percentiles.withType() +``` + + + +##### obj MetricAggregationWithSettings.Percentiles.settings + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Percentiles.settings.script + + +####### fn MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Rate + + +##### fn MetricAggregationWithSettings.Rate.withField + +```jsonnet +MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withHide + +```jsonnet +MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Rate.withId + +```jsonnet +MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withType + +```jsonnet +MetricAggregationWithSettings.Rate.withType() +``` + + + +##### obj MetricAggregationWithSettings.Rate.settings + + +###### fn MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawData + + +##### fn MetricAggregationWithSettings.RawData.withHide + +```jsonnet +MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawData.withId + +```jsonnet +MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withType + +```jsonnet +MetricAggregationWithSettings.RawData.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawData.settings + + +###### fn MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawDocument + + +##### fn MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +MetricAggregationWithSettings.RawDocument.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawDocument.settings + + +###### fn MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.SerialDiff + + +##### fn MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withType() +``` + + + +##### obj MetricAggregationWithSettings.SerialDiff.settings + + +###### fn MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Sum + + +##### fn MetricAggregationWithSettings.Sum.withField + +```jsonnet +MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withHide + +```jsonnet +MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Sum.withId + +```jsonnet +MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withType + +```jsonnet +MetricAggregationWithSettings.Sum.withType() +``` + + + +##### obj MetricAggregationWithSettings.Sum.settings + + +###### fn MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Sum.settings.script + + +####### fn MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.TopMetrics + + +##### fn MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withType() +``` + + + +##### obj MetricAggregationWithSettings.TopMetrics.settings + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.UniqueCount + + +##### fn MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withType() +``` + + + +##### obj MetricAggregationWithSettings.UniqueCount.settings + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj PipelineMetricAggregation + + +#### obj PipelineMetricAggregation.BucketScript + + +##### fn PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.BucketScript.withId + +```jsonnet +PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withType + +```jsonnet +PipelineMetricAggregation.BucketScript.withType() +``` + + + +##### obj PipelineMetricAggregation.BucketScript.settings + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj PipelineMetricAggregation.BucketScript.settings.script + + +####### fn PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.CumulativeSum + + +##### fn PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withType() +``` + + + +##### obj PipelineMetricAggregation.CumulativeSum.settings + + +###### fn PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.Derivative + + +##### fn PipelineMetricAggregation.Derivative.withField + +```jsonnet +PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withHide + +```jsonnet +PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.Derivative.withId + +```jsonnet +PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withType + +```jsonnet +PipelineMetricAggregation.Derivative.withType() +``` + + + +##### obj PipelineMetricAggregation.Derivative.settings + + +###### fn PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.MovingAverage + + +##### fn PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +PipelineMetricAggregation.MovingAverage.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet b/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet new file mode 100644 index 00000000..e4f71117 --- /dev/null +++ b/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet @@ -0,0 +1,4 @@ +{ + bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, + metrics+: { '#': { help: '', name: 'metrics' } }, +} diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md new file mode 100644 index 00000000..f98cbdea --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md @@ -0,0 +1,567 @@ +# bucketAggs + + + +## Subpackages + +* [Filters.settings.filters](Filters/settings/filters.md) + +## Index + +* [`obj DateHistogram`](#obj-datehistogram) + * [`fn withField(value)`](#fn-datehistogramwithfield) + * [`fn withId(value)`](#fn-datehistogramwithid) + * [`fn withSettings(value)`](#fn-datehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-datehistogramwithsettingsmixin) + * [`fn withType()`](#fn-datehistogramwithtype) + * [`obj settings`](#obj-datehistogramsettings) + * [`fn withInterval(value)`](#fn-datehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-datehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-datehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-datehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-datehistogramsettingswithtrimedges) +* [`obj Filters`](#obj-filters) + * [`fn withId(value)`](#fn-filterswithid) + * [`fn withSettings(value)`](#fn-filterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-filterswithsettingsmixin) + * [`fn withType()`](#fn-filterswithtype) + * [`obj settings`](#obj-filterssettings) + * [`fn withFilters(value)`](#fn-filterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-filterssettingswithfiltersmixin) +* [`obj GeoHashGrid`](#obj-geohashgrid) + * [`fn withField(value)`](#fn-geohashgridwithfield) + * [`fn withId(value)`](#fn-geohashgridwithid) + * [`fn withSettings(value)`](#fn-geohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-geohashgridwithsettingsmixin) + * [`fn withType()`](#fn-geohashgridwithtype) + * [`obj settings`](#obj-geohashgridsettings) + * [`fn withPrecision(value)`](#fn-geohashgridsettingswithprecision) +* [`obj Histogram`](#obj-histogram) + * [`fn withField(value)`](#fn-histogramwithfield) + * [`fn withId(value)`](#fn-histogramwithid) + * [`fn withSettings(value)`](#fn-histogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-histogramwithsettingsmixin) + * [`fn withType()`](#fn-histogramwithtype) + * [`obj settings`](#obj-histogramsettings) + * [`fn withInterval(value)`](#fn-histogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-histogramsettingswithmindoccount) +* [`obj Nested`](#obj-nested) + * [`fn withField(value)`](#fn-nestedwithfield) + * [`fn withId(value)`](#fn-nestedwithid) + * [`fn withSettings(value)`](#fn-nestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-nestedwithsettingsmixin) + * [`fn withType()`](#fn-nestedwithtype) +* [`obj Terms`](#obj-terms) + * [`fn withField(value)`](#fn-termswithfield) + * [`fn withId(value)`](#fn-termswithid) + * [`fn withSettings(value)`](#fn-termswithsettings) + * [`fn withSettingsMixin(value)`](#fn-termswithsettingsmixin) + * [`fn withType()`](#fn-termswithtype) + * [`obj settings`](#obj-termssettings) + * [`fn withMinDocCount(value)`](#fn-termssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-termssettingswithmissing) + * [`fn withOrder(value)`](#fn-termssettingswithorder) + * [`fn withOrderBy(value)`](#fn-termssettingswithorderby) + * [`fn withSize(value)`](#fn-termssettingswithsize) + +## Fields + +### obj DateHistogram + + +#### fn DateHistogram.withField + +```jsonnet +DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withId + +```jsonnet +DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withSettings + +```jsonnet +DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withSettingsMixin + +```jsonnet +DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withType + +```jsonnet +DateHistogram.withType() +``` + + + +#### obj DateHistogram.settings + + +##### fn DateHistogram.settings.withInterval + +```jsonnet +DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withMinDocCount + +```jsonnet +DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withOffset + +```jsonnet +DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTimeZone + +```jsonnet +DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTrimEdges + +```jsonnet +DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Filters + + +#### fn Filters.withId + +```jsonnet +Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Filters.withSettings + +```jsonnet +Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withSettingsMixin + +```jsonnet +Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withType + +```jsonnet +Filters.withType() +``` + + + +#### obj Filters.settings + + +##### fn Filters.settings.withFilters + +```jsonnet +Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn Filters.settings.withFiltersMixin + +```jsonnet +Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj GeoHashGrid + + +#### fn GeoHashGrid.withField + +```jsonnet +GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withId + +```jsonnet +GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withSettings + +```jsonnet +GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withSettingsMixin + +```jsonnet +GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withType + +```jsonnet +GeoHashGrid.withType() +``` + + + +#### obj GeoHashGrid.settings + + +##### fn GeoHashGrid.settings.withPrecision + +```jsonnet +GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Histogram + + +#### fn Histogram.withField + +```jsonnet +Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withId + +```jsonnet +Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withSettings + +```jsonnet +Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withSettingsMixin + +```jsonnet +Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withType + +```jsonnet +Histogram.withType() +``` + + + +#### obj Histogram.settings + + +##### fn Histogram.settings.withInterval + +```jsonnet +Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Histogram.settings.withMinDocCount + +```jsonnet +Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Nested + + +#### fn Nested.withField + +```jsonnet +Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withId + +```jsonnet +Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withSettings + +```jsonnet +Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withSettingsMixin + +```jsonnet +Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withType + +```jsonnet +Nested.withType() +``` + + + +### obj Terms + + +#### fn Terms.withField + +```jsonnet +Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withId + +```jsonnet +Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withSettings + +```jsonnet +Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withSettingsMixin + +```jsonnet +Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withType + +```jsonnet +Terms.withType() +``` + + + +#### obj Terms.settings + + +##### fn Terms.settings.withMinDocCount + +```jsonnet +Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withMissing + +```jsonnet +Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withOrder + +```jsonnet +Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +##### fn Terms.settings.withOrderBy + +```jsonnet +Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withSize + +```jsonnet +Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md index a003cf53..f613269c 100644 --- a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md @@ -4,9 +4,8 @@ grafonnet.query.elasticsearch ## Subpackages -* [bucketAggs.Filters.settings.filters](bucketAggs/Filters/settings/filters.md) -* [metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables](metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md) -* [metrics.PipelineMetricAggregation.BucketScript.pipelineVariables](metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md) +* [bucketAggs](bucketAggs/index.md) +* [metrics](metrics/index.md) ## Index @@ -22,314 +21,6 @@ grafonnet.query.elasticsearch * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) * [`fn withTimeField(value)`](#fn-withtimefield) -* [`obj bucketAggs`](#obj-bucketaggs) - * [`obj DateHistogram`](#obj-bucketaggsdatehistogram) - * [`fn withField(value)`](#fn-bucketaggsdatehistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggsdatehistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggsdatehistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsdatehistogramwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsdatehistogramwithtype) - * [`obj settings`](#obj-bucketaggsdatehistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggsdatehistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggsdatehistogramsettingswithmindoccount) - * [`fn withOffset(value)`](#fn-bucketaggsdatehistogramsettingswithoffset) - * [`fn withTimeZone(value)`](#fn-bucketaggsdatehistogramsettingswithtimezone) - * [`fn withTrimEdges(value)`](#fn-bucketaggsdatehistogramsettingswithtrimedges) - * [`obj Filters`](#obj-bucketaggsfilters) - * [`fn withId(value)`](#fn-bucketaggsfilterswithid) - * [`fn withSettings(value)`](#fn-bucketaggsfilterswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsfilterswithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsfilterswithtype) - * [`obj settings`](#obj-bucketaggsfilterssettings) - * [`fn withFilters(value)`](#fn-bucketaggsfilterssettingswithfilters) - * [`fn withFiltersMixin(value)`](#fn-bucketaggsfilterssettingswithfiltersmixin) - * [`obj GeoHashGrid`](#obj-bucketaggsgeohashgrid) - * [`fn withField(value)`](#fn-bucketaggsgeohashgridwithfield) - * [`fn withId(value)`](#fn-bucketaggsgeohashgridwithid) - * [`fn withSettings(value)`](#fn-bucketaggsgeohashgridwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsgeohashgridwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsgeohashgridwithtype) - * [`obj settings`](#obj-bucketaggsgeohashgridsettings) - * [`fn withPrecision(value)`](#fn-bucketaggsgeohashgridsettingswithprecision) - * [`obj Histogram`](#obj-bucketaggshistogram) - * [`fn withField(value)`](#fn-bucketaggshistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggshistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggshistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggshistogramwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggshistogramwithtype) - * [`obj settings`](#obj-bucketaggshistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggshistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggshistogramsettingswithmindoccount) - * [`obj Nested`](#obj-bucketaggsnested) - * [`fn withField(value)`](#fn-bucketaggsnestedwithfield) - * [`fn withId(value)`](#fn-bucketaggsnestedwithid) - * [`fn withSettings(value)`](#fn-bucketaggsnestedwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsnestedwithsettingsmixin) - * [`fn withType()`](#fn-bucketaggsnestedwithtype) - * [`obj Terms`](#obj-bucketaggsterms) - * [`fn withField(value)`](#fn-bucketaggstermswithfield) - * [`fn withId(value)`](#fn-bucketaggstermswithid) - * [`fn withSettings(value)`](#fn-bucketaggstermswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggstermswithsettingsmixin) - * [`fn withType()`](#fn-bucketaggstermswithtype) - * [`obj settings`](#obj-bucketaggstermssettings) - * [`fn withMinDocCount(value)`](#fn-bucketaggstermssettingswithmindoccount) - * [`fn withMissing(value)`](#fn-bucketaggstermssettingswithmissing) - * [`fn withOrder(value)`](#fn-bucketaggstermssettingswithorder) - * [`fn withOrderBy(value)`](#fn-bucketaggstermssettingswithorderby) - * [`fn withSize(value)`](#fn-bucketaggstermssettingswithsize) -* [`obj metrics`](#obj-metrics) - * [`obj Count`](#obj-metricscount) - * [`fn withHide(value=true)`](#fn-metricscountwithhide) - * [`fn withId(value)`](#fn-metricscountwithid) - * [`fn withType()`](#fn-metricscountwithtype) - * [`obj MetricAggregationWithSettings`](#obj-metricsmetricaggregationwithsettings) - * [`obj Average`](#obj-metricsmetricaggregationwithsettingsaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsaveragewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsaveragesettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsaveragesettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingsscriptwithinline) - * [`obj BucketScript`](#obj-metricsmetricaggregationwithsettingsbucketscript) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricsmetricaggregationwithsettingscumulativesum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingscumulativesumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingscumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricsmetricaggregationwithsettingsderivative) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsderivativewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsderivativewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsderivativesettings) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsderivativesettingswithunit) - * [`obj ExtendedStats`](#obj-metricsmetricaggregationwithsettingsextendedstats) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithid) - * [`fn withMeta(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmeta) - * [`fn withMetaMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmetamixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsextendedstatswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsextendedstatssettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscriptmixin) - * [`fn withSigma(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithsigma) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsextendedstatssettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingsscriptwithinline) - * [`obj Logs`](#obj-metricsmetricaggregationwithsettingslogs) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingslogswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingslogswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingslogswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingslogssettings) - * [`fn withLimit(value)`](#fn-metricsmetricaggregationwithsettingslogssettingswithlimit) - * [`obj Max`](#obj-metricsmetricaggregationwithsettingsmax) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmaxwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmaxwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmaxsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmaxsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingsscriptwithinline) - * [`obj Min`](#obj-metricsmetricaggregationwithsettingsmin) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsminwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsminwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsminwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsminwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsminsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsminsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsminsettingsscriptwithinline) - * [`obj MovingAverage`](#obj-metricsmetricaggregationwithsettingsmovingaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithtype) - * [`obj MovingFunction`](#obj-metricsmetricaggregationwithsettingsmovingfunction) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) - * [`fn withShift(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithshift) - * [`fn withWindow(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithwindow) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) - * [`obj Percentiles`](#obj-metricsmetricaggregationwithsettingspercentiles) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingspercentileswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingspercentileswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingspercentilessettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithmissing) - * [`fn withPercents(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercents) - * [`fn withPercentsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercentsmixin) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingspercentilessettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingsscriptwithinline) - * [`obj Rate`](#obj-metricsmetricaggregationwithsettingsrate) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsratewithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsratewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsratewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsratewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsratesettings) - * [`fn withMode(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithmode) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithunit) - * [`obj RawData`](#obj-metricsmetricaggregationwithsettingsrawdata) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdatawithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdatawithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdatasettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdatasettingswithsize) - * [`obj RawDocument`](#obj-metricsmetricaggregationwithsettingsrawdocument) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdocumentsettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentsettingswithsize) - * [`obj SerialDiff`](#obj-metricsmetricaggregationwithsettingsserialdiff) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsserialdiffwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsserialdiffsettings) - * [`fn withLag(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffsettingswithlag) - * [`obj Sum`](#obj-metricsmetricaggregationwithsettingssum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingssumwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingssumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingssumwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingssumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingssumsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingssumsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingssumsettingsscriptwithinline) - * [`obj TopMetrics`](#obj-metricsmetricaggregationwithsettingstopmetrics) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingstopmetricswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingstopmetricswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingstopmetricssettings) - * [`fn withMetrics(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetrics) - * [`fn withMetricsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetricsmixin) - * [`fn withOrder(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorder) - * [`fn withOrderBy(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorderby) - * [`obj UniqueCount`](#obj-metricsmetricaggregationwithsettingsuniquecount) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithfield) - * [`fn withHide(value=true)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettingsmixin) - * [`fn withType()`](#fn-metricsmetricaggregationwithsettingsuniquecountwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsuniquecountsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithmissing) - * [`fn withPrecisionThreshold(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) - * [`obj PipelineMetricAggregation`](#obj-metricspipelinemetricaggregation) - * [`obj BucketScript`](#obj-metricspipelinemetricaggregationbucketscript) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationbucketscriptwithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricspipelinemetricaggregationbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricspipelinemetricaggregationcumulativesum) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithfield) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationcumulativesumwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationcumulativesumwithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationcumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricspipelinemetricaggregationcumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricspipelinemetricaggregationderivative) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationderivativewithfield) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationderivativewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationderivativewithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationderivativewithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationderivativesettings) - * [`fn withUnit(value)`](#fn-metricspipelinemetricaggregationderivativesettingswithunit) - * [`obj MovingAverage`](#obj-metricspipelinemetricaggregationmovingaverage) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithfield) - * [`fn withHide(value=true)`](#fn-metricspipelinemetricaggregationmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettingsmixin) - * [`fn withType()`](#fn-metricspipelinemetricaggregationmovingaveragewithtype) ## Fields @@ -474,2792 +165,4 @@ PARAMETERS: * **value** (`string`) -Name of time field -### obj bucketAggs - - -#### obj bucketAggs.DateHistogram - - -##### fn bucketAggs.DateHistogram.withField - -```jsonnet -bucketAggs.DateHistogram.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.DateHistogram.withId - -```jsonnet -bucketAggs.DateHistogram.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.DateHistogram.withSettings - -```jsonnet -bucketAggs.DateHistogram.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.DateHistogram.withSettingsMixin - -```jsonnet -bucketAggs.DateHistogram.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.DateHistogram.withType - -```jsonnet -bucketAggs.DateHistogram.withType() -``` - - - -##### obj bucketAggs.DateHistogram.settings - - -###### fn bucketAggs.DateHistogram.settings.withInterval - -```jsonnet -bucketAggs.DateHistogram.settings.withInterval(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withMinDocCount - -```jsonnet -bucketAggs.DateHistogram.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withOffset - -```jsonnet -bucketAggs.DateHistogram.settings.withOffset(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withTimeZone - -```jsonnet -bucketAggs.DateHistogram.settings.withTimeZone(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.DateHistogram.settings.withTrimEdges - -```jsonnet -bucketAggs.DateHistogram.settings.withTrimEdges(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj bucketAggs.Filters - - -##### fn bucketAggs.Filters.withId - -```jsonnet -bucketAggs.Filters.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Filters.withSettings - -```jsonnet -bucketAggs.Filters.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Filters.withSettingsMixin - -```jsonnet -bucketAggs.Filters.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Filters.withType - -```jsonnet -bucketAggs.Filters.withType() -``` - - - -##### obj bucketAggs.Filters.settings - - -###### fn bucketAggs.Filters.settings.withFilters - -```jsonnet -bucketAggs.Filters.settings.withFilters(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn bucketAggs.Filters.settings.withFiltersMixin - -```jsonnet -bucketAggs.Filters.settings.withFiltersMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -#### obj bucketAggs.GeoHashGrid - - -##### fn bucketAggs.GeoHashGrid.withField - -```jsonnet -bucketAggs.GeoHashGrid.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.GeoHashGrid.withId - -```jsonnet -bucketAggs.GeoHashGrid.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.GeoHashGrid.withSettings - -```jsonnet -bucketAggs.GeoHashGrid.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.GeoHashGrid.withSettingsMixin - -```jsonnet -bucketAggs.GeoHashGrid.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.GeoHashGrid.withType - -```jsonnet -bucketAggs.GeoHashGrid.withType() -``` - - - -##### obj bucketAggs.GeoHashGrid.settings - - -###### fn bucketAggs.GeoHashGrid.settings.withPrecision - -```jsonnet -bucketAggs.GeoHashGrid.settings.withPrecision(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj bucketAggs.Histogram - - -##### fn bucketAggs.Histogram.withField - -```jsonnet -bucketAggs.Histogram.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Histogram.withId - -```jsonnet -bucketAggs.Histogram.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Histogram.withSettings - -```jsonnet -bucketAggs.Histogram.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Histogram.withSettingsMixin - -```jsonnet -bucketAggs.Histogram.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Histogram.withType - -```jsonnet -bucketAggs.Histogram.withType() -``` - - - -##### obj bucketAggs.Histogram.settings - - -###### fn bucketAggs.Histogram.settings.withInterval - -```jsonnet -bucketAggs.Histogram.settings.withInterval(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Histogram.settings.withMinDocCount - -```jsonnet -bucketAggs.Histogram.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj bucketAggs.Nested - - -##### fn bucketAggs.Nested.withField - -```jsonnet -bucketAggs.Nested.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Nested.withId - -```jsonnet -bucketAggs.Nested.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Nested.withSettings - -```jsonnet -bucketAggs.Nested.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Nested.withSettingsMixin - -```jsonnet -bucketAggs.Nested.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Nested.withType - -```jsonnet -bucketAggs.Nested.withType() -``` - - - -#### obj bucketAggs.Terms - - -##### fn bucketAggs.Terms.withField - -```jsonnet -bucketAggs.Terms.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Terms.withId - -```jsonnet -bucketAggs.Terms.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn bucketAggs.Terms.withSettings - -```jsonnet -bucketAggs.Terms.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Terms.withSettingsMixin - -```jsonnet -bucketAggs.Terms.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -##### fn bucketAggs.Terms.withType - -```jsonnet -bucketAggs.Terms.withType() -``` - - - -##### obj bucketAggs.Terms.settings - - -###### fn bucketAggs.Terms.settings.withMinDocCount - -```jsonnet -bucketAggs.Terms.settings.withMinDocCount(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Terms.settings.withMissing - -```jsonnet -bucketAggs.Terms.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Terms.settings.withOrder - -```jsonnet -bucketAggs.Terms.settings.withOrder(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"desc"`, `"asc"` - - -###### fn bucketAggs.Terms.settings.withOrderBy - -```jsonnet -bucketAggs.Terms.settings.withOrderBy(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn bucketAggs.Terms.settings.withSize - -```jsonnet -bucketAggs.Terms.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### obj metrics - - -#### obj metrics.Count - - -##### fn metrics.Count.withHide - -```jsonnet -metrics.Count.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -##### fn metrics.Count.withId - -```jsonnet -metrics.Count.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### fn metrics.Count.withType - -```jsonnet -metrics.Count.withType() -``` - - - -#### obj metrics.MetricAggregationWithSettings - - -##### obj metrics.MetricAggregationWithSettings.Average - - -###### fn metrics.MetricAggregationWithSettings.Average.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Average.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Average.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Average.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Average.settings - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Average.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Average.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Average.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.BucketScript - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withId - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withType - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.BucketScript.settings - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.BucketScript.settings.script - - -######## fn metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.CumulativeSum - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withField - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withId - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withType - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.CumulativeSum.settings - - -####### fn metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat - -```jsonnet -metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Derivative - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Derivative.settings - - -####### fn metrics.MetricAggregationWithSettings.Derivative.settings.withUnit - -```jsonnet -metrics.MetricAggregationWithSettings.Derivative.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.ExtendedStats - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withField - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withId - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMeta - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withMeta(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withType - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings.script - - -######## fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Logs - - -###### fn metrics.MetricAggregationWithSettings.Logs.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Logs.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Logs.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Logs.settings - - -####### fn metrics.MetricAggregationWithSettings.Logs.settings.withLimit - -```jsonnet -metrics.MetricAggregationWithSettings.Logs.settings.withLimit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Max - - -###### fn metrics.MetricAggregationWithSettings.Max.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Max.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Max.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Max.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Max.settings - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Max.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Max.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Max.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Min - - -###### fn metrics.MetricAggregationWithSettings.Min.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Min.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Min.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Min.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Min.settings - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Min.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Min.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Min.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.MovingAverage - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withField - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withId - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withType - -```jsonnet -metrics.MetricAggregationWithSettings.MovingAverage.withType() -``` - - - -##### obj metrics.MetricAggregationWithSettings.MovingFunction - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withField - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withId - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withType - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.MovingFunction.settings - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### obj metrics.MetricAggregationWithSettings.MovingFunction.settings.script - - -######## fn metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Percentiles - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Percentiles.settings - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Percentiles.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Rate - - -###### fn metrics.MetricAggregationWithSettings.Rate.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Rate.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Rate.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Rate.settings - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withMode - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.settings.withMode(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withUnit - -```jsonnet -metrics.MetricAggregationWithSettings.Rate.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.RawData - - -###### fn metrics.MetricAggregationWithSettings.RawData.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.RawData.withId - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawData.withType - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawData.settings - - -####### fn metrics.MetricAggregationWithSettings.RawData.settings.withSize - -```jsonnet -metrics.MetricAggregationWithSettings.RawData.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.RawDocument - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withId - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withType - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawDocument.settings - - -####### fn metrics.MetricAggregationWithSettings.RawDocument.settings.withSize - -```jsonnet -metrics.MetricAggregationWithSettings.RawDocument.settings.withSize(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.SerialDiff - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withField - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withId - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withType - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.SerialDiff.settings - - -####### fn metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag - -```jsonnet -metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.Sum - - -###### fn metrics.MetricAggregationWithSettings.Sum.withField - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.Sum.withId - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.Sum.withType - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.Sum.settings - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScript - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.MetricAggregationWithSettings.Sum.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Sum.settings.script.withInline - -```jsonnet -metrics.MetricAggregationWithSettings.Sum.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.TopMetrics - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withId - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withType - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.TopMetrics.settings - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy - -```jsonnet -metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.MetricAggregationWithSettings.UniqueCount - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withField - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withHide - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withId - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettings - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withType - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.withType() -``` - - - -###### obj metrics.MetricAggregationWithSettings.UniqueCount.settings - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold - -```jsonnet -metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj metrics.PipelineMetricAggregation - - -##### obj metrics.PipelineMetricAggregation.BucketScript - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withHide - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withId - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withType - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.withType() -``` - - - -###### obj metrics.PipelineMetricAggregation.BucketScript.settings - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScript - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.settings.withScript(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - - -####### obj metrics.PipelineMetricAggregation.BucketScript.settings.script - - -######## fn metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline - -```jsonnet -metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.PipelineMetricAggregation.CumulativeSum - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withField - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withHide - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withId - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withType - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.withType() -``` - - - -###### obj metrics.PipelineMetricAggregation.CumulativeSum.settings - - -####### fn metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat - -```jsonnet -metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.PipelineMetricAggregation.Derivative - - -###### fn metrics.PipelineMetricAggregation.Derivative.withField - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withHide - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.Derivative.withId - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withPipelineAgg - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.Derivative.withType - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.withType() -``` - - - -###### obj metrics.PipelineMetricAggregation.Derivative.settings - - -####### fn metrics.PipelineMetricAggregation.Derivative.settings.withUnit - -```jsonnet -metrics.PipelineMetricAggregation.Derivative.settings.withUnit(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -##### obj metrics.PipelineMetricAggregation.MovingAverage - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withField - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withField(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withHide - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withHide(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withId - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withId(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettings - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withSettings(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withType - -```jsonnet -metrics.PipelineMetricAggregation.MovingAverage.withType() -``` - - +Name of time field \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md new file mode 100644 index 00000000..fc18efe3 --- /dev/null +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md @@ -0,0 +1,2547 @@ +# metrics + + + +## Subpackages + +* [MetricAggregationWithSettings.BucketScript.pipelineVariables](MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [PipelineMetricAggregation.BucketScript.pipelineVariables](PipelineMetricAggregation/BucketScript/pipelineVariables.md) + +## Index + +* [`obj Count`](#obj-count) + * [`fn withHide(value=true)`](#fn-countwithhide) + * [`fn withId(value)`](#fn-countwithid) + * [`fn withType()`](#fn-countwithtype) +* [`obj MetricAggregationWithSettings`](#obj-metricaggregationwithsettings) + * [`obj Average`](#obj-metricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) +* [`obj PipelineMetricAggregation`](#obj-pipelinemetricaggregation) + * [`obj BucketScript`](#obj-pipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-pipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-pipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-pipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-pipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-pipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-pipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-pipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-pipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-pipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-pipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-pipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationmovingaveragewithtype) + +## Fields + +### obj Count + + +#### fn Count.withHide + +```jsonnet +Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn Count.withId + +```jsonnet +Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Count.withType + +```jsonnet +Count.withType() +``` + + + +### obj MetricAggregationWithSettings + + +#### obj MetricAggregationWithSettings.Average + + +##### fn MetricAggregationWithSettings.Average.withField + +```jsonnet +MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withHide + +```jsonnet +MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Average.withId + +```jsonnet +MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withSettings + +```jsonnet +MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withType + +```jsonnet +MetricAggregationWithSettings.Average.withType() +``` + + + +##### obj MetricAggregationWithSettings.Average.settings + + +###### fn MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Average.settings.script + + +####### fn MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.BucketScript + + +##### fn MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +MetricAggregationWithSettings.BucketScript.withType() +``` + + + +##### obj MetricAggregationWithSettings.BucketScript.settings + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.BucketScript.settings.script + + +####### fn MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.CumulativeSum + + +##### fn MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withType() +``` + + + +##### obj MetricAggregationWithSettings.CumulativeSum.settings + + +###### fn MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Derivative + + +##### fn MetricAggregationWithSettings.Derivative.withField + +```jsonnet +MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Derivative.withId + +```jsonnet +MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withType + +```jsonnet +MetricAggregationWithSettings.Derivative.withType() +``` + + + +##### obj MetricAggregationWithSettings.Derivative.settings + + +###### fn MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.ExtendedStats + + +##### fn MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withType() +``` + + + +##### obj MetricAggregationWithSettings.ExtendedStats.settings + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.ExtendedStats.settings.script + + +####### fn MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Logs + + +##### fn MetricAggregationWithSettings.Logs.withHide + +```jsonnet +MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Logs.withId + +```jsonnet +MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withType + +```jsonnet +MetricAggregationWithSettings.Logs.withType() +``` + + + +##### obj MetricAggregationWithSettings.Logs.settings + + +###### fn MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Max + + +##### fn MetricAggregationWithSettings.Max.withField + +```jsonnet +MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withHide + +```jsonnet +MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Max.withId + +```jsonnet +MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withSettings + +```jsonnet +MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withType + +```jsonnet +MetricAggregationWithSettings.Max.withType() +``` + + + +##### obj MetricAggregationWithSettings.Max.settings + + +###### fn MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Max.settings.script + + +####### fn MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Min + + +##### fn MetricAggregationWithSettings.Min.withField + +```jsonnet +MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withHide + +```jsonnet +MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Min.withId + +```jsonnet +MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withSettings + +```jsonnet +MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withType + +```jsonnet +MetricAggregationWithSettings.Min.withType() +``` + + + +##### obj MetricAggregationWithSettings.Min.settings + + +###### fn MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Min.settings.script + + +####### fn MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.MovingAverage + + +##### fn MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withType() +``` + + + +#### obj MetricAggregationWithSettings.MovingFunction + + +##### fn MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withType() +``` + + + +##### obj MetricAggregationWithSettings.MovingFunction.settings + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.MovingFunction.settings.script + + +####### fn MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Percentiles + + +##### fn MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +MetricAggregationWithSettings.Percentiles.withType() +``` + + + +##### obj MetricAggregationWithSettings.Percentiles.settings + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Percentiles.settings.script + + +####### fn MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Rate + + +##### fn MetricAggregationWithSettings.Rate.withField + +```jsonnet +MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withHide + +```jsonnet +MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Rate.withId + +```jsonnet +MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withType + +```jsonnet +MetricAggregationWithSettings.Rate.withType() +``` + + + +##### obj MetricAggregationWithSettings.Rate.settings + + +###### fn MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawData + + +##### fn MetricAggregationWithSettings.RawData.withHide + +```jsonnet +MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawData.withId + +```jsonnet +MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withType + +```jsonnet +MetricAggregationWithSettings.RawData.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawData.settings + + +###### fn MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawDocument + + +##### fn MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +MetricAggregationWithSettings.RawDocument.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawDocument.settings + + +###### fn MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.SerialDiff + + +##### fn MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withType() +``` + + + +##### obj MetricAggregationWithSettings.SerialDiff.settings + + +###### fn MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Sum + + +##### fn MetricAggregationWithSettings.Sum.withField + +```jsonnet +MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withHide + +```jsonnet +MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Sum.withId + +```jsonnet +MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withType + +```jsonnet +MetricAggregationWithSettings.Sum.withType() +``` + + + +##### obj MetricAggregationWithSettings.Sum.settings + + +###### fn MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Sum.settings.script + + +####### fn MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.TopMetrics + + +##### fn MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withType() +``` + + + +##### obj MetricAggregationWithSettings.TopMetrics.settings + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.UniqueCount + + +##### fn MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withType() +``` + + + +##### obj MetricAggregationWithSettings.UniqueCount.settings + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj PipelineMetricAggregation + + +#### obj PipelineMetricAggregation.BucketScript + + +##### fn PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.BucketScript.withId + +```jsonnet +PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withType + +```jsonnet +PipelineMetricAggregation.BucketScript.withType() +``` + + + +##### obj PipelineMetricAggregation.BucketScript.settings + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj PipelineMetricAggregation.BucketScript.settings.script + + +####### fn PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.CumulativeSum + + +##### fn PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withType() +``` + + + +##### obj PipelineMetricAggregation.CumulativeSum.settings + + +###### fn PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.Derivative + + +##### fn PipelineMetricAggregation.Derivative.withField + +```jsonnet +PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withHide + +```jsonnet +PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.Derivative.withId + +```jsonnet +PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withType + +```jsonnet +PipelineMetricAggregation.Derivative.withType() +``` + + + +##### obj PipelineMetricAggregation.Derivative.settings + + +###### fn PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.MovingAverage + + +##### fn PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +PipelineMetricAggregation.MovingAverage.withType() +``` + + diff --git a/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet b/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet index 6f332726..99171aa3 100644 --- a/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet +++ b/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet @@ -1449,3 +1449,4 @@ timeField: value, }, } ++ (import '../custom/query/elasticsearch.libsonnet') diff --git a/generator/query.libsonnet b/generator/query.libsonnet index 012f27c3..628d3c77 100644 --- a/generator/query.libsonnet +++ b/generator/query.libsonnet @@ -146,6 +146,7 @@ local utils = import './utils.libsonnet'; hasCustom: [ 'azureMonitor', 'cloudWatch', + 'elasticsearch', 'expr', 'googleCloudMonitoring', 'grafanaPyroscope', From 371d6d1b07001222be4f0da03da6c9a8d9f38f85 Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 10:32:32 +0200 Subject: [PATCH 14/17] fix(elasticsearch): withDatasource func --- custom/query/elasticsearch.libsonnet | 16 ++++++++++++++ docs/API/query/elasticsearch/index.md | 22 ++----------------- .../custom/query/elasticsearch.libsonnet | 16 ++++++++++++++ .../docs/query/elasticsearch/index.md | 22 ++----------------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/custom/query/elasticsearch.libsonnet b/custom/query/elasticsearch.libsonnet index e4f71117..7d1d54a3 100644 --- a/custom/query/elasticsearch.libsonnet +++ b/custom/query/elasticsearch.libsonnet @@ -1,4 +1,20 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + { bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, metrics+: { '#': { help: '', name: 'metrics' } }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'elasticsearch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/docs/API/query/elasticsearch/index.md b/docs/API/query/elasticsearch/index.md index f613269c..a84eb5f7 100644 --- a/docs/API/query/elasticsearch/index.md +++ b/docs/API/query/elasticsearch/index.md @@ -13,7 +13,6 @@ grafonnet.query.elasticsearch * [`fn withBucketAggs(value)`](#fn-withbucketaggs) * [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withMetrics(value)`](#fn-withmetrics) * [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) @@ -65,26 +64,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withHide ```jsonnet diff --git a/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet b/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet index e4f71117..7d1d54a3 100644 --- a/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet +++ b/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet @@ -1,4 +1,20 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + { bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, metrics+: { '#': { help: '', name: 'metrics' } }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'elasticsearch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, } diff --git a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md index f613269c..a84eb5f7 100644 --- a/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md @@ -13,7 +13,6 @@ grafonnet.query.elasticsearch * [`fn withBucketAggs(value)`](#fn-withbucketaggs) * [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) * [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) * [`fn withHide(value=true)`](#fn-withhide) * [`fn withMetrics(value)`](#fn-withmetrics) * [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) @@ -65,26 +64,9 @@ withDatasource(value) PARAMETERS: -* **value** (`object`) - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null -### fn withDatasourceMixin - -```jsonnet -withDatasourceMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) +* **value** (`string`) -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null +Set the datasource for this query. ### fn withHide ```jsonnet From a3fa8de0fd040fc22a593bf1f0446839bac65753 Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 10:50:57 +0200 Subject: [PATCH 15/17] fix(dashboard): update schemaVersion to 39 Fixes #196 --- custom/dashboard.libsonnet | 5 +++++ docs/API/dashboard/index.md | 11 +++++------ gen/grafonnet-v11.0.0/custom/dashboard.libsonnet | 5 +++++ gen/grafonnet-v11.0.0/docs/dashboard/index.md | 11 +++++------ 4 files changed, 20 insertions(+), 12 deletions(-) diff --git a/custom/dashboard.libsonnet b/custom/dashboard.libsonnet index 1478f3d3..ea8cb554 100644 --- a/custom/dashboard.libsonnet +++ b/custom/dashboard.libsonnet @@ -13,6 +13,11 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + self.time.withFrom('now-6h') + self.time.withTo('now'), + '#withSchemaVersion': { 'function'+: { args: [d.arg('value', d.T.integer, default=39)] } }, + withSchemaVersion(value=39): { + schemaVersion: value, + }, + '#withPanels':: d.func.new( '`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`.', args=[ diff --git a/docs/API/dashboard/index.md b/docs/API/dashboard/index.md index 7cbee639..ec78d461 100644 --- a/docs/API/dashboard/index.md +++ b/docs/API/dashboard/index.md @@ -22,7 +22,7 @@ grafonnet.dashboard * [`fn withPanels(panels, setPanelIDs=true)`](#fn-withpanels) * [`fn withPanelsMixin(panels, setPanelIDs=true)`](#fn-withpanelsmixin) * [`fn withRefresh(value)`](#fn-withrefresh) -* [`fn withSchemaVersion(value=36)`](#fn-withschemaversion) +* [`fn withSchemaVersion(value=39)`](#fn-withschemaversion) * [`fn withTags(value)`](#fn-withtags) * [`fn withTagsMixin(value)`](#fn-withtagsmixin) * [`fn withTemplating(value)`](#fn-withtemplating) @@ -233,16 +233,15 @@ Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h ### fn withSchemaVersion ```jsonnet -withSchemaVersion(value=36) +withSchemaVersion(value=39) ``` PARAMETERS: -* **value** (`integer`) - - default value: `36` +* **value** (`number`) + - default value: `39` + -Version of the JSON schema, incremented each time a Grafana update brings -changes to said schema. ### fn withTags ```jsonnet diff --git a/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet b/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet index 1478f3d3..ea8cb554 100644 --- a/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet +++ b/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet @@ -13,6 +13,11 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + self.time.withFrom('now-6h') + self.time.withTo('now'), + '#withSchemaVersion': { 'function'+: { args: [d.arg('value', d.T.integer, default=39)] } }, + withSchemaVersion(value=39): { + schemaVersion: value, + }, + '#withPanels':: d.func.new( '`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`.', args=[ diff --git a/gen/grafonnet-v11.0.0/docs/dashboard/index.md b/gen/grafonnet-v11.0.0/docs/dashboard/index.md index 7cbee639..ec78d461 100644 --- a/gen/grafonnet-v11.0.0/docs/dashboard/index.md +++ b/gen/grafonnet-v11.0.0/docs/dashboard/index.md @@ -22,7 +22,7 @@ grafonnet.dashboard * [`fn withPanels(panels, setPanelIDs=true)`](#fn-withpanels) * [`fn withPanelsMixin(panels, setPanelIDs=true)`](#fn-withpanelsmixin) * [`fn withRefresh(value)`](#fn-withrefresh) -* [`fn withSchemaVersion(value=36)`](#fn-withschemaversion) +* [`fn withSchemaVersion(value=39)`](#fn-withschemaversion) * [`fn withTags(value)`](#fn-withtags) * [`fn withTagsMixin(value)`](#fn-withtagsmixin) * [`fn withTemplating(value)`](#fn-withtemplating) @@ -233,16 +233,15 @@ Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h ### fn withSchemaVersion ```jsonnet -withSchemaVersion(value=36) +withSchemaVersion(value=39) ``` PARAMETERS: -* **value** (`integer`) - - default value: `36` +* **value** (`number`) + - default value: `39` + -Version of the JSON schema, incremented each time a Grafana update brings -changes to said schema. ### fn withTags ```jsonnet From e1e6dfb1f460731f726c242fde17c0b1619ff36e Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 11:30:02 +0200 Subject: [PATCH 16/17] fix: generate from v11.0.x branch --- Makefile | 20 ---------------- docs/API/panel/candlestick/index.md | 4 ++-- docs/API/panel/dashboardList/index.md | 13 ---------- docs/API/panel/table/index.md | 24 ------------------- docs/API/panel/timeSeries/index.md | 4 ++-- docs/API/panel/trend/index.md | 4 ++-- docs/API/query/tempo/index.md | 2 +- .../docs/panel/candlestick/index.md | 4 ++-- .../docs/panel/dashboardList/index.md | 13 ---------- .../docs/panel/table/index.md | 24 ------------------- .../docs/panel/timeSeries/index.md | 4 ++-- .../docs/panel/trend/index.md | 4 ++-- .../docs/query/tempo/index.md | 2 +- .../panel/candlestick.libsonnet | 4 ++-- .../panel/dashboardList.libsonnet | 6 ----- gen/grafonnet-v11.0.0/panel/table.libsonnet | 24 ------------------- .../panel/timeSeries.libsonnet | 4 ++-- gen/grafonnet-v11.0.0/panel/trend.libsonnet | 4 ++-- gen/grafonnet-v11.0.0/query/tempo.libsonnet | 2 +- scripts/generate.sh | 3 ++- 20 files changed, 23 insertions(+), 146 deletions(-) diff --git a/Makefile b/Makefile index d7caa233..feffad2f 100644 --- a/Makefile +++ b/Makefile @@ -8,26 +8,6 @@ gen/grafonnet-latest: ./scripts/generate.sh ${LATEST} && \ ./scripts/generate_latest.sh ${LATEST} -regenerate: gen/grafonnet-v* - -gen/grafonnet-v10.3.0: - ./scripts/generate.sh v10.3.0 - -gen/grafonnet-v10.2.0: - ./scripts/generate.sh v10.2.0 - -gen/grafonnet-v10.1.0: - ./scripts/generate.sh v10.1.0 - -gen/grafonnet-v10.0.0: - ./scripts/generate.sh v10.0.0 - -gen/grafonnet-v9.5.0: - ./scripts/generate.sh v9.5.0 - -gen/grafonnet-v9.4.0: - ./scripts/generate.sh v9.4.0 - localmkdocs: python -m venv .mkdocs/.venv; \ source .mkdocs/.venv/bin/activate; \ diff --git a/docs/API/panel/candlestick/index.md b/docs/API/panel/candlestick/index.md index 260c1250..9ad9263a 100644 --- a/docs/API/panel/candlestick/index.md +++ b/docs/API/panel/candlestick/index.md @@ -405,7 +405,7 @@ fieldConfig.defaults.custom.withInsertNulls(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withInsertNullsMixin @@ -416,7 +416,7 @@ fieldConfig.defaults.custom.withInsertNullsMixin(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withLineColor diff --git a/docs/API/panel/dashboardList/index.md b/docs/API/panel/dashboardList/index.md index 0f6501f0..a5139210 100644 --- a/docs/API/panel/dashboardList/index.md +++ b/docs/API/panel/dashboardList/index.md @@ -23,7 +23,6 @@ grafonnet.panel.dashboardList * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) * [`fn withQuery(value="")`](#fn-optionswithquery) - * [`fn withShowFolderNames(value=true)`](#fn-optionswithshowfoldernames) * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) @@ -185,18 +184,6 @@ PARAMETERS: - default value: `""` -#### fn options.withShowFolderNames - -```jsonnet -options.withShowFolderNames(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - #### fn options.withShowHeadings ```jsonnet diff --git a/docs/API/panel/table/index.md b/docs/API/panel/table/index.md index e8d83f0f..d5c25b8b 100644 --- a/docs/API/panel/table/index.md +++ b/docs/API/panel/table/index.md @@ -83,8 +83,6 @@ grafonnet.panel.table * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) - * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnulls) - * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) @@ -868,28 +866,6 @@ PARAMETERS: - default value: `true` -######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls - -```jsonnet -fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls(value) -``` - -PARAMETERS: - -* **value** (`boolean`,`number`) - - -######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin - -```jsonnet -fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin(value) -``` - -PARAMETERS: - -* **value** (`boolean`,`number`) - - ######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor ```jsonnet diff --git a/docs/API/panel/timeSeries/index.md b/docs/API/panel/timeSeries/index.md index 0b30e977..fd6c263b 100644 --- a/docs/API/panel/timeSeries/index.md +++ b/docs/API/panel/timeSeries/index.md @@ -393,7 +393,7 @@ fieldConfig.defaults.custom.withInsertNulls(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withInsertNullsMixin @@ -404,7 +404,7 @@ fieldConfig.defaults.custom.withInsertNullsMixin(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withLineColor diff --git a/docs/API/panel/trend/index.md b/docs/API/panel/trend/index.md index c0f4ff29..f5e75a2a 100644 --- a/docs/API/panel/trend/index.md +++ b/docs/API/panel/trend/index.md @@ -388,7 +388,7 @@ fieldConfig.defaults.custom.withInsertNulls(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withInsertNullsMixin @@ -399,7 +399,7 @@ fieldConfig.defaults.custom.withInsertNullsMixin(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withLineColor diff --git a/docs/API/query/tempo/index.md b/docs/API/query/tempo/index.md index c3d9877b..485ab220 100644 --- a/docs/API/query/tempo/index.md +++ b/docs/API/query/tempo/index.md @@ -269,6 +269,6 @@ withTableType(value) PARAMETERS: * **value** (`string`) - - valid values: `"traces"`, `"spans"`, `"raw"` + - valid values: `"traces"`, `"spans"` The type of the table that is used to display the search results \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md index 260c1250..9ad9263a 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md @@ -405,7 +405,7 @@ fieldConfig.defaults.custom.withInsertNulls(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withInsertNullsMixin @@ -416,7 +416,7 @@ fieldConfig.defaults.custom.withInsertNullsMixin(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withLineColor diff --git a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md index 0f6501f0..a5139210 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md @@ -23,7 +23,6 @@ grafonnet.panel.dashboardList * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) * [`fn withQuery(value="")`](#fn-optionswithquery) - * [`fn withShowFolderNames(value=true)`](#fn-optionswithshowfoldernames) * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) @@ -185,18 +184,6 @@ PARAMETERS: - default value: `""` -#### fn options.withShowFolderNames - -```jsonnet -options.withShowFolderNames(value=true) -``` - -PARAMETERS: - -* **value** (`boolean`) - - default value: `true` - - #### fn options.withShowHeadings ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/table/index.md b/gen/grafonnet-v11.0.0/docs/panel/table/index.md index e8d83f0f..d5c25b8b 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/table/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/table/index.md @@ -83,8 +83,6 @@ grafonnet.panel.table * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) - * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnulls) - * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnullsmixin) * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) @@ -868,28 +866,6 @@ PARAMETERS: - default value: `true` -######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls - -```jsonnet -fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls(value) -``` - -PARAMETERS: - -* **value** (`boolean`,`number`) - - -######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin - -```jsonnet -fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin(value) -``` - -PARAMETERS: - -* **value** (`boolean`,`number`) - - ######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md index 0b30e977..fd6c263b 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md @@ -393,7 +393,7 @@ fieldConfig.defaults.custom.withInsertNulls(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withInsertNullsMixin @@ -404,7 +404,7 @@ fieldConfig.defaults.custom.withInsertNullsMixin(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withLineColor diff --git a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md index c0f4ff29..f5e75a2a 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md @@ -388,7 +388,7 @@ fieldConfig.defaults.custom.withInsertNulls(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withInsertNullsMixin @@ -399,7 +399,7 @@ fieldConfig.defaults.custom.withInsertNullsMixin(value) PARAMETERS: -* **value** (`boolean`,`number`) +* **value** (`boolean`,`integer`) ###### fn fieldConfig.defaults.custom.withLineColor diff --git a/gen/grafonnet-v11.0.0/docs/query/tempo/index.md b/gen/grafonnet-v11.0.0/docs/query/tempo/index.md index c3d9877b..485ab220 100644 --- a/gen/grafonnet-v11.0.0/docs/query/tempo/index.md +++ b/gen/grafonnet-v11.0.0/docs/query/tempo/index.md @@ -269,6 +269,6 @@ withTableType(value) PARAMETERS: * **value** (`string`) - - valid values: `"traces"`, `"spans"`, `"raw"` + - valid values: `"traces"`, `"spans"` The type of the table that is used to display the search results \ No newline at end of file diff --git a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet index dc3026d2..feb03c7c 100644 --- a/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet @@ -242,7 +242,7 @@ }, }, }, - '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, withInsertNulls(value): { fieldConfig+: { defaults+: { @@ -252,7 +252,7 @@ }, }, }, - '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, withInsertNullsMixin(value): { fieldConfig+: { defaults+: { diff --git a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet index 48d9cdd2..94a0e471 100644 --- a/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet @@ -47,12 +47,6 @@ query: value, }, }, - '#withShowFolderNames': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, - withShowFolderNames(value=true): { - options+: { - showFolderNames: value, - }, - }, '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, withShowHeadings(value=true): { options+: { diff --git a/gen/grafonnet-v11.0.0/panel/table.libsonnet b/gen/grafonnet-v11.0.0/panel/table.libsonnet index a2535c48..2e081638 100644 --- a/gen/grafonnet-v11.0.0/panel/table.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/table.libsonnet @@ -395,30 +395,6 @@ }, }, }, - '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, - withInsertNulls(value): { - fieldConfig+: { - defaults+: { - custom+: { - cellOptions+: { - insertNulls: value, - }, - }, - }, - }, - }, - '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, - withInsertNullsMixin(value): { - fieldConfig+: { - defaults+: { - custom+: { - cellOptions+: { - insertNulls+: value, - }, - }, - }, - }, - }, '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withLineColor(value): { fieldConfig+: { diff --git a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet index ff275f6c..f9bf740d 100644 --- a/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet @@ -242,7 +242,7 @@ }, }, }, - '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, withInsertNulls(value): { fieldConfig+: { defaults+: { @@ -252,7 +252,7 @@ }, }, }, - '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, withInsertNullsMixin(value): { fieldConfig+: { defaults+: { diff --git a/gen/grafonnet-v11.0.0/panel/trend.libsonnet b/gen/grafonnet-v11.0.0/panel/trend.libsonnet index 294cf2c1..929422f2 100644 --- a/gen/grafonnet-v11.0.0/panel/trend.libsonnet +++ b/gen/grafonnet-v11.0.0/panel/trend.libsonnet @@ -242,7 +242,7 @@ }, }, }, - '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, withInsertNulls(value): { fieldConfig+: { defaults+: { @@ -252,7 +252,7 @@ }, }, }, - '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, withInsertNullsMixin(value): { fieldConfig+: { defaults+: { diff --git a/gen/grafonnet-v11.0.0/query/tempo.libsonnet b/gen/grafonnet-v11.0.0/query/tempo.libsonnet index 1fe9d98e..61ed2901 100644 --- a/gen/grafonnet-v11.0.0/query/tempo.libsonnet +++ b/gen/grafonnet-v11.0.0/query/tempo.libsonnet @@ -157,7 +157,7 @@ withSpss(value): { spss: value, }, - '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans', 'raw'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, + '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, withTableType(value): { tableType: value, }, diff --git a/scripts/generate.sh b/scripts/generate.sh index 90058f96..d6a77398 100755 --- a/scripts/generate.sh +++ b/scripts/generate.sh @@ -3,6 +3,7 @@ set -euo pipefail set -x VERSION="${1}" +COG_VERSION="${VERSION%?}x" DIRNAME0="$(dirname "$0")" SCRIPT_DIR=$(cd "$DIRNAME0" && pwd) @@ -19,7 +20,7 @@ jb init cp -r "${REPO_DIR}/generator" generator cp -r "${REPO_DIR}/generator/jsonnetfile.lock.json" . jb install -jb install "github.com/grafana/grafana-foundation-sdk/openapi@next+cog-v0.0.x" +jb install "github.com/grafana/grafana-foundation-sdk/openapi@${COG_VERSION}+cog-v0.0.x" jb install "github.com/grafana/grafana/public@${VERSION}-preview" jb install ./generator From 0201ed6dc2467137bdeecff8316f7b8df7acb2c5 Mon Sep 17 00:00:00 2001 From: Duologic Date: Fri, 24 May 2024 11:31:50 +0200 Subject: [PATCH 17/17] fix: tests --- examples/redMethod/output.json | 2 +- examples/runtimeDashboard/output.json | 2 +- examples/simple/output.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/redMethod/output.json b/examples/redMethod/output.json index 730544ce..8eb1b171 100644 --- a/examples/redMethod/output.json +++ b/examples/redMethod/output.json @@ -197,7 +197,7 @@ "type": "timeseries" } ], - "schemaVersion": 36, + "schemaVersion": 39, "templating": { "list": [ { diff --git a/examples/runtimeDashboard/output.json b/examples/runtimeDashboard/output.json index 14a5e663..144e67cb 100644 --- a/examples/runtimeDashboard/output.json +++ b/examples/runtimeDashboard/output.json @@ -703,7 +703,7 @@ "type": "row" } ], - "schemaVersion": 36, + "schemaVersion": 39, "templating": { "list": [ { diff --git a/examples/simple/output.json b/examples/simple/output.json index 095b138d..2d77b0c8 100644 --- a/examples/simple/output.json +++ b/examples/simple/output.json @@ -31,7 +31,7 @@ type: 'timeseries', }, ], - schemaVersion: 36, + schemaVersion: 39, time: { from: 'now-6h', to: 'now',