From 333600a37eb93b6522a44ab152d60a1e39ad28ae Mon Sep 17 00:00:00 2001 From: Jeroen Op 't Eynde Date: Fri, 31 May 2024 14:12:52 +0200 Subject: [PATCH] fix(generator): some fields made it into the schema, enabling now (#207) --- docs/API/panel/alertList/index.md | 38 +++++++++++++++++++ docs/API/panel/annotationsList/index.md | 38 +++++++++++++++++++ docs/API/panel/barChart/index.md | 38 +++++++++++++++++++ docs/API/panel/barGauge/index.md | 38 +++++++++++++++++++ docs/API/panel/candlestick/index.md | 38 +++++++++++++++++++ docs/API/panel/canvas/index.md | 38 +++++++++++++++++++ docs/API/panel/dashboardList/index.md | 38 +++++++++++++++++++ docs/API/panel/datagrid/index.md | 38 +++++++++++++++++++ docs/API/panel/debug/index.md | 38 +++++++++++++++++++ docs/API/panel/gauge/index.md | 38 +++++++++++++++++++ docs/API/panel/geomap/index.md | 38 +++++++++++++++++++ docs/API/panel/heatmap/index.md | 38 +++++++++++++++++++ docs/API/panel/histogram/index.md | 38 +++++++++++++++++++ docs/API/panel/logs/index.md | 38 +++++++++++++++++++ docs/API/panel/news/index.md | 38 +++++++++++++++++++ docs/API/panel/nodeGraph/index.md | 38 +++++++++++++++++++ docs/API/panel/pieChart/index.md | 38 +++++++++++++++++++ docs/API/panel/stat/index.md | 38 +++++++++++++++++++ docs/API/panel/stateTimeline/index.md | 38 +++++++++++++++++++ docs/API/panel/statusHistory/index.md | 38 +++++++++++++++++++ docs/API/panel/table/index.md | 38 +++++++++++++++++++ docs/API/panel/text/index.md | 38 +++++++++++++++++++ docs/API/panel/timeSeries/index.md | 38 +++++++++++++++++++ docs/API/panel/trend/index.md | 38 +++++++++++++++++++ docs/API/panel/xyChart/index.md | 38 +++++++++++++++++++ .../docs/panel/alertList/index.md | 38 +++++++++++++++++++ .../docs/panel/annotationsList/index.md | 38 +++++++++++++++++++ .../docs/panel/barChart/index.md | 38 +++++++++++++++++++ .../docs/panel/barGauge/index.md | 38 +++++++++++++++++++ .../docs/panel/candlestick/index.md | 38 +++++++++++++++++++ .../docs/panel/canvas/index.md | 38 +++++++++++++++++++ .../docs/panel/dashboardList/index.md | 38 +++++++++++++++++++ .../docs/panel/datagrid/index.md | 38 +++++++++++++++++++ .../docs/panel/debug/index.md | 38 +++++++++++++++++++ .../docs/panel/gauge/index.md | 38 +++++++++++++++++++ .../docs/panel/geomap/index.md | 38 +++++++++++++++++++ .../docs/panel/heatmap/index.md | 38 +++++++++++++++++++ .../docs/panel/histogram/index.md | 38 +++++++++++++++++++ .../docs/panel/logs/index.md | 38 +++++++++++++++++++ .../docs/panel/news/index.md | 38 +++++++++++++++++++ .../docs/panel/nodeGraph/index.md | 38 +++++++++++++++++++ .../docs/panel/pieChart/index.md | 38 +++++++++++++++++++ .../docs/panel/stat/index.md | 38 +++++++++++++++++++ .../docs/panel/stateTimeline/index.md | 38 +++++++++++++++++++ .../docs/panel/statusHistory/index.md | 38 +++++++++++++++++++ .../docs/panel/table/index.md | 38 +++++++++++++++++++ .../docs/panel/text/index.md | 38 +++++++++++++++++++ .../docs/panel/timeSeries/index.md | 38 +++++++++++++++++++ .../docs/panel/trend/index.md | 38 +++++++++++++++++++ .../docs/panel/xyChart/index.md | 38 +++++++++++++++++++ gen/grafonnet-v11.0.0/panel.libsonnet | 12 ++++++ generator/core.libsonnet | 9 +++-- 52 files changed, 1917 insertions(+), 4 deletions(-) diff --git a/docs/API/panel/alertList/index.md b/docs/API/panel/alertList/index.md index 6a2b1e89..0061f5a7 100644 --- a/docs/API/panel/alertList/index.md +++ b/docs/API/panel/alertList/index.md @@ -71,6 +71,7 @@ grafonnet.panel.alertList * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -78,8 +79,10 @@ grafonnet.panel.alertList * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -727,6 +730,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -804,6 +819,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -829,6 +856,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/annotationsList/index.md b/docs/API/panel/annotationsList/index.md index d2471a58..0cd1707c 100644 --- a/docs/API/panel/annotationsList/index.md +++ b/docs/API/panel/annotationsList/index.md @@ -33,6 +33,7 @@ grafonnet.panel.annotationsList * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -40,8 +41,10 @@ grafonnet.panel.annotationsList * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -300,6 +303,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -377,6 +392,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -402,6 +429,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/barChart/index.md b/docs/API/panel/barChart/index.md index 8865ac7d..14ccb544 100644 --- a/docs/API/panel/barChart/index.md +++ b/docs/API/panel/barChart/index.md @@ -90,6 +90,7 @@ grafonnet.panel.barChart * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -97,8 +98,10 @@ grafonnet.panel.barChart * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -938,6 +941,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1015,6 +1030,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1040,6 +1067,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/barGauge/index.md b/docs/API/panel/barGauge/index.md index 109cf349..033c65a4 100644 --- a/docs/API/panel/barGauge/index.md +++ b/docs/API/panel/barGauge/index.md @@ -44,6 +44,7 @@ grafonnet.panel.barGauge * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -51,8 +52,10 @@ grafonnet.panel.barGauge * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -418,6 +421,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -495,6 +510,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -520,6 +547,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/candlestick/index.md b/docs/API/panel/candlestick/index.md index 9ad9263a..b20031ea 100644 --- a/docs/API/panel/candlestick/index.md +++ b/docs/API/panel/candlestick/index.md @@ -119,6 +119,7 @@ grafonnet.panel.candlestick * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -126,8 +127,10 @@ grafonnet.panel.candlestick * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1267,6 +1270,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1344,6 +1359,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1369,6 +1396,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/canvas/index.md b/docs/API/panel/canvas/index.md index 5d8a9652..3fa434f5 100644 --- a/docs/API/panel/canvas/index.md +++ b/docs/API/panel/canvas/index.md @@ -34,6 +34,7 @@ grafonnet.panel.canvas * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -41,8 +42,10 @@ grafonnet.panel.canvas * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -287,6 +290,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -364,6 +379,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -389,6 +416,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/dashboardList/index.md b/docs/API/panel/dashboardList/index.md index a5139210..1f92a987 100644 --- a/docs/API/panel/dashboardList/index.md +++ b/docs/API/panel/dashboardList/index.md @@ -34,6 +34,7 @@ grafonnet.panel.dashboardList * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -41,8 +42,10 @@ grafonnet.panel.dashboardList * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -311,6 +314,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -388,6 +403,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -413,6 +440,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/datagrid/index.md b/docs/API/panel/datagrid/index.md index 85b34082..a8832f76 100644 --- a/docs/API/panel/datagrid/index.md +++ b/docs/API/panel/datagrid/index.md @@ -23,6 +23,7 @@ grafonnet.panel.datagrid * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -30,8 +31,10 @@ grafonnet.panel.datagrid * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -172,6 +175,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -249,6 +264,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -274,6 +301,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/debug/index.md b/docs/API/panel/debug/index.md index 25d472c5..3eb99e15 100644 --- a/docs/API/panel/debug/index.md +++ b/docs/API/panel/debug/index.md @@ -29,6 +29,7 @@ grafonnet.panel.debug * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -36,8 +37,10 @@ grafonnet.panel.debug * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -239,6 +242,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -316,6 +331,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -341,6 +368,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/gauge/index.md b/docs/API/panel/gauge/index.md index 2781e4ff..50d4a44a 100644 --- a/docs/API/panel/gauge/index.md +++ b/docs/API/panel/gauge/index.md @@ -41,6 +41,7 @@ grafonnet.panel.gauge * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -48,8 +49,10 @@ grafonnet.panel.gauge * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -378,6 +381,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -455,6 +470,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -480,6 +507,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/geomap/index.md b/docs/API/panel/geomap/index.md index c1a2e05e..0d8bb8c4 100644 --- a/docs/API/panel/geomap/index.md +++ b/docs/API/panel/geomap/index.md @@ -73,6 +73,7 @@ grafonnet.panel.geomap * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -80,8 +81,10 @@ grafonnet.panel.geomap * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -738,6 +741,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -815,6 +830,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -840,6 +867,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/heatmap/index.md b/docs/API/panel/heatmap/index.md index 336c823d..7d0f3e63 100644 --- a/docs/API/panel/heatmap/index.md +++ b/docs/API/panel/heatmap/index.md @@ -132,6 +132,7 @@ grafonnet.panel.heatmap * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -139,8 +140,10 @@ grafonnet.panel.heatmap * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1353,6 +1356,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1430,6 +1445,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1455,6 +1482,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/histogram/index.md b/docs/API/panel/histogram/index.md index a939871f..e09fae1d 100644 --- a/docs/API/panel/histogram/index.md +++ b/docs/API/panel/histogram/index.md @@ -78,6 +78,7 @@ grafonnet.panel.histogram * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -85,8 +86,10 @@ grafonnet.panel.histogram * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -794,6 +797,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -871,6 +886,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -896,6 +923,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/logs/index.md b/docs/API/panel/logs/index.md index 3aef7888..6f1f2d22 100644 --- a/docs/API/panel/logs/index.md +++ b/docs/API/panel/logs/index.md @@ -31,6 +31,7 @@ grafonnet.panel.logs * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -38,8 +39,10 @@ grafonnet.panel.logs * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -276,6 +279,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -353,6 +368,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -378,6 +405,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/news/index.md b/docs/API/panel/news/index.md index 3790c6ee..2cc7b47e 100644 --- a/docs/API/panel/news/index.md +++ b/docs/API/panel/news/index.md @@ -24,6 +24,7 @@ grafonnet.panel.news * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -31,8 +32,10 @@ grafonnet.panel.news * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -184,6 +187,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -261,6 +276,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -286,6 +313,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/nodeGraph/index.md b/docs/API/panel/nodeGraph/index.md index c9ed6b66..96e1eb65 100644 --- a/docs/API/panel/nodeGraph/index.md +++ b/docs/API/panel/nodeGraph/index.md @@ -35,6 +35,7 @@ grafonnet.panel.nodeGraph * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -42,8 +43,10 @@ grafonnet.panel.nodeGraph * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -288,6 +291,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -365,6 +380,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -390,6 +417,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/pieChart/index.md b/docs/API/panel/pieChart/index.md index c299041f..65d414c9 100644 --- a/docs/API/panel/pieChart/index.md +++ b/docs/API/panel/pieChart/index.md @@ -70,6 +70,7 @@ grafonnet.panel.pieChart * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -77,8 +78,10 @@ grafonnet.panel.pieChart * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -686,6 +689,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -763,6 +778,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -788,6 +815,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/stat/index.md b/docs/API/panel/stat/index.md index 75d91558..71c9f647 100644 --- a/docs/API/panel/stat/index.md +++ b/docs/API/panel/stat/index.md @@ -42,6 +42,7 @@ grafonnet.panel.stat * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -49,8 +50,10 @@ grafonnet.panel.stat * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -391,6 +394,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -468,6 +483,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -493,6 +520,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/stateTimeline/index.md b/docs/API/panel/stateTimeline/index.md index 6d71036f..86dd8435 100644 --- a/docs/API/panel/stateTimeline/index.md +++ b/docs/API/panel/stateTimeline/index.md @@ -62,6 +62,7 @@ grafonnet.panel.stateTimeline * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -69,8 +70,10 @@ grafonnet.panel.stateTimeline * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -597,6 +600,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -674,6 +689,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -699,6 +726,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/statusHistory/index.md b/docs/API/panel/statusHistory/index.md index 5f80aec6..e1ef08d9 100644 --- a/docs/API/panel/statusHistory/index.md +++ b/docs/API/panel/statusHistory/index.md @@ -61,6 +61,7 @@ grafonnet.panel.statusHistory * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -68,8 +69,10 @@ grafonnet.panel.statusHistory * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -584,6 +587,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -661,6 +676,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -686,6 +713,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/table/index.md b/docs/API/panel/table/index.md index d5c25b8b..4abb29f1 100644 --- a/docs/API/panel/table/index.md +++ b/docs/API/panel/table/index.md @@ -144,6 +144,7 @@ grafonnet.panel.table * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -151,8 +152,10 @@ grafonnet.panel.table * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1493,6 +1496,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1570,6 +1585,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1595,6 +1622,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/text/index.md b/docs/API/panel/text/index.md index 82e0a100..360f83b4 100644 --- a/docs/API/panel/text/index.md +++ b/docs/API/panel/text/index.md @@ -30,6 +30,7 @@ grafonnet.panel.text * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -37,8 +38,10 @@ grafonnet.panel.text * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -252,6 +255,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -329,6 +344,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -354,6 +381,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/timeSeries/index.md b/docs/API/panel/timeSeries/index.md index fd6c263b..f3961b6e 100644 --- a/docs/API/panel/timeSeries/index.md +++ b/docs/API/panel/timeSeries/index.md @@ -107,6 +107,7 @@ grafonnet.panel.timeSeries * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -114,8 +115,10 @@ grafonnet.panel.timeSeries * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1119,6 +1122,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1196,6 +1211,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1221,6 +1248,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/trend/index.md b/docs/API/panel/trend/index.md index f5e75a2a..01db8500 100644 --- a/docs/API/panel/trend/index.md +++ b/docs/API/panel/trend/index.md @@ -102,6 +102,7 @@ grafonnet.panel.trend * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -109,8 +110,10 @@ grafonnet.panel.trend * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1072,6 +1075,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1149,6 +1164,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1174,6 +1201,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/docs/API/panel/xyChart/index.md b/docs/API/panel/xyChart/index.md index 42142405..40bc0dc9 100644 --- a/docs/API/panel/xyChart/index.md +++ b/docs/API/panel/xyChart/index.md @@ -110,6 +110,7 @@ grafonnet.panel.xyChart * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -117,8 +118,10 @@ grafonnet.panel.xyChart * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1126,6 +1129,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1203,6 +1218,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1228,6 +1255,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet 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 6a2b1e89..0061f5a7 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md @@ -71,6 +71,7 @@ grafonnet.panel.alertList * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -78,8 +79,10 @@ grafonnet.panel.alertList * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -727,6 +730,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -804,6 +819,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -829,6 +856,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md index d2471a58..0cd1707c 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md @@ -33,6 +33,7 @@ grafonnet.panel.annotationsList * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -40,8 +41,10 @@ grafonnet.panel.annotationsList * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -300,6 +303,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -377,6 +392,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -402,6 +429,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet 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 8865ac7d..14ccb544 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md @@ -90,6 +90,7 @@ grafonnet.panel.barChart * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -97,8 +98,10 @@ grafonnet.panel.barChart * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -938,6 +941,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1015,6 +1030,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1040,6 +1067,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md b/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md index 109cf349..033c65a4 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md @@ -44,6 +44,7 @@ grafonnet.panel.barGauge * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -51,8 +52,10 @@ grafonnet.panel.barGauge * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -418,6 +421,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -495,6 +510,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -520,6 +547,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```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 9ad9263a..b20031ea 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md @@ -119,6 +119,7 @@ grafonnet.panel.candlestick * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -126,8 +127,10 @@ grafonnet.panel.candlestick * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1267,6 +1270,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1344,6 +1359,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1369,6 +1396,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md b/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md index 5d8a9652..3fa434f5 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md @@ -34,6 +34,7 @@ grafonnet.panel.canvas * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -41,8 +42,10 @@ grafonnet.panel.canvas * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -287,6 +290,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -364,6 +379,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -389,6 +416,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```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..1f92a987 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md @@ -34,6 +34,7 @@ grafonnet.panel.dashboardList * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -41,8 +42,10 @@ grafonnet.panel.dashboardList * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -311,6 +314,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -388,6 +403,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -413,6 +440,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md b/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md index 85b34082..a8832f76 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md @@ -23,6 +23,7 @@ grafonnet.panel.datagrid * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -30,8 +31,10 @@ grafonnet.panel.datagrid * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -172,6 +175,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -249,6 +264,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -274,6 +301,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/debug/index.md b/gen/grafonnet-v11.0.0/docs/panel/debug/index.md index 25d472c5..3eb99e15 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/debug/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/debug/index.md @@ -29,6 +29,7 @@ grafonnet.panel.debug * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -36,8 +37,10 @@ grafonnet.panel.debug * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -239,6 +242,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -316,6 +331,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -341,6 +368,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md b/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md index 2781e4ff..50d4a44a 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md @@ -41,6 +41,7 @@ grafonnet.panel.gauge * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -48,8 +49,10 @@ grafonnet.panel.gauge * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -378,6 +381,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -455,6 +470,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -480,6 +507,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md b/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md index c1a2e05e..0d8bb8c4 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md @@ -73,6 +73,7 @@ grafonnet.panel.geomap * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -80,8 +81,10 @@ grafonnet.panel.geomap * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -738,6 +741,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -815,6 +830,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -840,6 +867,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md b/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md index 336c823d..7d0f3e63 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md @@ -132,6 +132,7 @@ grafonnet.panel.heatmap * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -139,8 +140,10 @@ grafonnet.panel.heatmap * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1353,6 +1356,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1430,6 +1445,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1455,6 +1482,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet 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 a939871f..e09fae1d 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md @@ -78,6 +78,7 @@ grafonnet.panel.histogram * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -85,8 +86,10 @@ grafonnet.panel.histogram * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -794,6 +797,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -871,6 +886,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -896,6 +923,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/logs/index.md b/gen/grafonnet-v11.0.0/docs/panel/logs/index.md index 3aef7888..6f1f2d22 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/logs/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/logs/index.md @@ -31,6 +31,7 @@ grafonnet.panel.logs * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -38,8 +39,10 @@ grafonnet.panel.logs * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -276,6 +279,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -353,6 +368,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -378,6 +405,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/news/index.md b/gen/grafonnet-v11.0.0/docs/panel/news/index.md index 3790c6ee..2cc7b47e 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/news/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/news/index.md @@ -24,6 +24,7 @@ grafonnet.panel.news * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -31,8 +32,10 @@ grafonnet.panel.news * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -184,6 +187,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -261,6 +276,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -286,6 +313,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md index c9ed6b66..96e1eb65 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md @@ -35,6 +35,7 @@ grafonnet.panel.nodeGraph * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -42,8 +43,10 @@ grafonnet.panel.nodeGraph * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -288,6 +291,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -365,6 +380,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -390,6 +417,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md b/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md index c299041f..65d414c9 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md @@ -70,6 +70,7 @@ grafonnet.panel.pieChart * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -77,8 +78,10 @@ grafonnet.panel.pieChart * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -686,6 +689,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -763,6 +778,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -788,6 +815,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/stat/index.md b/gen/grafonnet-v11.0.0/docs/panel/stat/index.md index 75d91558..71c9f647 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/stat/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/stat/index.md @@ -42,6 +42,7 @@ grafonnet.panel.stat * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -49,8 +50,10 @@ grafonnet.panel.stat * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -391,6 +394,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -468,6 +483,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -493,6 +520,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet 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 6d71036f..86dd8435 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md @@ -62,6 +62,7 @@ grafonnet.panel.stateTimeline * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -69,8 +70,10 @@ grafonnet.panel.stateTimeline * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -597,6 +600,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -674,6 +689,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -699,6 +726,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet 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 5f80aec6..e1ef08d9 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md @@ -61,6 +61,7 @@ grafonnet.panel.statusHistory * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -68,8 +69,10 @@ grafonnet.panel.statusHistory * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -584,6 +587,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -661,6 +676,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -686,6 +713,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```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..4abb29f1 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/table/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/table/index.md @@ -144,6 +144,7 @@ grafonnet.panel.table * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -151,8 +152,10 @@ grafonnet.panel.table * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1493,6 +1496,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1570,6 +1585,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1595,6 +1622,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/docs/panel/text/index.md b/gen/grafonnet-v11.0.0/docs/panel/text/index.md index 82e0a100..360f83b4 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/text/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/text/index.md @@ -30,6 +30,7 @@ grafonnet.panel.text * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -37,8 +38,10 @@ grafonnet.panel.text * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -252,6 +255,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -329,6 +344,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -354,6 +381,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```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 fd6c263b..f3961b6e 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md @@ -107,6 +107,7 @@ grafonnet.panel.timeSeries * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -114,8 +115,10 @@ grafonnet.panel.timeSeries * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1119,6 +1122,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1196,6 +1211,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1221,6 +1248,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```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 f5e75a2a..01db8500 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/trend/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/trend/index.md @@ -102,6 +102,7 @@ grafonnet.panel.trend * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -109,8 +110,10 @@ grafonnet.panel.trend * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1072,6 +1075,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1149,6 +1164,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1174,6 +1201,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet 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 42142405..40bc0dc9 100644 --- a/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md +++ b/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md @@ -110,6 +110,7 @@ grafonnet.panel.xyChart * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) * [`fn withLinks(value)`](#fn-paneloptionswithlinks) * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) * [`fn withTitle(value)`](#fn-paneloptionswithtitle) @@ -117,8 +118,10 @@ grafonnet.panel.xyChart * [`obj queryOptions`](#obj-queryoptions) * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) * [`fn withInterval(value)`](#fn-queryoptionswithinterval) * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) * [`fn withTargets(value)`](#fn-queryoptionswithtargets) * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) @@ -1126,6 +1129,18 @@ PARAMETERS: * **value** (`array`) Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels #### fn panelOptions.withRepeat ```jsonnet @@ -1203,6 +1218,18 @@ PARAMETERS: * **value** (`object`) Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header #### fn queryOptions.withInterval ```jsonnet @@ -1228,6 +1255,17 @@ PARAMETERS: * **value** (`number`) The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds #### fn queryOptions.withTargets ```jsonnet diff --git a/gen/grafonnet-v11.0.0/panel.libsonnet b/gen/grafonnet-v11.0.0/panel.libsonnet index 14bf068e..fb6d68a6 100644 --- a/gen/grafonnet-v11.0.0/panel.libsonnet +++ b/gen/grafonnet-v11.0.0/panel.libsonnet @@ -29,6 +29,10 @@ then value else [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): { + maxPerRow: value, + }, '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, withRepeat(value): { repeat: value, @@ -118,6 +122,10 @@ withInterval(value): { interval: 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): { + queryCachingTTL: 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, @@ -126,6 +134,10 @@ withTimeShift(value): { timeShift: 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): { + hideTimeOverride: 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: diff --git a/generator/core.libsonnet b/generator/core.libsonnet index 7ba95893..e7374ebf 100644 --- a/generator/core.libsonnet +++ b/generator/core.libsonnet @@ -190,7 +190,8 @@ local utils = import './utils.libsonnet'; 'withTransparent', 'withLinks', // depend on sub package 'withLinksMixin', - 'withRepeat', // missing maxPerRow + 'withMaxPerRow', + 'withRepeat', 'withRepeatDirection', 'withPluginVersion', 'withType', @@ -200,11 +201,11 @@ local utils = import './utils.libsonnet'; 'withDatasource', // In as-code, default to per-query datasources 'withDatasourceMixin', 'withMaxDataPoints', - 'withInterval', //minInterval - //'queryCachingTTL', // not in schema + 'withInterval', + 'withQueryCachingTTL', 'withTimeFrom', //relativeTime 'withTimeShift', - //'hideTimeOverride', // not in schema + 'withHideTimeOverride', 'withTargets', // query, expression or recorded query, not clear from schema 'withTargetsMixin', 'withTransformations', // depend on very bare sub package for a very useful feature