2023-05-30 08:56:18 -04:00
---
keywords:
2023-07-18 11:03:16 +02:00
- grafana
- schema
2023-07-20 11:48:12 +02:00
labels:
products:
- cloud
- enterprise
- oss
2023-05-30 08:56:18 -04:00
title: BarGaugePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## BarGaugePanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/stats-and-license pages to have labels cloud,enterprise
* Set alerting pages to have labels cloud,enterprise,oss
* Set breaking-changes pages to have labels cloud,enterprise,oss
* Set dashboards pages to have labels cloud,enterprise,oss
* Set datasources pages to have labels cloud,enterprise,oss
* Set explore pages to have labels cloud,enterprise,oss
* Set fundamentals pages to have labels cloud,enterprise,oss
* Set introduction/grafana-cloud pages to have labels cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set panels-visualizations pages to have labels cloud,enterprise,oss
* Set release-notes pages to have labels cloud,enterprise,oss
* Set search pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
#### Version: 0.0
2023-05-30 08:56:18 -04:00
2023-07-18 11:03:16 +02:00
2023-05-30 08:56:18 -04:00
| Property | Type | Required | Default | Description |
2023-07-18 11:03:16 +02:00
|-----------|--------------------|----------|---------|-------------|
2023-05-30 08:56:18 -04:00
| `Options` | [object ](#options ) | **Yes** | | |
### Options
It extends [SingleStatBaseOptions ](#singlestatbaseoptions ).
| Property | Type | Required | Default | Description |
2023-07-18 11:03:16 +02:00
|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
2023-05-30 08:56:18 -04:00
| `displayMode` | string | **Yes** | | Enum expressing the possible display modes< br /> for the bar gauge component of Grafana UI< br /> Possible values are: `basic` , `lcd` , `gradient` . |
2023-11-07 07:11:13 +02:00
| `maxVizHeight` | uint32 | **Yes** | `300` | |
| `minVizHeight` | uint32 | **Yes** | `75` | |
| `minVizWidth` | uint32 | **Yes** | `75` | |
2023-10-05 18:31:03 +02:00
| `namePlacement` | string | **Yes** | | Allows for the bar gauge name to be placed explicitly< br /> Possible values are: `auto` , `top` , `left` . |
2023-05-30 08:56:18 -04:00
| `showUnfilled` | boolean | **Yes** | `true` | |
2023-11-07 07:11:13 +02:00
| `sizing` | string | **Yes** | | Allows for the bar gauge size to be set explicitly< br /> Possible values are: `auto` , `manual` . |
2023-05-30 08:56:18 -04:00
| `valueMode` | string | **Yes** | | Allows for the table cell gauge display type to set the gauge mode.< br /> Possible values are: `color` , `text` , `hidden` . |
2023-07-18 11:03:16 +02:00
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))* < br /> TODO docs< br /> Possible values are: `auto` , `vertical` , `horizontal` . |
| `reduceOptions` | [ReduceDataOptions ](#reducedataoptions ) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))* < br /> TODO docs |
| `text` | [VizTextDisplayOptions ](#viztextdisplayoptions ) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))* < br /> TODO docs |
2023-05-30 08:56:18 -04:00
### ReduceDataOptions
TODO docs
2023-07-18 11:03:16 +02:00
| Property | Type | Required | Default | Description |
|----------|----------|----------|---------|---------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | | If true show each row value |
2023-05-30 08:56:18 -04:00
### SingleStatBaseOptions
TODO docs
It extends [OptionsWithTextFormatting ](#optionswithtextformatting ).
| Property | Type | Required | Default | Description |
2023-07-18 11:03:16 +02:00
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
2023-05-30 08:56:18 -04:00
| `orientation` | string | **Yes** | | TODO docs< br /> Possible values are: `auto` , `vertical` , `horizontal` . |
| `reduceOptions` | [ReduceDataOptions ](#reducedataoptions ) | **Yes** | | TODO docs |
2023-07-18 11:03:16 +02:00
| `text` | [VizTextDisplayOptions ](#viztextdisplayoptions ) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))* < br /> TODO docs |
2023-05-30 08:56:18 -04:00
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 11:03:16 +02:00
|----------|-------------------------------------------------|----------|---------|-------------|
2023-05-30 08:56:18 -04:00
| `text` | [VizTextDisplayOptions ](#viztextdisplayoptions ) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 11:03:16 +02:00
|-------------|--------|----------|---------|--------------------------|
2023-05-30 08:56:18 -04:00
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |
2023-07-18 11:03:16 +02:00