root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 181 Packages Projects Releases Wiki Activity
grafana/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md

88 lines
7.2 KiB
Markdown
Raw Normal View History

Codegen: Generate docs for composable kinds (#61719) * Generate docs for composable kinds * Fix getting the kind schema * Generate composable kinds docs * Add disclaimer to the generated docs * Change docs disclaimer
2023-01-23 07:58:49 +08:00
---
keywords:
- grafana
- schema
title: BarGaugePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
## BarGaugePanelCfg
Docs: Add Schema maturity docs (#61963) * Docs: Add Schema maturity docs * Remove 'which category' section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Maturity process guides from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Defaults and Field optionality from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove MaybeRemove section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Milestone 3 and 4 from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Rearrange schema maturity docs * Regenerate schema docs after merge with main * Update Maturity docs headers, keep single h1 * Update wording in Schema docs Co-authored-by: Tania <yalyna.ts@gmail.com> * Regenerate docs after merge with main --------- Co-authored-by: sam boyer <sdboyer@grafana.com> Co-authored-by: Tania <yalyna.ts@gmail.com>
2023-02-07 18:02:05 +08:00
#### Maturity: [experimental](../../../maturity/#experimental)
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
#### Version: 0.0
Codegen: Generate docs for composable kinds (#61719) * Generate docs for composable kinds * Fix getting the kind schema * Generate composable kinds docs * Add disclaimer to the generated docs * Change docs disclaimer
2023-01-23 07:58:49 +08:00
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08:00
| Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
Codegen: Generate docs for composable kinds (#61719) * Generate docs for composable kinds * Fix getting the kind schema * Generate composable kinds docs * Add disclaimer to the generated docs * Change docs disclaimer
2023-01-23 07:58:49 +08:00
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08:00
<<<<<<< HEAD
| Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `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`. |
| `minVizHeight` | uint32 | **Yes** | `10` | |
| `minVizWidth` | uint32 | **Yes** | `0` | |
| `showUnfilled` | boolean | **Yes** | `true` | |
| `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 |
=======
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
| Property | Type | Required | Description |
|-----------------|-------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `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`. |
Codegen: Render constraints in generated docs (#63196) * Add constraints rendering * Generate docs * Fix constraint format * Add type alias * Compare numbers as strings * fixup! Compare numbers as strings * Add missing return
2023-02-10 19:40:50 +08:00
| `minVizHeight` | uint32 | **Yes** | Default: `10`. |
| `minVizWidth` | uint32 | **Yes** | Default: `0`. |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
| `showUnfilled` | boolean | **Yes** | Default: `true`. |
Table Panel: Add ability to use text color for value or hide value in gauge cell (#61477) * BarGauge: New value options * Fix typings for cell options, add new value mode option for bar gauge cells * Add BarGauge panel option, tests, and update test dashboard * Updated * Added default * Goodbye trusty console.log * Update * Merge changes from main * Update docs * Add valuemode doc changes * Update gdev dashboard * Update valueMode symbol name to valueDisplayMode * Use Enums as Opposed to literals, don't calculate values when hidden * Remove double import * Fix tests * One more test fix * Remove erroneous targets field, fix type of maxDataPoints * Strip nulls and add index field to Thresholds * Gen cue * remove bad targets again * Fixes --------- Co-authored-by: Kyle Cunningham <kyle@codeincarnate.com> Co-authored-by: sam boyer <sdboyer@grafana.com>
2023-03-10 21:41:46 +08:00
| `valueMode` | string | **Yes** | Allows for the table cell gauge display type to set the gauge mode.<br/>Possible values are: `color`, `text`, `hidden`. |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08: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 |
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08:00
>>>>>>> main
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### ReduceDataOptions
TODO docs
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08: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 |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### SingleStatBaseOptions
TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08:00
| Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### OptionsWithTextFormatting
TODO docs
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08:00
| Property | Type | Required | Default | Description |
|----------|-------------------------------------------------|----------|---------|-------------|
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
### VizTextDisplayOptions
TODO docs
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
2023-03-23 01:42:28 +08:00
| Property | Type | Required | Default | Description |
|-------------|--------|----------|---------|--------------------------|
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |
Kindsys: Extend DocsJenny with support for 'allOf' (#62558) * Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 23:12:31 +08:00
Codegen: Generate docs for composable kinds (#61719) * Generate docs for composable kinds * Fix getting the kind schema * Generate composable kinds docs * Add disclaimer to the generated docs * Change docs disclaimer
2023-01-23 07:58:49 +08:00