public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add Default column to generated schema docs (#64550)

Browse Source 
Docs: Add  column to generated schema docs
This commit is contained in:
Tania
2023-03-22 18:42:28 +01:00
committed by GitHub
parent 3cd952b8ba
commit 0409cfd116
36 changed files with 1591 additions and 1565 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md
+21 -10
View File
@@ -13,12 +13,22 @@ title: TablePanelCfg kind
| Property | Type | Required | Description |
|----------------|-------------------------|----------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
| Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
<<<<<<< HEAD
| 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](#footer) | 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](#tablesortbyfieldstate)[] | No | | Used to control row sorting |
=======
| Property | Type | Required | Description |
|-----------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------|
| `frameIndex` | number | **Yes** | Represents the index of the selected frame Default: `0`. |
@@ -28,22 +38,23 @@ title: TablePanelCfg kind
| `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](#tablesortbyfieldstate)[] | No | Used to control row sorting |
>>>>>>> main
### TableSortByFieldState
Sort by field state
| Property | Type | Required | Description |
|---------------|---------|----------|-----------------------------------------------|
| `displayName` | string | **Yes** | Sets the display name of the field to sort by |
| `desc` | boolean | No | Flag used to indicate descending sort order |
| 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 |
### Footer
Controls footer options
| Property | Type | Required | Description |
|----------|-----------------------------------|----------|-------------|
| `object` | Possible types are: [](#), [](#). | | |
| Property | Type | Required | Default | Description |
|----------|-----------------------------------|----------|---------|-------------|
| `object` | Possible types are: [](#), [](#). | | |