Files
Tania 0409cfd116 Docs: Add Default column to generated schema docs (#64550)
Docs: Add  column to generated schema docs
2023-03-22 18:42:28 +01:00

4.3 KiB

keywords title
grafana
schema
TablePanelCfg kind

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

TablePanelCfg

Maturity: experimental

Version: 0.0

Property Type Required Default Description
PanelOptions object Yes

PanelOptions

Property Type Required Default Description
frameIndex number Yes 0 Represents the index of the selected frame
showHeader boolean Yes true Controls whether the panel should show the header
footer object No map[countRows:false reducer:[] show:false] Controls footer options
showRowNums boolean No false Controls whether the columns should be numbered
showTypeIcons boolean No false Controls whether the header should show icons for the column types
sortBy TableSortByFieldState[] No Used to control row sorting

<<<<<<< HEAD

Property Type Required Description
frameIndex number Yes Represents the index of the selected frame Default: 0.
showHeader boolean Yes Controls whether the panel should show the header Default: true.
cellHeight string No Height of a table cell
Possible values are: sm, md, lg.
footer object No Controls footer options Default: map[countRows:false reducer:[] show:false].
showRowNums boolean No Controls whether the columns should be numbered Default: false.
showTypeIcons boolean No Controls whether the header should show icons for the column types Default: false.
sortBy TableSortByFieldState[] No Used to control row sorting

main

TableSortByFieldState

Sort by field state

Property Type Required Default Description
displayName string Yes Sets the display name of the field to sort by
desc boolean No Flag used to indicate descending sort order

Controls footer options

Property Type Required Default Description
object Possible types are: , .