mirror of
https://github.com/grafana/grafana.git
synced 2025-09-24 06:46:15 +08:00
25756b49a3
* Remove duplicated sections * Regenerate docs * Refactor schema.sections func (#63079) * Refactor schema.sections func * Small refactors --------- Co-authored-by: Joan López de la Franca Beltran <5459617+joanlopez@users.noreply.github.com>
40 lines
3.0 KiB
Markdown
40 lines
3.0 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 | |
|
|
|
|
|