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/statetimelinepanelcfg/schema-reference.md
+50 -50
View File
@@ -13,100 +13,100 @@ title: StateTimelinePanelCfg kind
| Property | Type | Required | Description |
|--------------------|-----------------------------|----------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
| Property | Type | Required | Default | Description |
|--------------------|-----------------------------|----------|---------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Description |
|---------------|---------------------------------------|----------|------------------------------------------------------------------------------|
| `fillOpacity` | integer | No | Default: `70`.<br/>Constraint: `>=0 & <=100`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | Default: `0`.<br/>Constraint: `>=0 & <=10`. |
| Property | Type | Required | Default | Description |
|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. |
### HideSeriesConfig
TODO docs
| Property | Type | Required | Description |
|-----------|---------|----------|-------------|
| `legend` | boolean | **Yes** | |
| `tooltip` | boolean | **Yes** | |
| `viz` | boolean | **Yes** | |
| Property | Type | Required | Default | Description |
|-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
| Property | Type | Required | Description |
|------------|---------------------------------------|----------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
| Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
| Property | Type | Required | Description |
|---------------|-----------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `rowHeight` | number | **Yes** | Controls the row height Default: `0.9`. |
| `showValue` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
| `alignValue` | string | No | Controls the value alignment in the TimelineChart component<br/>Possible values are: `center`, `left`, `right`. |
| `mergeValues` | boolean | No | Merge equal consecutive values Default: `true`. |
| `timezone` | string[] | No | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
| Property | Type | Required | Default | Description |
|---------------|-----------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `rowHeight` | number | **Yes** | `0.9` | Controls the row height |
| `showValue` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
| `alignValue` | string | No | | Controls the value alignment in the TimelineChart component<br/>Possible values are: `center`, `left`, `right`. |
| `mergeValues` | boolean | No | `true` | Merge equal consecutive values |
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Description |
|----------|---------------------------------------|----------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
| Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
| Property | Type | Required | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | |
| `displayMode` | string | **Yes** | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
| `placement` | string | **Yes** | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | |
| `asTable` | boolean | No | |
| `isVisible` | boolean | No | |
| `sortBy` | string | No | |
| `sortDesc` | boolean | No | |
| `width` | number | No | |
| Property | Type | Required | Default | Description |
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | |
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### OptionsWithTimezones
TODO docs
| Property | Type | Required | Description |
|------------|----------|----------|-------------|
| `timezone` | string[] | No | |
| Property | Type | Required | Default | Description |
|------------|----------|----------|---------|-------------|
| `timezone` | string[] | No | | |
### OptionsWithTooltip
TODO docs
| Property | Type | Required | Description |
|-----------|-----------------------------------------|----------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
| Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Description |
|----------|--------|----------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
| Property | Type | Required | Default | Description |
|----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |