opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-02 02:26:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md
Tania 5f93e67419 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-22 18:58:49 -05:00

3.9 KiB
Raw Blame History

keywords title
grafana
schema
TextPanelCfg kind

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

TextPanelCfg kind

Maturity: experimental

Version: 0.0

Properties

Property Type Required Description
CodeLanguage string Yes Possible values are: plaintext, yaml, xml, typescript, sql, go, markdown, html, json. Default: plaintext.
CodeOptions object Yes
PanelOptions object Yes
TextMode string Yes Possible values are: html, markdown, code.

CodeOptions

Properties

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

Properties

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 No

CodeOptions

Properties

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.