Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: release v11.3.0 #235

Merged
merged 1 commit into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: generate regenerate localmkdocs test

LATEST := v11.2.0
LATEST := v11.3.0

generate: gen/grafonnet-latest

Expand Down
161 changes: 160 additions & 1 deletion docs/API/panel/barGauge/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ grafonnet.panel.barGauge
* [`fn withUid(value)`](#fn-librarypanelwithuid)
* [`obj options`](#obj-options)
* [`fn withDisplayMode(value="gradient")`](#fn-optionswithdisplaymode)
* [`fn withLegend(value)`](#fn-optionswithlegend)
* [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin)
* [`fn withMaxVizHeight(value=300)`](#fn-optionswithmaxvizheight)
* [`fn withMinVizHeight(value=16)`](#fn-optionswithminvizheight)
* [`fn withMinVizWidth(value=8)`](#fn-optionswithminvizwidth)
Expand All @@ -30,6 +32,17 @@ grafonnet.panel.barGauge
* [`fn withText(value)`](#fn-optionswithtext)
* [`fn withTextMixin(value)`](#fn-optionswithtextmixin)
* [`fn withValueMode(value="color")`](#fn-optionswithvaluemode)
* [`obj legend`](#obj-optionslegend)
* [`fn withAsTable(value=true)`](#fn-optionslegendwithastable)
* [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs)
* [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin)
* [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode)
* [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible)
* [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement)
* [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend)
* [`fn withSortBy(value)`](#fn-optionslegendwithsortby)
* [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc)
* [`fn withWidth(value)`](#fn-optionslegendwithwidth)
* [`obj reduceOptions`](#obj-optionsreduceoptions)
* [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs)
* [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin)
Expand Down Expand Up @@ -141,6 +154,28 @@ PARAMETERS:

Enum expressing the possible display modes
for the bar gauge component of Grafana UI
#### fn options.withLegend

```jsonnet
options.withLegend(value)
```

PARAMETERS:

* **value** (`object`)

TODO docs
#### fn options.withLegendMixin

```jsonnet
options.withLegendMixin(value)
```

PARAMETERS:

* **value** (`object`)

TODO docs
#### fn options.withMaxVizHeight

```jsonnet
Expand Down Expand Up @@ -187,7 +222,7 @@ PARAMETERS:

* **value** (`string`)
- default value: `"auto"`
- valid values: `"auto"`, `"top"`, `"left"`
- valid values: `"auto"`, `"top"`, `"left"`, `"hidden"`

Allows for the bar gauge name to be placed explicitly
#### fn options.withOrientation
Expand Down Expand Up @@ -284,6 +319,130 @@ PARAMETERS:
- valid values: `"color"`, `"text"`, `"hidden"`

Allows for the table cell gauge display type to set the gauge mode.
#### obj options.legend


##### fn options.legend.withAsTable

```jsonnet
options.legend.withAsTable(value=true)
```

PARAMETERS:

* **value** (`boolean`)
- default value: `true`


##### fn options.legend.withCalcs

```jsonnet
options.legend.withCalcs(value=[])
```

PARAMETERS:

* **value** (`array`)
- default value: `[]`


##### fn options.legend.withCalcsMixin

```jsonnet
options.legend.withCalcsMixin(value=[])
```

PARAMETERS:

* **value** (`array`)
- default value: `[]`


##### fn options.legend.withDisplayMode

```jsonnet
options.legend.withDisplayMode(value="list")
```

PARAMETERS:

* **value** (`string`)
- default value: `"list"`
- valid values: `"list"`, `"table"`, `"hidden"`

TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
##### fn options.legend.withIsVisible

```jsonnet
options.legend.withIsVisible(value=true)
```

PARAMETERS:

* **value** (`boolean`)
- default value: `true`


##### fn options.legend.withPlacement

```jsonnet
options.legend.withPlacement(value="bottom")
```

PARAMETERS:

* **value** (`string`)
- default value: `"bottom"`
- valid values: `"bottom"`, `"right"`

TODO docs
##### fn options.legend.withShowLegend

```jsonnet
options.legend.withShowLegend(value=true)
```

PARAMETERS:

* **value** (`boolean`)
- default value: `true`


##### fn options.legend.withSortBy

```jsonnet
options.legend.withSortBy(value)
```

PARAMETERS:

* **value** (`string`)


##### fn options.legend.withSortDesc

```jsonnet
options.legend.withSortDesc(value=true)
```

PARAMETERS:

* **value** (`boolean`)
- default value: `true`


##### fn options.legend.withWidth

```jsonnet
options.legend.withWidth(value)
```

PARAMETERS:

* **value** (`number`)


#### obj options.reduceOptions


Expand Down
8 changes: 4 additions & 4 deletions examples/redMethod/output.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"y": 1
},
"id": 2,
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -77,7 +77,7 @@
"y": 1
},
"id": 3,
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -138,7 +138,7 @@
"y": 10
},
"id": 5,
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -174,7 +174,7 @@
"y": 10
},
"id": 6,
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down
22 changes: 11 additions & 11 deletions examples/runtimeDashboard/output.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -128,7 +128,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -200,7 +200,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -245,7 +245,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -295,7 +295,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -352,7 +352,7 @@
"unit": "s"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -422,7 +422,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -487,7 +487,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -534,7 +534,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -595,7 +595,7 @@
"unit": "s"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -665,7 +665,7 @@
"displayMode": "table"
}
},
"pluginVersion": "v11.2.0",
"pluginVersion": "v11.3.0",
"targets": [
{
"datasource": {
Expand Down
2 changes: 1 addition & 1 deletion examples/simple/output.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
w: 24,
},
id: 1,
pluginVersion: 'v11.2.0',
pluginVersion: 'v11.3.0',
targets: [
{
datasource: {
Expand Down
2 changes: 1 addition & 1 deletion gen/grafonnet-latest/jsonnetfile.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion gen/grafonnet-latest/main.libsonnet

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading