mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 05:02:12 +08:00
33fd83f7e3
* kindsys: Adapt to new PanelCfg schema interface * building locally * Remove Panel prefix in cue files * Regenerate * Update imports * fixup! Merge branch 'remove-panel-prefix' into sdboyer/redundant-panelcfg-prefixes * Fix formatting --------- Co-authored-by: Ryan McKinley <ryantxu@gmail.com> Co-authored-by: Tania B <yalyna.ts@gmail.com>
42 lines
3.4 KiB
Markdown
42 lines
3.4 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 | Default | Description |
|
|
|----------------|------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------|
|
|
| `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
|
|
| `CodeOptions` | [object](#codeoptions) | **Yes** | | |
|
|
| `Options` | [object](#options) | **Yes** | | |
|
|
| `TextMode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
|
|
|
|
### CodeOptions
|
|
|
|
| Property | Type | Required | Default | Description |
|
|
|-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------|
|
|
| `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
|
|
| `showLineNumbers` | boolean | **Yes** | `false` | |
|
|
| `showMiniMap` | boolean | **Yes** | `false` | |
|
|
|
|
### Options
|
|
|
|
| Property | Type | Required | Default | Description |
|
|
|-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------|
|
|
| `content` | string | **Yes** | `# Title | |
|
|
| | | | | |
|
|
| | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | |
|
|
| `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
|
|
| `code` | [CodeOptions](#codeoptions) | No | | |
|
|
|
|
|