mirror of https://github.com/grafana/grafana
Docs: run the api-extractor on master to update docs (#23726)
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.pull/23741/head
Marcus Andersson
6 years ago
committed by
GitHub
parent
017767ae39
commit
a2d741f60f
@ -0,0 +1,45 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "AppEvent" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## AppEvents.AppEvent interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface AppEvent<T> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { AppEvents } from '@grafana/data'; |
||||
const { AppEvent } = AppEvents; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [name](#name-property) | <code>string</code> | | |
||||
| [payload](#payload-property) | <code>T</code> | | |
||||
|
||||
### name property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
readonly name: string; |
||||
``` |
||||
|
||||
### payload property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
payload?: T; |
||||
``` |
||||
@ -0,0 +1,89 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "ApplyFieldOverrideOptions" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## ApplyFieldOverrideOptions interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface ApplyFieldOverrideOptions |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { ApplyFieldOverrideOptions } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [autoMinMax](#autominmax-property) | <code>boolean</code> | | |
||||
| [data](#data-property) | <code>DataFrame[]</code> | | |
||||
| [fieldConfig](#fieldconfig-property) | <code>FieldConfigSource</code> | | |
||||
| [fieldConfigRegistry](#fieldconfigregistry-property) | <code>FieldConfigOptionsRegistry</code> | | |
||||
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | | |
||||
| [theme](#theme-property) | <code>GrafanaTheme</code> | | |
||||
| [timeZone](#timezone-property) | <code>TimeZone</code> | | |
||||
|
||||
### autoMinMax property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
autoMinMax?: boolean; |
||||
``` |
||||
|
||||
### data property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
data?: DataFrame[]; |
||||
``` |
||||
|
||||
### fieldConfig property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
fieldConfig: FieldConfigSource; |
||||
``` |
||||
|
||||
### fieldConfigRegistry property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
fieldConfigRegistry?: FieldConfigOptionsRegistry; |
||||
``` |
||||
|
||||
### replaceVariables property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
replaceVariables: InterpolateFunction; |
||||
``` |
||||
|
||||
### theme property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
theme: GrafanaTheme; |
||||
``` |
||||
|
||||
### timeZone property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
timeZone?: TimeZone; |
||||
``` |
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "booleanOverrideProcessor" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## booleanOverrideProcessor variable |
||||
|
||||
### booleanOverrideProcessor variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
booleanOverrideProcessor: (value: boolean, _context: FieldOverrideContext, _settings?: ThresholdsFieldConfigSettings | undefined) => boolean |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { booleanOverrideProcessor } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,71 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "CalculateFieldTransformerOptions" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## CalculateFieldTransformerOptions interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface CalculateFieldTransformerOptions |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { CalculateFieldTransformerOptions } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [alias](#alias-property) | <code>string</code> | | |
||||
| [include](#include-property) | <code>string</code> | | |
||||
| [nullValueMode](#nullvaluemode-property) | <code>NullValueMode</code> | | |
||||
| [reducer](#reducer-property) | <code>ReducerID</code> | | |
||||
| [replaceFields](#replacefields-property) | <code>boolean</code> | | |
||||
|
||||
### alias property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
alias?: string; |
||||
``` |
||||
|
||||
### include property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
include?: string; |
||||
``` |
||||
|
||||
### nullValueMode property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
nullValueMode?: NullValueMode; |
||||
``` |
||||
|
||||
### reducer property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
reducer: ReducerID; |
||||
``` |
||||
|
||||
### replaceFields property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
replaceFields?: boolean; |
||||
``` |
||||
@ -0,0 +1,35 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "ColorFieldConfigSettings" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## ColorFieldConfigSettings interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface ColorFieldConfigSettings |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { ColorFieldConfigSettings } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [enableNamedColors](#enablenamedcolors-property) | <code>boolean</code> | | |
||||
|
||||
### enableNamedColors property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
enableNamedColors?: boolean; |
||||
``` |
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "createOrderFieldsComparer" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## createOrderFieldsComparer variable |
||||
|
||||
### createOrderFieldsComparer variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
createOrderFieldsComparer: (indexByName: Record<string, number>) => (a: string, b: string) => number |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { createOrderFieldsComparer } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,46 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "DataConfigSource" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## DataConfigSource interface |
||||
|
||||
Describes and API for exposing panel specific data configurations. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface DataConfigSource |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { DataConfigSource } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [getFieldOverrideOptions](#getfieldoverrideoptions-property) | <code>() => ApplyFieldOverrideOptions | undefined</code> | | |
||||
| [getTransformations](#gettransformations-property) | <code>() => DataTransformerConfig[] | undefined</code> | | |
||||
|
||||
### getFieldOverrideOptions property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
getFieldOverrideOptions: () => ApplyFieldOverrideOptions | undefined; |
||||
``` |
||||
|
||||
### getTransformations property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
getTransformations: () => DataTransformerConfig[] | undefined; |
||||
``` |
||||
@ -0,0 +1,22 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "DataLinksFieldConfigSettings" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## DataLinksFieldConfigSettings interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface DataLinksFieldConfigSettings |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { DataLinksFieldConfigSettings } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "dataLinksOverrideProcessor" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## dataLinksOverrideProcessor variable |
||||
|
||||
### dataLinksOverrideProcessor variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
dataLinksOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: DataLinksFieldConfigSettings | undefined) => DataLink[] |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { dataLinksOverrideProcessor } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,35 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "DataQueryTimings" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## DataQueryTimings interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface DataQueryTimings |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { DataQueryTimings } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [dataProcessingTime](#dataprocessingtime-property) | <code>number</code> | | |
||||
|
||||
### dataProcessingTime property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
dataProcessingTime: number; |
||||
``` |
||||
@ -0,0 +1,36 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "doStandardCalcs" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## doStandardCalcs() function |
||||
|
||||
### doStandardCalcs() function |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare function doStandardCalcs(field: Field, ignoreNulls: boolean, nullAsZero: boolean): FieldCalcs; |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { doStandardCalcs } from '@grafana/data'; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| field | <code>Field</code> | | |
||||
| ignoreNulls | <code>boolean</code> | | |
||||
| nullAsZero | <code>boolean</code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`FieldCalcs` |
||||
|
||||
@ -0,0 +1,86 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "FeatureToggles" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## FeatureToggles interface |
||||
|
||||
Describes available feature toggles in Grafana. These can be configured via the `conf/custom.ini` to enable features under development or not yet available in stable version. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface FeatureToggles |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { FeatureToggles } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [expressions](#expressions-property) | <code>boolean</code> | | |
||||
| [meta](#meta-property) | <code>boolean</code> | | |
||||
| [newEdit](#newedit-property) | <code>boolean</code> | | |
||||
| [newVariables](#newvariables-property) | <code>boolean</code> | | |
||||
| [tracingIntegration](#tracingintegration-property) | <code>boolean</code> | | |
||||
| [transformations](#transformations-property) | <code>boolean</code> | | |
||||
|
||||
### expressions property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
expressions: boolean; |
||||
``` |
||||
|
||||
### meta property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
meta: boolean; |
||||
``` |
||||
|
||||
## Remarks |
||||
|
||||
Available only in Grafana Enterprise |
||||
|
||||
### newEdit property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
newEdit: boolean; |
||||
``` |
||||
|
||||
### newVariables property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
newVariables: boolean; |
||||
``` |
||||
|
||||
### tracingIntegration property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
tracingIntegration: boolean; |
||||
``` |
||||
|
||||
### transformations property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
transformations: boolean; |
||||
``` |
||||
@ -0,0 +1,155 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "FieldConfigEditorBuilder" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## FieldConfigEditorBuilder class |
||||
|
||||
Fluent API for declarative creation of field config option editors |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare class FieldConfigEditorBuilder<TOptions> extends OptionsUIRegistryBuilder<TOptions, FieldConfigEditorProps<any, any>, FieldConfigPropertyItem<TOptions>> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { FieldConfigEditorBuilder } from '@grafana/data'; |
||||
``` |
||||
<b>Methods</b> |
||||
|
||||
| Method | Modifiers | Description | |
||||
| --- | --- | --- | |
||||
| [addBooleanSwitch(config)](#addbooleanswitch-method) | | | |
||||
| [addColorPicker(config)](#addcolorpicker-method) | | | |
||||
| [addNumberInput(config)](#addnumberinput-method) | | | |
||||
| [addRadio(config)](#addradio-method) | | | |
||||
| [addSelect(config)](#addselect-method) | | | |
||||
| [addTextInput(config)](#addtextinput-method) | | | |
||||
| [addUnitPicker(config)](#addunitpicker-method) | | | |
||||
|
||||
### addBooleanSwitch method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addBooleanSwitch<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings, boolean>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings, boolean></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addColorPicker method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addColorPicker<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addNumberInput method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addNumberInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addRadio method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addRadio<TOption, TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings, TOption>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings, TOption></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addSelect method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addSelect<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: FieldConfigEditorConfig<TOptions, TSettings, TOption>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings, TOption></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addTextInput method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addTextInput<TSettings>(config: FieldConfigEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addUnitPicker method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addUnitPicker<TSettings = any>(config: FieldConfigEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>FieldConfigEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
@ -0,0 +1,126 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "FieldConfigEditorConfig" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## FieldConfigEditorConfig interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface FieldConfigEditorConfig<TOptions, TSettings = any, TValue = any> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { FieldConfigEditorConfig } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [category](#category-property) | <code>string[]</code> | Array of strings representing category of the field config property. First element in the array will make option render as collapsible section. | |
||||
| [defaultValue](#defaultvalue-property) | <code>TValue</code> | | |
||||
| [description](#description-property) | <code>string</code> | Description of the field config property. Will be displayed in the UI as form element description. | |
||||
| [name](#name-property) | <code>string</code> | Name of the field config property. Will be displayed in the UI as form element label. | |
||||
| [path](#path-property) | <code>(keyof TOptions & string) | string</code> | Path of the field config property to control. | |
||||
| [settings](#settings-property) | <code>TSettings</code> | Custom settings of the editor. | |
||||
| [shouldApply](#shouldapply-property) | <code>(field: Field) => boolean</code> | Function that allows specifying whether or not this field config should apply to a given field. | |
||||
| [showIf](#showif-property) | <code>(currentConfig: TOptions) => boolean</code> | Function that enables configuration of when field config property editor should be shown based on current panel field config. | |
||||
|
||||
### category property |
||||
|
||||
Array of strings representing category of the field config property. First element in the array will make option render as collapsible section. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
category?: string[]; |
||||
``` |
||||
|
||||
### defaultValue property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
defaultValue?: TValue; |
||||
``` |
||||
|
||||
### description property |
||||
|
||||
Description of the field config property. Will be displayed in the UI as form element description. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
description?: string; |
||||
``` |
||||
|
||||
### name property |
||||
|
||||
Name of the field config property. Will be displayed in the UI as form element label. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
name: string; |
||||
``` |
||||
|
||||
### path property |
||||
|
||||
Path of the field config property to control. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
path: (keyof TOptions & string) | string; |
||||
``` |
||||
|
||||
## Example |
||||
|
||||
Given field config object of a type: |
||||
|
||||
```ts |
||||
interface CustomFieldConfig { |
||||
a: { |
||||
b: string; |
||||
} |
||||
} |
||||
|
||||
``` |
||||
path can be either 'a' or 'a.b'. |
||||
|
||||
### settings property |
||||
|
||||
Custom settings of the editor. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
settings?: TSettings; |
||||
``` |
||||
|
||||
### shouldApply property |
||||
|
||||
Function that allows specifying whether or not this field config should apply to a given field. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
shouldApply?: (field: Field) => boolean; |
||||
``` |
||||
|
||||
### showIf property |
||||
|
||||
Function that enables configuration of when field config property editor should be shown based on current panel field config. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
showIf?: (currentConfig: TOptions) => boolean; |
||||
``` |
||||
@ -0,0 +1,22 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "FieldConfigOptionsRegistry" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## FieldConfigOptionsRegistry class |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare class FieldConfigOptionsRegistry extends Registry<FieldConfigPropertyItem> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { FieldConfigOptionsRegistry } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,40 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "FieldConfigProperty" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## FieldConfigProperty enum |
||||
|
||||
### FieldConfigProperty enum |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare enum FieldConfigProperty |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { FieldConfigProperty } from '@grafana/data'; |
||||
``` |
||||
|
||||
## Enumeration Members |
||||
|
||||
| Member | Value | Description | |
||||
| --- | --- | --- | |
||||
| Color | <code>"color"</code> | | |
||||
| Decimals | <code>"decimals"</code> | | |
||||
| Links | <code>"links"</code> | | |
||||
| Mappings | <code>"mappings"</code> | | |
||||
| Max | <code>"max"</code> | | |
||||
| Min | <code>"min"</code> | | |
||||
| NoValue | <code>"noValue"</code> | | |
||||
| Thresholds | <code>"thresholds"</code> | | |
||||
| Title | <code>"title"</code> | | |
||||
| Unit | <code>"unit"</code> | | |
||||
|
||||
@ -0,0 +1,365 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "GrafanaConfig" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## GrafanaConfig interface |
||||
|
||||
Describes all the different Grafana configuration values available for an instance. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface GrafanaConfig |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { GrafanaConfig } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [alertingEnabled](#alertingenabled-property) | <code>boolean</code> | | |
||||
| [alertingErrorOrTimeout](#alertingerrorortimeout-property) | <code>string</code> | | |
||||
| [alertingMinInterval](#alertingmininterval-property) | <code>number</code> | | |
||||
| [alertingNoDataOrNullValues](#alertingnodataornullvalues-property) | <code>string</code> | | |
||||
| [allowOrgCreate](#alloworgcreate-property) | <code>boolean</code> | | |
||||
| [appSubUrl](#appsuburl-property) | <code>string</code> | | |
||||
| [authProxyEnabled](#authproxyenabled-property) | <code>boolean</code> | | |
||||
| [autoAssignOrg](#autoassignorg-property) | <code>boolean</code> | | |
||||
| [bootData](#bootdata-property) | <code>any</code> | | |
||||
| [buildInfo](#buildinfo-property) | <code>BuildInfo</code> | | |
||||
| [datasources](#datasources-property) | <code>{</code><br/><code> [str: string]: DataSourceInstanceSettings;</code><br/><code> }</code> | | |
||||
| [defaultDatasource](#defaultdatasource-property) | <code>string</code> | | |
||||
| [disableLoginForm](#disableloginform-property) | <code>boolean</code> | | |
||||
| [disableSanitizeHtml](#disablesanitizehtml-property) | <code>boolean</code> | | |
||||
| [disableUserSignUp](#disableusersignup-property) | <code>boolean</code> | | |
||||
| [editorsCanAdmin](#editorscanadmin-property) | <code>boolean</code> | | |
||||
| [exploreEnabled](#exploreenabled-property) | <code>boolean</code> | | |
||||
| [externalUserMngInfo](#externalusermnginfo-property) | <code>string</code> | | |
||||
| [externalUserMngLinkName](#externalusermnglinkname-property) | <code>string</code> | | |
||||
| [externalUserMngLinkUrl](#externalusermnglinkurl-property) | <code>string</code> | | |
||||
| [featureToggles](#featuretoggles-property) | <code>FeatureToggles</code> | | |
||||
| [ldapEnabled](#ldapenabled-property) | <code>boolean</code> | | |
||||
| [licenseInfo](#licenseinfo-property) | <code>LicenseInfo</code> | | |
||||
| [loginError](#loginerror-property) | <code>any</code> | | |
||||
| [loginHint](#loginhint-property) | <code>any</code> | | |
||||
| [minRefreshInterval](#minrefreshinterval-property) | <code>string</code> | | |
||||
| [navTree](#navtree-property) | <code>any</code> | | |
||||
| [newPanelTitle](#newpaneltitle-property) | <code>string</code> | | |
||||
| [oauth](#oauth-property) | <code>any</code> | | |
||||
| [panels](#panels-property) | <code>{</code><br/><code> [key: string]: PanelPluginMeta;</code><br/><code> }</code> | | |
||||
| [passwordHint](#passwordhint-property) | <code>any</code> | | |
||||
| [pluginsToPreload](#pluginstopreload-property) | <code>string[]</code> | | |
||||
| [samlEnabled](#samlenabled-property) | <code>boolean</code> | | |
||||
| [theme](#theme-property) | <code>GrafanaTheme</code> | | |
||||
| [verifyEmailEnabled](#verifyemailenabled-property) | <code>boolean</code> | | |
||||
| [viewersCanEdit](#viewerscanedit-property) | <code>boolean</code> | | |
||||
| [windowTitlePrefix](#windowtitleprefix-property) | <code>string</code> | | |
||||
|
||||
### alertingEnabled property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
alertingEnabled: boolean; |
||||
``` |
||||
|
||||
### alertingErrorOrTimeout property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
alertingErrorOrTimeout: string; |
||||
``` |
||||
|
||||
### alertingMinInterval property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
alertingMinInterval: number; |
||||
``` |
||||
|
||||
### alertingNoDataOrNullValues property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
alertingNoDataOrNullValues: string; |
||||
``` |
||||
|
||||
### allowOrgCreate property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
allowOrgCreate: boolean; |
||||
``` |
||||
|
||||
### appSubUrl property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
appSubUrl: string; |
||||
``` |
||||
|
||||
### authProxyEnabled property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
authProxyEnabled: boolean; |
||||
``` |
||||
|
||||
### autoAssignOrg property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
autoAssignOrg: boolean; |
||||
``` |
||||
|
||||
### bootData property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
bootData: any; |
||||
``` |
||||
|
||||
### buildInfo property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
buildInfo: BuildInfo; |
||||
``` |
||||
|
||||
### datasources property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
datasources: { |
||||
[str: string]: DataSourceInstanceSettings; |
||||
}; |
||||
``` |
||||
|
||||
### defaultDatasource property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
defaultDatasource: string; |
||||
``` |
||||
|
||||
### disableLoginForm property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
disableLoginForm: boolean; |
||||
``` |
||||
|
||||
### disableSanitizeHtml property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
disableSanitizeHtml: boolean; |
||||
``` |
||||
|
||||
### disableUserSignUp property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
disableUserSignUp: boolean; |
||||
``` |
||||
|
||||
### editorsCanAdmin property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
editorsCanAdmin: boolean; |
||||
``` |
||||
|
||||
### exploreEnabled property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
exploreEnabled: boolean; |
||||
``` |
||||
|
||||
### externalUserMngInfo property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
externalUserMngInfo: string; |
||||
``` |
||||
|
||||
### externalUserMngLinkName property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
externalUserMngLinkName: string; |
||||
``` |
||||
|
||||
### externalUserMngLinkUrl property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
externalUserMngLinkUrl: string; |
||||
``` |
||||
|
||||
### featureToggles property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
featureToggles: FeatureToggles; |
||||
``` |
||||
|
||||
### ldapEnabled property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
ldapEnabled: boolean; |
||||
``` |
||||
|
||||
### licenseInfo property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
licenseInfo: LicenseInfo; |
||||
``` |
||||
|
||||
### loginError property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
loginError: any; |
||||
``` |
||||
|
||||
### loginHint property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
loginHint: any; |
||||
``` |
||||
|
||||
### minRefreshInterval property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
minRefreshInterval: string; |
||||
``` |
||||
|
||||
### navTree property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
navTree: any; |
||||
``` |
||||
|
||||
### newPanelTitle property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
newPanelTitle: string; |
||||
``` |
||||
|
||||
### oauth property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
oauth: any; |
||||
``` |
||||
|
||||
### panels property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
panels: { |
||||
[key: string]: PanelPluginMeta; |
||||
}; |
||||
``` |
||||
|
||||
### passwordHint property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
passwordHint: any; |
||||
``` |
||||
|
||||
### pluginsToPreload property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
pluginsToPreload: string[]; |
||||
``` |
||||
|
||||
### samlEnabled property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
samlEnabled: boolean; |
||||
``` |
||||
|
||||
### theme property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
theme: GrafanaTheme; |
||||
``` |
||||
|
||||
### verifyEmailEnabled property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
verifyEmailEnabled: boolean; |
||||
``` |
||||
|
||||
### viewersCanEdit property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
viewersCanEdit: boolean; |
||||
``` |
||||
|
||||
### windowTitlePrefix property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
windowTitlePrefix: string; |
||||
``` |
||||
@ -0,0 +1,37 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "guessFieldTypeFromNameAndValue" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## guessFieldTypeFromNameAndValue() function |
||||
|
||||
### guessFieldTypeFromNameAndValue() function |
||||
|
||||
Given a name and value, this will pick a reasonable field type |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare function guessFieldTypeFromNameAndValue(name: string, v: any): FieldType; |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { guessFieldTypeFromNameAndValue } from '@grafana/data'; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| name | <code>string</code> | | |
||||
| v | <code>any</code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`FieldType` |
||||
|
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "identityOverrideProcessor" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## identityOverrideProcessor variable |
||||
|
||||
### identityOverrideProcessor variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
identityOverrideProcessor: <T>(value: T, _context: FieldOverrideContext, _settings: any) => T |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { identityOverrideProcessor } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,64 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "LicenseInfo" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## LicenseInfo interface |
||||
|
||||
Describes the license information about the current running instance of Grafana. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface LicenseInfo |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { LicenseInfo } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [expiry](#expiry-property) | <code>number</code> | | |
||||
| [hasLicense](#haslicense-property) | <code>boolean</code> | | |
||||
| [licenseUrl](#licenseurl-property) | <code>string</code> | | |
||||
| [stateInfo](#stateinfo-property) | <code>string</code> | | |
||||
|
||||
### expiry property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
expiry: number; |
||||
``` |
||||
|
||||
### hasLicense property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
hasLicense: boolean; |
||||
``` |
||||
|
||||
### licenseUrl property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
licenseUrl: string; |
||||
``` |
||||
|
||||
### stateInfo property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
stateInfo: string; |
||||
``` |
||||
@ -0,0 +1,31 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "locationUtil" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## locationUtil variable |
||||
|
||||
### locationUtil variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
locationUtil: { |
||||
initialize: ({ getConfig, buildParamsFromVariables, getTimeRangeForUrl }: LocationUtilDependencies) => void; |
||||
stripBaseFromUrl: (url: string) => string; |
||||
assureBaseUrl: (url: string) => string; |
||||
getTimeRangeUrlParams: () => string | null; |
||||
getVariablesUrlParams: (scopedVars?: ScopedVars | undefined) => string | null; |
||||
processUrl: (url: string) => string; |
||||
} |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { locationUtil } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "onUpdateDatasourceJsonDataOptionChecked" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## onUpdateDatasourceJsonDataOptionChecked variable |
||||
|
||||
### onUpdateDatasourceJsonDataOptionChecked variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
onUpdateDatasourceJsonDataOptionChecked: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (event: import("react").SyntheticEvent<HTMLInputElement, Event>) => void |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { onUpdateDatasourceJsonDataOptionChecked } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,35 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "OrganizeFieldsTransformerOptions" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## OrganizeFieldsTransformerOptions interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface OrganizeFieldsTransformerOptions extends OrderFieldsTransformerOptions, RenameFieldsTransformerOptions |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { OrganizeFieldsTransformerOptions } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [excludeByName](#excludebyname-property) | <code>Record<string, boolean></code> | | |
||||
|
||||
### excludeByName property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
excludeByName: Record<string, boolean>; |
||||
``` |
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "PanelOptionEditorsRegistry" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## PanelOptionEditorsRegistry type |
||||
|
||||
### PanelOptionEditorsRegistry type |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare type PanelOptionEditorsRegistry = Registry<PanelOptionsEditorItem>; |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { PanelOptionEditorsRegistry } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,155 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "PanelOptionsEditorBuilder" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## PanelOptionsEditorBuilder class |
||||
|
||||
Fluent API for declarative creation of panel options |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export declare class PanelOptionsEditorBuilder<TOptions> extends OptionsUIRegistryBuilder<TOptions, StandardEditorProps, PanelOptionsEditorItem<TOptions>> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { PanelOptionsEditorBuilder } from '@grafana/data'; |
||||
``` |
||||
<b>Methods</b> |
||||
|
||||
| Method | Modifiers | Description | |
||||
| --- | --- | --- | |
||||
| [addBooleanSwitch(config)](#addbooleanswitch-method) | | | |
||||
| [addColorPicker(config)](#addcolorpicker-method) | | | |
||||
| [addNumberInput(config)](#addnumberinput-method) | | | |
||||
| [addRadio(config)](#addradio-method) | | | |
||||
| [addSelect(config)](#addselect-method) | | | |
||||
| [addTextInput(config)](#addtextinput-method) | | | |
||||
| [addUnitPicker(config)](#addunitpicker-method) | | | |
||||
|
||||
### addBooleanSwitch method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addBooleanSwitch<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings, boolean>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings, boolean></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addColorPicker method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addColorPicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addNumberInput method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addNumberInput<TSettings>(config: PanelOptionsEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addRadio method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addRadio<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: PanelOptionsEditorConfig<TOptions, TSettings, TOption>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings, TOption></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addSelect method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addSelect<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config: PanelOptionsEditorConfig<TOptions, TSettings, TOption>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings, TOption></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addTextInput method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addTextInput<TSettings>(config: PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
### addUnitPicker method |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
addUnitPicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string>): this; |
||||
``` |
||||
<b>Parameters</b> |
||||
|
||||
| Parameter | Type | Description | |
||||
| --- | --- | --- | |
||||
| config | <code>PanelOptionsEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string></code> | | |
||||
|
||||
<b>Returns:</b> |
||||
|
||||
`this` |
||||
|
||||
@ -0,0 +1,115 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "PanelOptionsEditorConfig" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## PanelOptionsEditorConfig interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface PanelOptionsEditorConfig<TOptions, TSettings = any, TValue = any> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { PanelOptionsEditorConfig } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [category](#category-property) | <code>string[]</code> | Array of strings representing category of the option. First element in the array will make option render as collapsible section. | |
||||
| [defaultValue](#defaultvalue-property) | <code>TValue</code> | | |
||||
| [description](#description-property) | <code>string</code> | Description of the option. Will be displayed in the UI as form element description. | |
||||
| [name](#name-property) | <code>string</code> | Name of the option. Will be displayed in the UI as form element label. | |
||||
| [path](#path-property) | <code>(keyof TOptions & string) | string</code> | Path of the option property to control. | |
||||
| [settings](#settings-property) | <code>TSettings</code> | al Custom settings of the editor. | |
||||
| [showIf](#showif-property) | <code>(currentConfig: TOptions) => boolean</code> | Function that enables configuration of when option editor should be shown based on current panel option properties. | |
||||
|
||||
### category property |
||||
|
||||
Array of strings representing category of the option. First element in the array will make option render as collapsible section. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
category?: string[]; |
||||
``` |
||||
|
||||
### defaultValue property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
defaultValue?: TValue; |
||||
``` |
||||
|
||||
### description property |
||||
|
||||
Description of the option. Will be displayed in the UI as form element description. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
description?: string; |
||||
``` |
||||
|
||||
### name property |
||||
|
||||
Name of the option. Will be displayed in the UI as form element label. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
name: string; |
||||
``` |
||||
|
||||
### path property |
||||
|
||||
Path of the option property to control. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
path: (keyof TOptions & string) | string; |
||||
``` |
||||
|
||||
## Example |
||||
|
||||
Given options object of a type: |
||||
|
||||
```ts |
||||
interface Options { |
||||
a: { |
||||
b: string; |
||||
} |
||||
} |
||||
|
||||
``` |
||||
path can be either 'a' or 'a.b'. |
||||
|
||||
### settings property |
||||
|
||||
al Custom settings of the editor. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
settings?: TSettings; |
||||
``` |
||||
|
||||
### showIf property |
||||
|
||||
Function that enables configuration of when option editor should be shown based on current panel option properties. |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
showIf?: (currentConfig: TOptions) => boolean; |
||||
``` |
||||
@ -0,0 +1,22 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "PanelOptionsEditorItem" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## PanelOptionsEditorItem interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface PanelOptionsEditorItem<TOptions = any, TValue = any, TSettings = any> extends OptionsEditorItem<TOptions, TSettings, PanelOptionsEditorProps<TValue>, TValue> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { PanelOptionsEditorItem } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,22 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "PanelOptionsEditorProps" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## PanelOptionsEditorProps interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface PanelOptionsEditorProps<TValue> extends StandardEditorProps<TValue> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { PanelOptionsEditorProps } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,72 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "QueryResultMetaNotice" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## QueryResultMetaNotice interface |
||||
|
||||
QueryResultMetaNotice is a structure that provides user notices for query result data |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface QueryResultMetaNotice |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { QueryResultMetaNotice } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [inspect](#inspect-property) | <code>'meta' | 'error' | 'data' | 'stats'</code> | Optionally suggest an appropriate tab for the panel inspector | |
||||
| [link](#link-property) | <code>string</code> | An optional link that may be displayed in the UI. This value may be an absolute URL or relative to grafana root | |
||||
| [severity](#severity-property) | <code>'info' | 'warning' | 'error'</code> | Specify the notice severity | |
||||
| [text](#text-property) | <code>string</code> | Notice descriptive text | |
||||
|
||||
### inspect property |
||||
|
||||
Optionally suggest an appropriate tab for the panel inspector |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
inspect?: 'meta' | 'error' | 'data' | 'stats'; |
||||
``` |
||||
|
||||
### link property |
||||
|
||||
An optional link that may be displayed in the UI. This value may be an absolute URL or relative to grafana root |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
link?: string; |
||||
``` |
||||
|
||||
### severity property |
||||
|
||||
Specify the notice severity |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
severity: 'info' | 'warning' | 'error'; |
||||
``` |
||||
|
||||
### text property |
||||
|
||||
Notice descriptive text |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
text: string; |
||||
``` |
||||
@ -0,0 +1,44 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "QueryResultMetaStat" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## QueryResultMetaStat interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface QueryResultMetaStat extends FieldConfig |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { QueryResultMetaStat } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [title](#title-property) | <code>string</code> | | |
||||
| [value](#value-property) | <code>number</code> | | |
||||
|
||||
### title property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
title: string; |
||||
``` |
||||
|
||||
### value property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
value: number; |
||||
``` |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,35 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "SelectFieldConfigSettings" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## SelectFieldConfigSettings interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface SelectFieldConfigSettings<T> |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { SelectFieldConfigSettings } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [options](#options-property) | <code>Array<SelectableValue<T>></code> | | |
||||
|
||||
### options property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
options: Array<SelectableValue<T>>; |
||||
``` |
||||
@ -0,0 +1,24 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "selectOverrideProcessor" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## selectOverrideProcessor variable |
||||
|
||||
### selectOverrideProcessor variable |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
selectOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: SelectFieldConfigSettings<any> | undefined) => any |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { selectOverrideProcessor } from '@grafana/data'; |
||||
``` |
||||
@ -0,0 +1,35 @@ |
||||
+++ |
||||
# ----------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by API Documenter. |
||||
# ----------------------------------------------------------------------- |
||||
title = "SeriesToColumnsOptions" |
||||
keywords = ["grafana","documentation","sdk","@grafana/data"] |
||||
type = "docs" |
||||
draft = true |
||||
+++ |
||||
|
||||
## SeriesToColumnsOptions interface |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
export interface SeriesToColumnsOptions |
||||
``` |
||||
<b>Import</b> |
||||
|
||||
```typescript |
||||
import { SeriesToColumnsOptions } from '@grafana/data'; |
||||
``` |
||||
<b>Properties</b> |
||||
|
||||
| Property | Type | Description | |
||||
| --- | --- | --- | |
||||
| [byField](#byfield-property) | <code>string</code> | | |
||||
|
||||
### byField property |
||||
|
||||
<b>Signature</b> |
||||
|
||||
```typescript |
||||
byField?: string; |
||||
``` |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue