Robert Horvath
0fcc864bbb
* 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>
48 lines
3.9 KiB
Markdown
48 lines
3.9 KiB
Markdown
---
|
|
keywords:
|
|
- grafana
|
|
- schema
|
|
title: TextPanelCfg kind
|
|
---
|
|
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
|
|
|
## TextPanelCfg
|
|
|
|
#### Maturity: [experimental](../../../maturity/#experimental)
|
|
#### Version: 0.0
|
|
|
|
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------------|-------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------|
|
|
| `CodeLanguage` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. |
|
|
| `CodeOptions` | [object](#codeoptions) | **Yes** | |
|
|
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
|
| `TextMode` | string | **Yes** | Possible values are: `html`, `markdown`, `code`. |
|
|
|
|
### CodeOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|-------------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------|
|
|
| `language` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. |
|
|
| `showLineNumbers` | boolean | **Yes** | Default: `false`. |
|
|
| `showMiniMap` | boolean | **Yes** | Default: `false`. |
|
|
|
|
### PanelOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|-----------|-----------------------------|----------|------------------------------------------------------------------------------------------------------------|
|
|
| `content` | string | **Yes** | Default: `# Title<br/><br/>For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)`. |
|
|
| `mode` | string | **Yes** | Possible values are: `html`, `markdown`, `code`. |
|
|
| `code` | [CodeOptions](#codeoptions) | No | |
|
|
|
|
### CodeOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|-------------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------|
|
|
| `language` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. |
|
|
| `showLineNumbers` | boolean | **Yes** | Default: `false`. |
|
|
| `showMiniMap` | boolean | **Yes** | Default: `false`. |
|
|
|
|
|