Kindsys: Extend DocsJenny with support for 'allOf' (#62558)
* Kindsys: Extend DocsJenny with support for 'allOf' * Update generated docs * Multiple refinements * Minor fixes * Undo undesired changes * Fix * Fix linter complains --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
This commit is contained in:
Joan López de la Franca Beltran
committed by
GitHub
GitHub
parent
4d564f8b0a
commit
19ed9181e1
@@ -6,36 +6,178 @@ title: HistogramPanelCfg kind
|
||||
---
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
# HistogramPanelCfg kind
|
||||
## HistogramPanelCfg
|
||||
|
||||
#### Maturity: experimental
|
||||
#### Version: 0.0
|
||||
|
||||
## Maturity: experimental
|
||||
## Version: 0.0
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|--------------------|-----------------------------|----------|-------------|
|
||||
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
|
||||
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
||||
|
||||
## PanelFieldConfig
|
||||
### PanelFieldConfig
|
||||
|
||||
### Properties
|
||||
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------------|---------|----------|--------------------------------------------------------------------|
|
||||
| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`. |
|
||||
| `gradientMode` | string | No | TODO docs Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`. |
|
||||
| Property | Type | Required | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`. |
|
||||
| `gradientMode` | string | No | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`. |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
|
||||
## PanelOptions
|
||||
### AxisConfig
|
||||
|
||||
### Properties
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------------|---------|----------|--------------------------------------------------|
|
||||
| `bucketOffset` | integer | No | Offset buckets by this amount Default: `0`. |
|
||||
| `bucketSize` | integer | No | Size of each bucket |
|
||||
| `combine` | boolean | No | Combines multiple series into a single histogram |
|
||||
| Property | Type | Required | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | |
|
||||
| `axisColorMode` | string | No | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | |
|
||||
| `axisLabel` | string | No | |
|
||||
| `axisPlacement` | string | No | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | |
|
||||
| `axisSoftMin` | number | No | |
|
||||
| `axisWidth` | number | No | |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
|
||||
|
||||
### ScaleDistributionConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-------------------|--------|----------|--------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | |
|
||||
| `log` | number | No | |
|
||||
|
||||
### HideSeriesConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-----------|---------|----------|-------------|
|
||||
| `legend` | boolean | **Yes** | |
|
||||
| `tooltip` | boolean | **Yes** | |
|
||||
| `viz` | boolean | **Yes** | |
|
||||
|
||||
### HideableFieldConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|------------|---------------------------------------|----------|-------------|
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
|
||||
|
||||
### HideSeriesConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-----------|---------|----------|-------------|
|
||||
| `legend` | boolean | **Yes** | |
|
||||
| `tooltip` | boolean | **Yes** | |
|
||||
| `viz` | boolean | **Yes** | |
|
||||
|
||||
### ScaleDistributionConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-------------------|--------|----------|--------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | |
|
||||
| `log` | number | No | |
|
||||
|
||||
### PanelOptions
|
||||
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------------|-----------------------------------------|----------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `bucketOffset` | integer | No | Offset buckets by this amount Default: `0`. |
|
||||
| `bucketSize` | integer | No | Size of each bucket |
|
||||
| `combine` | boolean | No | Combines multiple series into a single histogram |
|
||||
|
||||
### OptionsWithLegend
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | 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 | |
|
||||
|
||||
### OptionsWithTooltip
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | 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`. |
|
||||
|
||||
### 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 | |
|
||||
|
||||
### 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`. |
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user