opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-30 20:52:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: enable packages reference docs for 7-beta (#23953)

Browse Source 
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
This commit is contained in:
Marcus Andersson
2020-04-28 09:53:58 +02:00
committed by GitHub
parent 5442b0ab4f
commit cc3fc18076
719 changed files with 1069 additions and 1030 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/menu.yaml
View File

@ -349,6 +349,8 @@
children:
- name: Developer resources
link: /developers/developer-resources/
- name: Packages reference
link: /packages_api/
- name: Contributor License Agreement (CLA)
link: /developers/cla/
- name: Docs Archive

2
docs/sources/packages_api/_index.md
View File

@ -5,7 +5,6 @@
title = "API Reference"
keywords = ["grafana","documentation","sdk"]
type = "docs"
draft = true
+++
## API Reference
@ -16,6 +15,7 @@ draft = true
| --- | --- |
| [@grafana/data](./data/) | A library containing most of the core functionality and data types used in Grafana. |
| [@grafana/e2e](./e2e/) | A library for writing end-to-end tests for Grafana and its ecosystem. |
| [@grafana/e2e-selectors](./e2e-selectors/) | A library containing the different design components of the Grafana ecosystem. |
| [@grafana/runtime](./runtime/) | A library containing services, configurations etc. used to interact with the Grafana engine. |
| [@grafana/ui](./ui/) | A library containing the different design components of the Grafana ecosystem. |

17
docs/sources/packages_api/data/_index.md
View File

@ -5,7 +5,6 @@
title = "@grafana/data"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## @grafana/data package
@ -64,6 +63,7 @@ A library containing most of the core functionality and data types used in Grafa
| [NullValueMode](./nullvaluemode/) | |
| [OrgRole](./orgrole/) | |
| [PluginIncludeType](./pluginincludetype/) | |
| [PluginSignatureStatus](./pluginsignaturestatus/) | |
| [PluginState](./pluginstate/) | |
| [PluginType](./plugintype/) | |
| [ReducerID](./reducerid/) | |
@ -145,7 +145,6 @@ A library containing most of the core functionality and data types used in Grafa
| Interface | Description |
| --- | --- |
| [AbsoluteTimeRange](./absolutetimerange/) | |
| [AngularPanelMenuItem](./angularpanelmenuitem/) | |
| [AnnotationEvent](./annotationevent/) | |
| [AnnotationQueryRequest](./annotationqueryrequest/) | Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md |
| [AppEvent](./appevent/) | |
@ -187,6 +186,9 @@ A library containing most of the core functionality and data types used in Grafa
| [DateTimeBuiltinFormat](./datetimebuiltinformat/) | |
| [DateTimeDuration](./datetimeduration/) | |
| [DateTimeLocale](./datetimelocale/) | |
| [DateTimeOptions](./datetimeoptions/) | |
| [DateTimeOptionsWhenParsing](./datetimeoptionswhenparsing/) | |
| [DateTimeOptionsWithFormat](./datetimeoptionswithformat/) | |
| [DecimalInfo](./decimalinfo/) | |
| [Dimension](./dimension/) | |
| [DisplayValue](./displayvalue/) | |
@ -243,7 +245,6 @@ A library containing most of the core functionality and data types used in Grafa
| [OrganizeFieldsTransformerOptions](./organizefieldstransformeroptions/) | |
| [PanelData](./paneldata/) | |
| [PanelEditorProps](./paneleditorprops/) | |
| [PanelMenuItem](./panelmenuitem/) | |
| [PanelModel](./panelmodel/) | |
| [PanelOptionsEditorConfig](./paneloptionseditorconfig/) | |
| [PanelOptionsEditorItem](./paneloptionseditoritem/) | |
@ -325,7 +326,12 @@ A library containing most of the core functionality and data types used in Grafa
| [dataLinksOverrideProcessor](./datalinksoverrideprocessor/) | |
| [dateTime](./datetime/) | |
| [dateTimeAsMoment](./datetimeasmoment/) | |
| [dateTimeFormat](./datetimeformat/) | |
| [dateTimeFormatISO](./datetimeformatiso/) | |
| [dateTimeFormatTimeAgo](./datetimeformattimeago/) | |
| [dateTimeFormatWithAbbrevation](./datetimeformatwithabbrevation/) | |
| [dateTimeForTimeZone](./datetimefortimezone/) | |
| [dateTimeParse](./datetimeparse/) | |
| [DEFAULT\_DATE\_TIME\_FORMAT](./default_date_time_format/) | |
| [DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT](./default_field_display_values_limit/) | |
| [DefaultTimeRange](./defaulttimerange/) | |
@ -375,6 +381,7 @@ A library containing most of the core functionality and data types used in Grafa
| [onUpdateDatasourceSecureJsonDataOptionSelect](./onupdatedatasourcesecurejsondataoptionselect/) | |
| [selectOverrideProcessor](./selectoverrideprocessor/) | |
| [setLocale](./setlocale/) | |
| [setTimeZoneResolver](./settimezoneresolver/) | |
| [standardEditorsRegistry](./standardeditorsregistry/) | |
| [standardFieldConfigEditorRegistry](./standardfieldconfigeditorregistry/) | |
| [standardTransformers](./standardtransformers/) | |
@ -383,6 +390,7 @@ A library containing most of the core functionality and data types used in Grafa
| [textUtil](./textutil/) | |
| [thresholdsOverrideProcessor](./thresholdsoverrideprocessor/) | |
| [TIME\_FORMAT](./time_format/) | |
| [timeZoneAbbrevation](./timezoneabbrevation/) | |
| [toDataFrame](./todataframe/) | |
| [toDuration](./toduration/) | |
| [toLegacyResponseData](./tolegacyresponsedata/) | |
@ -410,7 +418,9 @@ A library containing most of the core functionality and data types used in Grafa
| [DataSourceOptionsType](./datasourceoptionstype/) | |
| [DataSourceQueryType](./datasourcequerytype/) | |
| [DataTransformer](./datatransformer/) | Function that transform data frames (AKA transformer) |
| [DateTimeFormatter](./datetimeformatter/) | |
| [DateTimeInput](./datetimeinput/) | |
| [DateTimeParser](./datetimeparser/) | |
| [DecimalCount](./decimalcount/) | |
| [Dimensions](./dimensions/) | |
| [DisplayProcessor](./displayprocessor/) | |
@ -437,6 +447,7 @@ A library containing most of the core functionality and data types used in Grafa
| [TimeSeriesValue](./timeseriesvalue/) | |
| [TimeZone](./timezone/) | |
| [TimeZoneBrowser](./timezonebrowser/) | |
| [TimeZoneResolver](./timezoneresolver/) | |
| [TimeZoneUtc](./timezoneutc/) | |
| [UrlQueryMap](./urlquerymap/) | Type to represent the values parsed from the query string. |
| [UrlQueryValue](./urlqueryvalue/) | Type to represent the value of a single query variable. |

1
docs/sources/packages_api/data/absolutetimerange.md
View File

@ -5,7 +5,6 @@
title = "AbsoluteTimeRange"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AbsoluteTimeRange interface

1
docs/sources/packages_api/data/addlogleveltoseries.md
View File

@ -5,7 +5,6 @@
title = "addLogLevelToSeries"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## addLogLevelToSeries() function

89
docs/sources/packages_api/data/angularpanelmenuitem.md
View File

@ -1,89 +0,0 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "AngularPanelMenuItem"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AngularPanelMenuItem interface
<b>Signature</b>
```typescript
export interface AngularPanelMenuItem
```
<b>Import</b>
```typescript
import { AngularPanelMenuItem } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [click](#click-property) | <code>Function</code> | |
| [divider](#divider-property) | <code>boolean</code> | |
| [href](#href-property) | <code>string</code> | |
| [icon](#icon-property) | <code>string</code> | |
| [shortcut](#shortcut-property) | <code>string</code> | |
| [submenu](#submenu-property) | <code>any[]</code> | |
| [text](#text-property) | <code>string</code> | |
### click property
<b>Signature</b>
```typescript
click: Function;
```
### divider property
<b>Signature</b>
```typescript
divider: boolean;
```
### href property
<b>Signature</b>
```typescript
href: string;
```
### icon property
<b>Signature</b>
```typescript
icon: string;
```
### shortcut property
<b>Signature</b>
```typescript
shortcut: string;
```
### submenu property
<b>Signature</b>
```typescript
submenu: any[];
```
### text property
<b>Signature</b>
```typescript
text: string;
```

1
docs/sources/packages_api/data/annotationevent.md
View File

@ -5,7 +5,6 @@
title = "AnnotationEvent"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AnnotationEvent interface

1
docs/sources/packages_api/data/annotationqueryrequest.md
View File

@ -5,7 +5,6 @@
title = "AnnotationQueryRequest"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AnnotationQueryRequest interface

1
docs/sources/packages_api/data/appendedvectors.md
View File

@ -5,7 +5,6 @@
title = "AppendedVectors"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppendedVectors class

1
docs/sources/packages_api/data/appevent.md
View File

@ -5,7 +5,6 @@
title = "AppEvent"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvent interface

2
docs/sources/packages_api/data/appevents.md
View File

@ -5,7 +5,6 @@
title = "AppEvents"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvents namespace
@ -39,5 +38,6 @@ import { AppEvents } from '@grafana/data';
| Type Alias | Description |
| --- | --- |
| [AlertErrorPayload](./alerterrorpayload/) | |
| [AlertPayload](./alertpayload/) | |

3
docs/sources/packages_api/data/appevents/alerterror.md
View File

@ -5,7 +5,6 @@
title = "alertError"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvents.alertError variable
@ -15,7 +14,7 @@ draft = true
<b>Signature</b>
```typescript
alertError: AppEvent<AlertPayload>
alertError: AppEvent<AlertErrorPayload>
```
<b>Import</b>

24
docs/sources/packages_api/data/appevents/alerterrorpayload.md Normal file
View File

@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "AlertErrorPayload"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## AppEvents.AlertErrorPayload type
### AppEvents.AlertErrorPayload type
<b>Signature</b>
```typescript
export declare type AlertErrorPayload = [string, (string | Error)?];
```
<b>Import</b>
```typescript
import { AppEvents } from '@grafana/data';
const { AlertErrorPayload } = AppEvents;
```

1
docs/sources/packages_api/data/appevents/alertpayload.md
View File

@ -5,7 +5,6 @@
title = "AlertPayload"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvents.AlertPayload type

1
docs/sources/packages_api/data/appevents/alertsuccess.md
View File

@ -5,7 +5,6 @@
title = "alertSuccess"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvents.alertSuccess variable

1
docs/sources/packages_api/data/appevents/alertwarning.md
View File

@ -5,7 +5,6 @@
title = "alertWarning"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvents.alertWarning variable

1
docs/sources/packages_api/data/appevents/appevent.md
View File

@ -5,7 +5,6 @@
title = "AppEvent"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppEvents.AppEvent interface

1
docs/sources/packages_api/data/applyfieldoverrideoptions.md
View File

@ -5,7 +5,6 @@
title = "ApplyFieldOverrideOptions"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ApplyFieldOverrideOptions interface

1
docs/sources/packages_api/data/applyfieldoverrides.md
View File

@ -5,7 +5,6 @@
title = "applyFieldOverrides"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## applyFieldOverrides() function

1
docs/sources/packages_api/data/appplugin.md
View File

@ -5,7 +5,6 @@
title = "AppPlugin"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppPlugin class

1
docs/sources/packages_api/data/apppluginmeta.md
View File

@ -5,7 +5,6 @@
title = "AppPluginMeta"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppPluginMeta interface

1
docs/sources/packages_api/data/approotprops.md
View File

@ -5,7 +5,6 @@
title = "AppRootProps"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## AppRootProps interface

1
docs/sources/packages_api/data/arrayvector.md
View File

@ -5,7 +5,6 @@
title = "ArrayVector"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ArrayVector class

1
docs/sources/packages_api/data/arrowdataframe.md
View File

@ -5,7 +5,6 @@
title = "ArrowDataFrame"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ArrowDataFrame interface

1
docs/sources/packages_api/data/arrowtabletodataframe.md
View File

@ -5,7 +5,6 @@
title = "arrowTableToDataFrame"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## arrowTableToDataFrame() function

1
docs/sources/packages_api/data/base64stringtoarrowtable.md
View File

@ -5,7 +5,6 @@
title = "base64StringToArrowTable"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## base64StringToArrowTable() function

1
docs/sources/packages_api/data/booleanoverrideprocessor.md
View File

@ -5,7 +5,6 @@
title = "booleanOverrideProcessor"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## booleanOverrideProcessor variable

1
docs/sources/packages_api/data/buildinfo.md
View File

@ -5,7 +5,6 @@
title = "BuildInfo"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## BuildInfo interface

1
docs/sources/packages_api/data/calculatefieldstats.md
View File

@ -5,7 +5,6 @@
title = "calculateFieldStats"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## calculateFieldStats() function

1
docs/sources/packages_api/data/calculatefieldtransformeroptions.md
View File

@ -5,7 +5,6 @@
title = "CalculateFieldTransformerOptions"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CalculateFieldTransformerOptions interface

1
docs/sources/packages_api/data/calculatelogslabelstats.md
View File

@ -5,7 +5,6 @@
title = "calculateLogsLabelStats"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## calculateLogsLabelStats() function

1
docs/sources/packages_api/data/calculatestats.md
View File

@ -5,7 +5,6 @@
title = "calculateStats"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## calculateStats() function

1
docs/sources/packages_api/data/circulardataframe.md
View File

@ -5,7 +5,6 @@
title = "CircularDataFrame"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CircularDataFrame class

1
docs/sources/packages_api/data/circularvector.md
View File

@ -5,7 +5,6 @@
title = "CircularVector"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CircularVector class

1
docs/sources/packages_api/data/color.md
View File

@ -5,7 +5,6 @@
title = "Color"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## Color type

1
docs/sources/packages_api/data/colordefinition.md
View File

@ -5,7 +5,6 @@
title = "ColorDefinition"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ColorDefinition type

1
docs/sources/packages_api/data/colorfieldconfigsettings.md
View File

@ -5,7 +5,6 @@
title = "ColorFieldConfigSettings"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ColorFieldConfigSettings interface

1
docs/sources/packages_api/data/colorscheme.md
View File

@ -5,7 +5,6 @@
title = "ColorScheme"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ColorScheme enum

1
docs/sources/packages_api/data/column.md
View File

@ -5,7 +5,6 @@
title = "Column"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## Column interface

1
docs/sources/packages_api/data/configoverriderule.md
View File

@ -5,7 +5,6 @@
title = "ConfigOverrideRule"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ConfigOverrideRule interface

1
docs/sources/packages_api/data/constantvector.md
View File

@ -5,7 +5,6 @@
title = "ConstantVector"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## ConstantVector class

1
docs/sources/packages_api/data/coreapp.md
View File

@ -5,7 +5,6 @@
title = "CoreApp"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CoreApp enum

1
docs/sources/packages_api/data/createdimension.md
View File

@ -5,7 +5,6 @@
title = "createDimension"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## createDimension variable

1
docs/sources/packages_api/data/createorderfieldscomparer.md
View File

@ -5,7 +5,6 @@
title = "createOrderFieldsComparer"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## createOrderFieldsComparer variable

1
docs/sources/packages_api/data/createplotoverlay.md
View File

@ -5,7 +5,6 @@
title = "CreatePlotOverlay"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CreatePlotOverlay interface

1
docs/sources/packages_api/data/csvconfig.md
View File

@ -5,7 +5,6 @@
title = "CSVConfig"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CSVConfig interface

1
docs/sources/packages_api/data/csvheaderstyle.md
View File

@ -5,7 +5,6 @@
title = "CSVHeaderStyle"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CSVHeaderStyle enum

1
docs/sources/packages_api/data/csvoptions.md
View File

@ -5,7 +5,6 @@
title = "CSVOptions"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CSVOptions interface

1
docs/sources/packages_api/data/csvparsecallbacks.md
View File

@ -5,7 +5,6 @@
title = "CSVParseCallbacks"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CSVParseCallbacks interface

1
docs/sources/packages_api/data/csvreader.md
View File

@ -5,7 +5,6 @@
title = "CSVReader"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## CSVReader class

1
docs/sources/packages_api/data/dataconfigsource.md
View File

@ -5,7 +5,6 @@
title = "DataConfigSource"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataConfigSource interface

1
docs/sources/packages_api/data/dataframe.md
View File

@ -5,7 +5,6 @@
title = "DataFrame"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataFrame interface

1
docs/sources/packages_api/data/dataframedto.md
View File

@ -5,7 +5,6 @@
title = "DataFrameDTO"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataFrameDTO interface

1
docs/sources/packages_api/data/dataframeview.md
View File

@ -5,7 +5,6 @@
title = "DataFrameView"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataFrameView class

1
docs/sources/packages_api/data/datalink.md
View File

@ -5,7 +5,6 @@
title = "DataLink"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataLink interface

1
docs/sources/packages_api/data/datalinkbuiltinvars.md
View File

@ -5,7 +5,6 @@
title = "DataLinkBuiltInVars"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataLinkBuiltInVars variable

1
docs/sources/packages_api/data/datalinkclickevent.md
View File

@ -5,7 +5,6 @@
title = "DataLinkClickEvent"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataLinkClickEvent interface

1
docs/sources/packages_api/data/datalinksfieldconfigsettings.md
View File

@ -5,7 +5,6 @@
title = "DataLinksFieldConfigSettings"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataLinksFieldConfigSettings interface

1
docs/sources/packages_api/data/datalinksoverrideprocessor.md
View File

@ -5,7 +5,6 @@
title = "dataLinksOverrideProcessor"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dataLinksOverrideProcessor variable

1
docs/sources/packages_api/data/dataquery.md
View File

@ -5,7 +5,6 @@
title = "DataQuery"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQuery interface

1
docs/sources/packages_api/data/dataqueryerror.md
View File

@ -5,7 +5,6 @@
title = "DataQueryError"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQueryError interface

3
docs/sources/packages_api/data/dataqueryrequest.md
View File

@ -5,7 +5,6 @@
title = "DataQueryRequest"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQueryRequest interface
@ -120,7 +119,7 @@ panelId: number;
<b>Signature</b>
```typescript
range?: TimeRange;
range: TimeRange;
```
### rangeRaw property

1
docs/sources/packages_api/data/dataqueryresponse.md
View File

@ -5,7 +5,6 @@
title = "DataQueryResponse"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQueryResponse interface

1
docs/sources/packages_api/data/dataqueryresponsedata.md
View File

@ -5,7 +5,6 @@
title = "DataQueryResponseData"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQueryResponseData type

1
docs/sources/packages_api/data/dataquerytimings.md
View File

@ -5,7 +5,6 @@
title = "DataQueryTimings"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQueryTimings interface

19
docs/sources/packages_api/data/datasourceapi.md
View File

@ -5,7 +5,6 @@
title = "DataSourceApi"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceApi class
@ -59,6 +58,7 @@ import { DataSourceApi } from '@grafana/data';
| [metricFindQuery(query, options)](#metricfindquery-method) | | Variable query action. |
| [modifyQuery(query, action)](#modifyquery-method) | | Used in explore |
| [query(request)](#query-method) | | Query for data, and optionally stream results |
| [showContextToggle(row)](#showcontexttoggle-method) | | |
| [targetContainsTemplate(query)](#targetcontainstemplate-method) | | Used by alerting to check if query contains template variables |
| [testDatasource()](#testdatasource-method) | | Test &amp; verify datasource settings &amp; connection details |
@ -387,6 +387,23 @@ abstract query(request: DataQueryRequest<TQuery>): Promise<DataQueryResponse> |
`Promise<DataQueryResponse> | Observable<DataQueryResponse>`
### showContextToggle method
<b>Signature</b>
```typescript
showContextToggle?(row?: LogRowModel): boolean;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| row | <code>LogRowModel</code> | |
<b>Returns:</b>
`boolean`
### targetContainsTemplate method
Used by alerting to check if query contains template variables

1
docs/sources/packages_api/data/datasourceconstructor.md
View File

@ -5,7 +5,6 @@
title = "DataSourceConstructor"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceConstructor interface

1
docs/sources/packages_api/data/datasourceinstancesettings.md
View File

@ -5,7 +5,6 @@
title = "DataSourceInstanceSettings"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceInstanceSettings interface

1
docs/sources/packages_api/data/datasourcejsondata.md
View File

@ -5,7 +5,6 @@
title = "DataSourceJsonData"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceJsonData interface

1
docs/sources/packages_api/data/datasourceoptionstype.md
View File

@ -5,7 +5,6 @@
title = "DataSourceOptionsType"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceOptionsType type

1
docs/sources/packages_api/data/datasourceplugin.md
View File

@ -5,7 +5,6 @@
title = "DataSourcePlugin"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourcePlugin class

1
docs/sources/packages_api/data/datasourceplugincomponents.md
View File

@ -5,7 +5,6 @@
title = "DataSourcePluginComponents"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourcePluginComponents interface

1
docs/sources/packages_api/data/datasourcepluginmeta.md
View File

@ -5,7 +5,6 @@
title = "DataSourcePluginMeta"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourcePluginMeta interface

1
docs/sources/packages_api/data/datasourcepluginoptionseditorprops.md
View File

@ -5,7 +5,6 @@
title = "DataSourcePluginOptionsEditorProps"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourcePluginOptionsEditorProps interface

1
docs/sources/packages_api/data/datasourcequerytype.md
View File

@ -5,7 +5,6 @@
title = "DataSourceQueryType"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceQueryType type

1
docs/sources/packages_api/data/datasourceselectitem.md
View File

@ -5,7 +5,6 @@
title = "DataSourceSelectItem"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceSelectItem interface

1
docs/sources/packages_api/data/datasourcesettings.md
View File

@ -5,7 +5,6 @@
title = "DataSourceSettings"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceSettings interface

1
docs/sources/packages_api/data/datasourcestatus.md
View File

@ -5,7 +5,6 @@
title = "DataSourceStatus"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataSourceStatus enum

1
docs/sources/packages_api/data/datatransformer.md
View File

@ -5,7 +5,6 @@
title = "DataTransformer"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataTransformer type

1
docs/sources/packages_api/data/datatransformerconfig.md
View File

@ -5,7 +5,6 @@
title = "DataTransformerConfig"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataTransformerConfig interface

2
docs/sources/packages_api/data/datatransformerid.md
View File

@ -5,7 +5,6 @@
title = "DataTransformerID"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataTransformerID enum
@ -33,6 +32,7 @@ import { DataTransformerID } from '@grafana/data';
| filterFields | <code>&quot;filterFields&quot;</code> | |
| filterFieldsByName | <code>&quot;filterFieldsByName&quot;</code> | |
| filterFrames | <code>&quot;filterFrames&quot;</code> | |
| labelsToFields | <code>&quot;labelsToFields&quot;</code> | |
| noop | <code>&quot;noop&quot;</code> | |
| order | <code>&quot;order&quot;</code> | |
| organize | <code>&quot;organize&quot;</code> | |

1
docs/sources/packages_api/data/datatransformerinfo.md
View File

@ -5,7 +5,6 @@
title = "DataTransformerInfo"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataTransformerInfo interface

1
docs/sources/packages_api/data/datemath.md
View File

@ -5,7 +5,6 @@
title = "dateMath"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateMath namespace

1
docs/sources/packages_api/data/datemath/ismathstring.md
View File

@ -5,7 +5,6 @@
title = "isMathString"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateMath.isMathString() function

1
docs/sources/packages_api/data/datemath/isvalid.md
View File

@ -5,7 +5,6 @@
title = "isValid"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateMath.isValid() function

1
docs/sources/packages_api/data/datemath/parse.md
View File

@ -5,7 +5,6 @@
title = "parse"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateMath.parse() function

1
docs/sources/packages_api/data/datemath/parsedatemath.md
View File

@ -5,7 +5,6 @@
title = "parseDateMath"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateMath.parseDateMath() function

1
docs/sources/packages_api/data/datetime.md
View File

@ -5,7 +5,6 @@
title = "dateTime"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateTime variable

1
docs/sources/packages_api/data/datetimeasmoment.md
View File

@ -5,7 +5,6 @@
title = "dateTimeAsMoment"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateTimeAsMoment variable

1
docs/sources/packages_api/data/datetimebuiltinformat.md
View File

@ -5,7 +5,6 @@
title = "DateTimeBuiltinFormat"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DateTimeBuiltinFormat interface

1
docs/sources/packages_api/data/datetimeduration.md
View File

@ -5,7 +5,6 @@
title = "DateTimeDuration"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DateTimeDuration interface

23
docs/sources/packages_api/data/datetimeformat.md Normal file
View File

@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "dateTimeFormat"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## dateTimeFormat variable
### dateTimeFormat variable
<b>Signature</b>
```typescript
dateTimeFormat: DateTimeFormatter<DateTimeOptionsWithFormat>
```
<b>Import</b>
```typescript
import { dateTimeFormat } from '@grafana/data';
```

23
docs/sources/packages_api/data/datetimeformatiso.md Normal file
View File

@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "dateTimeFormatISO"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## dateTimeFormatISO variable
### dateTimeFormatISO variable
<b>Signature</b>
```typescript
dateTimeFormatISO: DateTimeFormatter
```
<b>Import</b>
```typescript
import { dateTimeFormatISO } from '@grafana/data';
```

23
docs/sources/packages_api/data/datetimeformatter.md Normal file
View File

@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DateTimeFormatter"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## DateTimeFormatter type
### DateTimeFormatter type
<b>Signature</b>
```typescript
export declare type DateTimeFormatter<T extends DateTimeOptions = DateTimeOptions> = (dateInUtc: DateTimeInput, options?: T) => string;
```
<b>Import</b>
```typescript
import { DateTimeFormatter } from '@grafana/data';
```

23
docs/sources/packages_api/data/datetimeformattimeago.md Normal file
View File

@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "dateTimeFormatTimeAgo"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## dateTimeFormatTimeAgo variable
### dateTimeFormatTimeAgo variable
<b>Signature</b>
```typescript
dateTimeFormatTimeAgo: DateTimeFormatter
```
<b>Import</b>
```typescript
import { dateTimeFormatTimeAgo } from '@grafana/data';
```

23
docs/sources/packages_api/data/datetimeformatwithabbrevation.md Normal file
View File

@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "dateTimeFormatWithAbbrevation"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## dateTimeFormatWithAbbrevation variable
### dateTimeFormatWithAbbrevation variable
<b>Signature</b>
```typescript
dateTimeFormatWithAbbrevation: DateTimeFormatter
```
<b>Import</b>
```typescript
import { dateTimeFormatWithAbbrevation } from '@grafana/data';
```

1
docs/sources/packages_api/data/datetimefortimezone.md
View File

@ -5,7 +5,6 @@
title = "dateTimeForTimeZone"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## dateTimeForTimeZone variable

1
docs/sources/packages_api/data/datetimeinput.md
View File

@ -5,7 +5,6 @@
title = "DateTimeInput"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DateTimeInput type

1
docs/sources/packages_api/data/datetimelocale.md
View File

@ -5,7 +5,6 @@
title = "DateTimeLocale"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DateTimeLocale interface

34
docs/sources/packages_api/data/datetimeoptions.md Normal file
View File

@ -0,0 +1,34 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DateTimeOptions"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## DateTimeOptions interface
<b>Signature</b>
```typescript
export interface DateTimeOptions
```
<b>Import</b>
```typescript
import { DateTimeOptions } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [timeZone](#timezone-property) | <code>TimeZone</code> | |
### timeZone property
<b>Signature</b>
```typescript
timeZone?: TimeZone;
```

Some files were not shown because too many files have changed in this diff Show More