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

Docs: updated packages reference docs for 7.1.0-beta1. (#25958)

Browse Source
This commit is contained in:
Marcus Andersson
2020-07-01 09:12:35 +02:00
committed by GitHub
parent e93640878d
commit 83df83fa42
97 changed files with 1369 additions and 206 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/packages_api/data/_index.md
+20 -3
View File
@@ -20,7 +20,7 @@ A library containing most of the core functionality and data types used in Grafa
| [ArrayVector](./arrayvector/) | |
| [BinaryOperationVector](./binaryoperationvector/) | |
| [CircularDataFrame](./circulardataframe/) | This dataframe can have values constantly added, and will never exceed the given capacity |
| [CircularVector](./circularvector/) | Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.<!-- -->This supports addting to the 'head' or 'tail' and will grow the buffer to match a configured capacity. |
| [CircularVector](./circularvector/) | Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.<!-- -->This supports adding to the 'head' or 'tail' and will grow the buffer to match a configured capacity. |
| [ConstantVector](./constantvector/) | |
| [CSVReader](./csvreader/) | |
| [DataFrameView](./dataframeview/) | <b><i>(BETA)</i></b> This abstraction will present the contents of a DataFrame as if it were a well typed javascript object Vector. |
@@ -29,6 +29,7 @@ A library containing most of the core functionality and data types used in Grafa
| [FieldCache](./fieldcache/) | |
| [FieldConfigEditorBuilder](./fieldconfigeditorbuilder/) | Fluent API for declarative creation of field config option editors |
| [FieldConfigOptionsRegistry](./fieldconfigoptionsregistry/) | |
| [FormattedVector](./formattedvector/) | |
| [GrafanaPlugin](./grafanaplugin/) | |
| [LanguageProvider](./languageprovider/) | |
| [MutableDataFrame](./mutabledataframe/) | |
@@ -54,6 +55,7 @@ A library containing most of the core functionality and data types used in Grafa
| [FieldType](./fieldtype/) | |
| [FrameMatcherID](./framematcherid/) | Field name matchers |
| [GrafanaThemeType](./grafanathemetype/) | |
| [InternalTimeZones](./internaltimezones/) | |
| [LoadingState](./loadingstate/) | Represent panel data loading state. |
| [LogLevel](./loglevel/) | Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation. |
| [LogsDedupDescription](./logsdedupdescription/) | |
@@ -110,7 +112,7 @@ A library containing most of the core functionality and data types used in Grafa
| [getValueFormat(id)](./getvalueformat/) | |
| [getValueFormats()](./getvalueformats/) | |
| [getValueFormatterIndex()](./getvalueformatterindex/) | |
| [grafanaDataFrameToArrowTable(data)](./grafanadataframetoarrowtable/) | |
| [grafanaDataFrameToArrowTable(data, keepOriginalNames)](./grafanadataframetoarrowtable/) | |
| [guessFieldTypeForField(field)](./guessfieldtypeforfield/) | Looks at the data to guess the column type. This ignores any existing setting |
| [guessFieldTypeFromNameAndValue(name, v)](./guessfieldtypefromnameandvalue/) | Given a name and value, this will pick a reasonable field type |
| [guessFieldTypeFromValue(v)](./guessfieldtypefromvalue/) | Given a value this will guess the best column type<!-- -->TODO: better Date/Time support! Look for standard date strings? |
@@ -167,7 +169,7 @@ A library containing most of the core functionality and data types used in Grafa
| [DataConfigSource](./dataconfigsource/) | Describes and API for exposing panel specific data configurations. |
| [DataFrame](./dataframe/) | |
| [DataFrameDTO](./dataframedto/) | Like a DataFrame, but fields may be a FieldDTO |
| [DataLink](./datalink/) | Link configuration. The values may contain variables that need to be processed before running |
| [DataLink](./datalink/) | Link configuration. The values may contain variables that need to be processed before showing the link to user.<!-- -->TODO: &lt;<!-- -->T extends DataQuery<!-- -->&gt; is not strictly true for internal links as we do not need refId for example but all data source defined queries extend this so this is more for documentation. |
| [DataLinkClickEvent](./datalinkclickevent/) | Callback info for DataLink click events |
| [DataLinksFieldConfigSettings](./datalinksfieldconfigsettings/) | |
| [DataQuery](./dataquery/) | These are the common properties available to all queries in all datasources Specific implementations will extend this interface adding the required properties for the given context |
@@ -224,6 +226,7 @@ A library containing most of the core functionality and data types used in Grafa
| [GrafanaTheme](./grafanatheme/) | |
| [GrafanaThemeCommons](./grafanathemecommons/) | |
| [GraphSeriesXY](./graphseriesxy/) | View model projection of a series |
| [GroupedTimeZones](./groupedtimezones/) | |
| [HistoryItem](./historyitem/) | |
| [IntervalValues](./intervalvalues/) | |
| [Labels](./labels/) | |
@@ -280,6 +283,7 @@ A library containing most of the core functionality and data types used in Grafa
| [ScreenshotInfo](./screenshotinfo/) | |
| [SelectableValue](./selectablevalue/) | Used in select elements |
| [SelectFieldConfigSettings](./selectfieldconfigsettings/) | |
| [StandardEditorContext](./standardeditorcontext/) | |
| [StandardEditorProps](./standardeditorprops/) | |
| [StandardEditorsRegistryItem](./standardeditorsregistryitem/) | |
| [StringFieldConfigSettings](./stringfieldconfigsettings/) | |
@@ -292,6 +296,8 @@ A library containing most of the core functionality and data types used in Grafa
| [TimeOptions](./timeoptions/) | |
| [TimeRange](./timerange/) | |
| [TimeSeries](./timeseries/) | |
| [TimeZoneCountry](./timezonecountry/) | |
| [TimeZoneInfo](./timezoneinfo/) | |
| [TransformerRegistyItem](./transformerregistyitem/) | |
| [TransformerUIProps](./transformeruiprops/) | |
| [UnitFieldConfigSettings](./unitfieldconfigsettings/) | |
@@ -358,6 +364,8 @@ A library containing most of the core functionality and data types used in Grafa
| [getSeriesTimeStep](./getseriestimestep/) | Returns minimal time step from series time field |
| [getTimeField](./gettimefield/) | |
| [getTimeZoneGroups](./gettimezonegroups/) | |
| [getTimeZoneInfo](./gettimezoneinfo/) | |
| [getTimeZones](./gettimezones/) | |
| [getValueFromDimension](./getvaluefromdimension/) | |
| [guessFieldTypes](./guessfieldtypes/) | |
| [hasMsResolution](./hasmsresolution/) | Checks if series time field has ms resolution |
@@ -451,6 +459,15 @@ A library containing most of the core functionality and data types used in Grafa
| [TimeZoneBrowser](./timezonebrowser/) | |
| [TimeZoneResolver](./timezoneresolver/) | The type to describe the time zone resolver function that will be used to access the default time zone of a user. |
| [TimeZoneUtc](./timezoneutc/) | |
| [Trace](./trace/) | |
| [TraceData](./tracedata/) | |
| [TraceKeyValuePair](./tracekeyvaluepair/) | All timestamps are in microseconds |
| [TraceLink](./tracelink/) | |
| [TraceLog](./tracelog/) | |
| [TraceProcess](./traceprocess/) | |
| [TraceSpan](./tracespan/) | |
| [TraceSpanData](./tracespandata/) | |
| [TraceSpanReference](./tracespanreference/) | |
| [UrlQueryMap](./urlquerymap/) | Type to represent the values parsed from the query string. |
| [UrlQueryValue](./urlqueryvalue/) | Type to represent the value of a single query variable. |
| [ValueConverter](./valueconverter/) | |
docs/sources/packages_api/data/applyfieldoverrideoptions.md
+9
View File
@@ -27,6 +27,7 @@ import { ApplyFieldOverrideOptions } from '@grafana/data';
| [data](#data-property) | <code>DataFrame[]</code> | |
| [fieldConfig](#fieldconfig-property) | <code>FieldConfigSource</code> | |
| [fieldConfigRegistry](#fieldconfigregistry-property) | <code>FieldConfigOptionsRegistry</code> | |
| [getDataSourceSettingsByUid](#getdatasourcesettingsbyuid-property) | <code>(uid: string) =&gt; DataSourceInstanceSettings &#124; undefined</code> | |
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | |
| [theme](#theme-property) | <code>GrafanaTheme</code> | |
| [timeZone](#timezone-property) | <code>TimeZone</code> | |
@@ -63,6 +64,14 @@ fieldConfig: FieldConfigSource;
fieldConfigRegistry?: FieldConfigOptionsRegistry;
```
### getDataSourceSettingsByUid property
<b>Signature</b>
```typescript
getDataSourceSettingsByUid: (uid: string) => DataSourceInstanceSettings | undefined;
```
### replaceVariables property
<b>Signature</b>
docs/sources/packages_api/data/buildinfo.md
+9
View File
@@ -29,6 +29,7 @@ import { BuildInfo } from '@grafana/data';
| [edition](#edition-property) | <code>string</code> | |
| [env](#env-property) | <code>string</code> | |
| [hasUpdate](#hasupdate-property) | <code>boolean</code> | |
| [hideVersion](#hideversion-property) | <code>boolean</code> | |
| [isEnterprise](#isenterprise-property) | <code>boolean</code> | Is set to true when running Grafana Enterprise edition. |
| [latestVersion](#latestversion-property) | <code>string</code> | |
| [version](#version-property) | <code>string</code> | |
@@ -65,6 +66,14 @@ env: string;
hasUpdate: boolean;
```
### hideVersion property
<b>Signature</b>
```typescript
hideVersion: boolean;
```
### isEnterprise property
Is set to true when running Grafana Enterprise edition.
docs/sources/packages_api/data/circularvector.md
+1 -1
View File
@@ -11,7 +11,7 @@ type = "docs"
Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.
This supports addting to the 'head' or 'tail' and will grow the buffer to match a configured capacity.
This supports adding to the 'head' or 'tail' and will grow the buffer to match a configured capacity.
<b>Signature</b>
docs/sources/packages_api/data/colorfieldconfigsettings.md
+21 -3
View File
@@ -23,12 +23,30 @@ import { ColorFieldConfigSettings } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [enableNamedColors](#enablenamedcolors-property) | <code>boolean</code> | |
| [allowUndefined](#allowundefined-property) | <code>boolean</code> | |
| [disableNamedColors](#disablenamedcolors-property) | <code>boolean</code> | |
| [textWhenUndefined](#textwhenundefined-property) | <code>string</code> | |
### enableNamedColors property
### allowUndefined property
<b>Signature</b>
```typescript
enableNamedColors?: boolean;
allowUndefined?: boolean;
```
### disableNamedColors property
<b>Signature</b>
```typescript
disableNamedColors?: boolean;
```
### textWhenUndefined property
<b>Signature</b>
```typescript
textWhenUndefined?: string;
```
docs/sources/packages_api/data/createdimension.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
createDimension: (name: string, columns: Field<any, import("..").Vector<any>>[]) => Dimension<any>
createDimension: (name: string, columns: Field[]) => Dimension
```
<b>Import</b>
docs/sources/packages_api/data/datalink.md
+9 -6
View File
@@ -9,12 +9,14 @@ type = "docs"
## DataLink interface
Link configuration. The values may contain variables that need to be processed before running
Link configuration. The values may contain variables that need to be processed before showing the link to user.
TODO: &lt;<!-- -->T extends DataQuery<!-- -->&gt; is not strictly true for internal links as we do not need refId for example but all data source defined queries extend this so this is more for documentation.
<b>Signature</b>
```typescript
export interface DataLink
export interface DataLink<T extends DataQuery = any>
```
<b>Import</b>
@@ -25,20 +27,21 @@ import { DataLink } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [meta](#meta-property) | <code>{</code><br/><code> datasourceUid?: string;</code><br/><code> }</code> | |
| [internal](#internal-property) | <code>{</code><br/><code> query: T;</code><br/><code> datasourceUid: string;</code><br/><code> }</code> | |
| [onBuildUrl](#onbuildurl-property) | <code>(event: DataLinkClickEvent) =&gt; string</code> | |
| [onClick](#onclick-property) | <code>(event: DataLinkClickEvent) =&gt; void</code> | |
| [targetBlank](#targetblank-property) | <code>boolean</code> | |
| [title](#title-property) | <code>string</code> | |
| [url](#url-property) | <code>string</code> | |
### meta property
### internal property
<b>Signature</b>
```typescript
meta?: {
datasourceUid?: string;
internal?: {
query: T;
datasourceUid: string;
};
```
docs/sources/packages_api/data/datalinksoverrideprocessor.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
dataLinksOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: DataLinksFieldConfigSettings | undefined) => DataLink[]
dataLinksOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: DataLinksFieldConfigSettings | undefined) => DataLink<any>[]
```
<b>Import</b>
docs/sources/packages_api/data/datasourceinstancesettings.md
+2 -2
View File
@@ -25,7 +25,7 @@ import { DataSourceInstanceSettings } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [basicAuth](#basicauth-property) | <code>string</code> | This is the full Authorization header if basic auth is ennabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username &amp; password is never exposted to browser/Frontend so this will be empty then. |
| [basicAuth](#basicauth-property) | <code>string</code> | This is the full Authorization header if basic auth is enabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username &amp; password is never exposed to browser/Frontend so this will be empty then. |
| [database](#database-property) | <code>string</code> | |
| [id](#id-property) | <code>number</code> | |
| [jsonData](#jsondata-property) | <code>T</code> | |
@@ -40,7 +40,7 @@ import { DataSourceInstanceSettings } from '@grafana/data';
### basicAuth property
This is the full Authorization header if basic auth is ennabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username &amp; password is never exposted to browser/Frontend so this will be empty then.
This is the full Authorization header if basic auth is enabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username &amp; password is never exposed to browser/Frontend so this will be empty then.
<b>Signature</b>
docs/sources/packages_api/data/datatransformerid.md
+1
View File
@@ -34,6 +34,7 @@ import { DataTransformerID } from '@grafana/data';
| filterFieldsByName | <code>&quot;filterFieldsByName&quot;</code> | |
| filterFrames | <code>&quot;filterFrames&quot;</code> | |
| labelsToFields | <code>&quot;labelsToFields&quot;</code> | |
| merge | <code>&quot;merge&quot;</code> | |
| noop | <code>&quot;noop&quot;</code> | |
| order | <code>&quot;order&quot;</code> | |
| organize | <code>&quot;organize&quot;</code> | |
docs/sources/packages_api/data/featuretoggles.md
+12 -3
View File
@@ -25,12 +25,21 @@ import { FeatureToggles } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [datasourceInsights](#datasourceinsights-property) | <code>boolean</code> | |
| [expressions](#expressions-property) | <code>boolean</code> | |
| [meta](#meta-property) | <code>boolean</code> | |
| [newEdit](#newedit-property) | <code>boolean</code> | |
| [newVariables](#newvariables-property) | <code>boolean</code> | |
| [reportGrid](#reportgrid-property) | <code>boolean</code> | |
| [transformations](#transformations-property) | <code>boolean</code> | |
### datasourceInsights property
<b>Signature</b>
```typescript
datasourceInsights: boolean;
```
### expressions property
<b>Signature</b>
@@ -59,12 +68,12 @@ Available only in Grafana Enterprise
newEdit: boolean;
```
### newVariables property
### reportGrid property
<b>Signature</b>
```typescript
newVariables: boolean;
reportGrid: boolean;
```
### transformations property
docs/sources/packages_api/data/fieldoverridecontext.md
+1 -19
View File
@@ -12,7 +12,7 @@ type = "docs"
<b>Signature</b>
```typescript
export interface FieldOverrideContext
export interface FieldOverrideContext extends StandardEditorContext<any>
```
<b>Import</b>
@@ -26,8 +26,6 @@ import { FieldOverrideContext } from '@grafana/data';
| [data](#data-property) | <code>DataFrame[]</code> | |
| [dataFrameIndex](#dataframeindex-property) | <code>number</code> | |
| [field](#field-property) | <code>Field</code> | |
| [getSuggestions](#getsuggestions-property) | <code>(scope?: VariableSuggestionsScope) =&gt; VariableSuggestion[]</code> | |
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | |
### data property
@@ -52,19 +50,3 @@ dataFrameIndex?: number;
```typescript
field?: Field;
```
### getSuggestions property
<b>Signature</b>
```typescript
getSuggestions?: (scope?: VariableSuggestionsScope) => VariableSuggestion[];
```
### replaceVariables property
<b>Signature</b>
```typescript
replaceVariables?: InterpolateFunction;
```
docs/sources/packages_api/data/formattedvector.md
+104
View File
@@ -0,0 +1,104 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FormattedVector"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## FormattedVector class
<b>Signature</b>
```typescript
export declare class FormattedVector<T = any> implements Vector<string>
```
<b>Import</b>
```typescript
import { FormattedVector } from '@grafana/data';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(source, formatter)](#constructor-sourceformatter) | | Constructs a new instance of the <code>FormattedVector</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [length](#length-property) | | <code>number</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [get(index)](#get-method) | | |
| [toArray()](#toarray-method) | | |
| [toJSON()](#tojson-method) | | |
### constructor(source, formatter)
Constructs a new instance of the `FormattedVector` class
<b>Signature</b>
```typescript
constructor(source: Vector<T>, formatter: DisplayProcessor);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| source | <code>Vector&lt;T&gt;</code> | |
| formatter | <code>DisplayProcessor</code> | |
### length property
<b>Signature</b>
```typescript
get length(): number;
```
### get method
<b>Signature</b>
```typescript
get(index: number): string;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| index | <code>number</code> | |
<b>Returns:</b>
`string`
### toArray method
<b>Signature</b>
```typescript
toArray(): string[];
```
<b>Returns:</b>
`string[]`
### toJSON method
<b>Signature</b>
```typescript
toJSON(): string[];
```
<b>Returns:</b>
`string[]`
docs/sources/packages_api/data/getallvaluesfromdimension.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getAllValuesFromDimension: (dimension: Dimension<any>, column: number, row: number) => any[]
getAllValuesFromDimension: (dimension: Dimension, column: number, row: number) => any[]
```
<b>Import</b>
docs/sources/packages_api/data/getcolorname.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getColorName: (color?: string | undefined, theme?: GrafanaThemeType | undefined) => "green" | "yellow" | "red" | "blue" | "orange" | "purple" | "dark-green" | "semi-dark-green" | "light-green" | "super-light-green" | "dark-yellow" | "semi-dark-yellow" | "light-yellow" | "super-light-yellow" | "dark-red" | "semi-dark-red" | "light-red" | "super-light-red" | "dark-blue" | "semi-dark-blue" | "light-blue" | "super-light-blue" | "dark-orange" | "semi-dark-orange" | "light-orange" | "super-light-orange" | "dark-purple" | "semi-dark-purple" | "light-purple" | "super-light-purple" | undefined
getColorName: (color?: string | undefined, theme?: GrafanaThemeType | undefined) => Color | undefined
```
<b>Import</b>
docs/sources/packages_api/data/getcolumnfromdimension.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getColumnFromDimension: (dimension: Dimension<any>, column: number) => Field<any, import("..").Vector<any>>
getColumnFromDimension: (dimension: Dimension, column: number) => Field<any, import("..").Vector<any>>
```
<b>Import</b>
docs/sources/packages_api/data/getcolumnsfromdimension.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getColumnsFromDimension: (dimension: Dimension<any>) => Field<any, import("..").Vector<any>>[]
getColumnsFromDimension: (dimension: Dimension) => Field<any, import("..").Vector<any>>[]
```
<b>Import</b>
docs/sources/packages_api/data/getdimensionbyname.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getDimensionByName: (dimensions: KeyValue<Dimension<any>>, name: string) => Dimension<any>
getDimensionByName: (dimensions: Dimensions, name: string) => Dimension<any>
```
<b>Import</b>
docs/sources/packages_api/data/getseriestimestep.md
+1 -1
View File
@@ -16,7 +16,7 @@ Returns minimal time step from series time field
<b>Signature</b>
```typescript
getSeriesTimeStep: (timeField: Field<any, import("..").Vector<any>>) => number
getSeriesTimeStep: (timeField: Field) => number
```
<b>Import</b>
docs/sources/packages_api/data/gettimefield.md
+2 -2
View File
@@ -15,8 +15,8 @@ type = "docs"
```typescript
getTimeField: (series: DataFrame) => {
timeField?: Field<any, import("../types").Vector<any>> | undefined;
timeIndex?: number | undefined;
timeField?: Field;
timeIndex?: number;
}
```
<b>Import</b>
docs/sources/packages_api/data/gettimezonegroups.md
+1 -4
View File
@@ -14,10 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getTimeZoneGroups: () => {
label: string;
options: string[];
}[]
getTimeZoneGroups: ((includeInternal?: any) => GroupedTimeZones[]) & import("lodash").MemoizedFunction
```
<b>Import</b>
docs/sources/packages_api/data/gettimezoneinfo.md
+23
View File
@@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getTimeZoneInfo"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## getTimeZoneInfo variable
### getTimeZoneInfo variable
<b>Signature</b>
```typescript
getTimeZoneInfo: (zone: string, timestamp: number) => TimeZoneInfo | undefined
```
<b>Import</b>
```typescript
import { getTimeZoneInfo } from '@grafana/data';
```
docs/sources/packages_api/data/gettimezones.md
+23
View File
@@ -0,0 +1,23 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getTimeZones"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## getTimeZones variable
### getTimeZones variable
<b>Signature</b>
```typescript
getTimeZones: ((includeInternal?: any) => TimeZone[]) & import("lodash").MemoizedFunction
```
<b>Import</b>
```typescript
import { getTimeZones } from '@grafana/data';
```
docs/sources/packages_api/data/getvaluefromdimension.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
getValueFromDimension: (dimension: Dimension<any>, column: number, row: number) => any
getValueFromDimension: (dimension: Dimension, column: number, row: number) => any
```
<b>Import</b>
docs/sources/packages_api/data/grafanadataframetoarrowtable.md
+2 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
export declare function grafanaDataFrameToArrowTable(data: DataFrame): Table;
export declare function grafanaDataFrameToArrowTable(data: DataFrame, keepOriginalNames?: boolean): Table;
```
<b>Import</b>
@@ -26,6 +26,7 @@ import { grafanaDataFrameToArrowTable } from '@grafana/data';
| Parameter | Type | Description |
| --- | --- | --- |
| data | <code>DataFrame</code> | |
| keepOriginalNames | <code>boolean</code> | by default, the exported Table will get names that match the display within grafana. This typically includes any labels defined in the metadata.<!-- -->When using this function to round-trip data, be sure to set <code>keepOriginalNames=true</code> |
<b>Returns:</b>
docs/sources/packages_api/data/groupedtimezones.md
+43
View File
@@ -0,0 +1,43 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GroupedTimeZones"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## GroupedTimeZones interface
<b>Signature</b>
```typescript
export interface GroupedTimeZones
```
<b>Import</b>
```typescript
import { GroupedTimeZones } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [name](#name-property) | <code>string</code> | |
| [zones](#zones-property) | <code>TimeZone[]</code> | |
### name property
<b>Signature</b>
```typescript
name: string;
```
### zones property
<b>Signature</b>
```typescript
zones: TimeZone[];
```
docs/sources/packages_api/data/hasmsresolution.md
+1 -1
View File
@@ -16,7 +16,7 @@ Checks if series time field has ms resolution
<b>Signature</b>
```typescript
hasMsResolution: (timeField: Field<any, import("..").Vector<any>>) => boolean
hasMsResolution: (timeField: Field) => boolean
```
<b>Import</b>
docs/sources/packages_api/data/internaltimezones.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "InternalTimeZones"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## InternalTimeZones enum
### InternalTimeZones enum
<b>Signature</b>
```typescript
export declare enum InternalTimeZones
```
<b>Import</b>
```typescript
import { InternalTimeZones } from '@grafana/data';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| default | <code>&quot;&quot;</code> | |
| localBrowserTime | <code>&quot;browser&quot;</code> | |
| utc | <code>&quot;utc&quot;</code> | |
docs/sources/packages_api/data/linktarget.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
export declare type LinkTarget = '_blank' | '_self';
export declare type LinkTarget = '_blank' | '_self' | undefined;
```
<b>Import</b>
docs/sources/packages_api/data/logsmodel.md
+9
View File
@@ -27,6 +27,7 @@ import { LogsModel } from '@grafana/data';
| [meta](#meta-property) | <code>LogsMetaItem[]</code> | |
| [rows](#rows-property) | <code>LogRowModel[]</code> | |
| [series](#series-property) | <code>GraphSeriesXY[]</code> | |
| [visibleRange](#visiblerange-property) | <code>AbsoluteTimeRange</code> | |
### hasUniqueLabels property
@@ -59,3 +60,11 @@ rows: LogRowModel[];
```typescript
series?: GraphSeriesXY[];
```
### visibleRange property
<b>Signature</b>
```typescript
visibleRange?: AbsoluteTimeRange;
```
docs/sources/packages_api/data/onupdatedatasourcejsondataoption.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceJsonDataOption: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (event: import("react").SyntheticEvent<HTMLInputElement | HTMLSelectElement, Event>) => void
onUpdateDatasourceJsonDataOption: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (event: React.SyntheticEvent<HTMLInputElement | HTMLSelectElement>) => void
```
<b>Import</b>
docs/sources/packages_api/data/onupdatedatasourcejsondataoptionchecked.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceJsonDataOptionChecked: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (event: import("react").SyntheticEvent<HTMLInputElement, Event>) => void
onUpdateDatasourceJsonDataOptionChecked: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (event: React.SyntheticEvent<HTMLInputElement>) => void
```
<b>Import</b>
docs/sources/packages_api/data/onupdatedatasourcejsondataoptionselect.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceJsonDataOptionSelect: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (selected: SelectableValue<any>) => void
onUpdateDatasourceJsonDataOptionSelect: <J, S, K extends keyof J>(props: DataSourcePluginOptionsEditorProps<J, S>, key: K) => (selected: SelectableValue) => void
```
<b>Import</b>
docs/sources/packages_api/data/onupdatedatasourceoption.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceOption: (props: DataSourcePluginOptionsEditorProps<import("../types").DataSourceJsonData, {}>, key: "type" | "name" | "id" | "orgId" | "typeLogoUrl" | "access" | "url" | "password" | "user" | "database" | "basicAuth" | "basicAuthPassword" | "basicAuthUser" | "isDefault" | "jsonData" | "secureJsonData" | "secureJsonFields" | "readOnly" | "withCredentials" | "version") => (event: import("react").SyntheticEvent<HTMLInputElement | HTMLSelectElement, Event>) => void
onUpdateDatasourceOption: (props: DataSourcePluginOptionsEditorProps, key: keyof DataSourceSettings) => (event: React.SyntheticEvent<HTMLInputElement | HTMLSelectElement>) => void
```
<b>Import</b>
docs/sources/packages_api/data/onupdatedatasourceresetoption.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceResetOption: (props: DataSourcePluginOptionsEditorProps<import("../types").DataSourceJsonData, {}>, key: string) => (event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => void
onUpdateDatasourceResetOption: (props: DataSourcePluginOptionsEditorProps, key: string) => (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void
```
<b>Import</b>
docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoption.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceSecureJsonDataOption: <J, S extends {} = KeyValue<any>>(props: DataSourcePluginOptionsEditorProps<J, S>, key: string) => (event: import("react").SyntheticEvent<HTMLInputElement | HTMLSelectElement, Event>) => void
onUpdateDatasourceSecureJsonDataOption: <J, S extends {} = KeyValue<any>>(props: DataSourcePluginOptionsEditorProps<J, S>, key: string) => (event: React.SyntheticEvent<HTMLInputElement | HTMLSelectElement>) => void
```
<b>Import</b>
docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoptionselect.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
onUpdateDatasourceSecureJsonDataOptionSelect: <J, S extends {} = KeyValue<any>>(props: DataSourcePluginOptionsEditorProps<J, S>, key: string) => (selected: SelectableValue<any>) => void
onUpdateDatasourceSecureJsonDataOptionSelect: <J, S extends {} = KeyValue<any>>(props: DataSourcePluginOptionsEditorProps<J, S>, key: string) => (selected: SelectableValue) => void
```
<b>Import</b>
docs/sources/packages_api/data/paneloptionseditorbuilder.md
+36
View File
@@ -30,7 +30,9 @@ import { PanelOptionsEditorBuilder } from '@grafana/data';
| [addNumberInput(config)](#addnumberinput-method) | | |
| [addRadio(config)](#addradio-method) | | |
| [addSelect(config)](#addselect-method) | | |
| [addStringArray(config)](#addstringarray-method) | | |
| [addTextInput(config)](#addtextinput-method) | | |
| [addTimeZonePicker(config)](#addtimezonepicker-method) | | |
| [addUnitPicker(config)](#addunitpicker-method) | | |
### addBooleanSwitch method
@@ -118,6 +120,23 @@ addSelect<TOption, TSettings extends SelectFieldConfigSettings<TOption>>(config:
`this`
### addStringArray method
<b>Signature</b>
```typescript
addStringArray<TSettings>(config: PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string[]>): this;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| config | <code>PanelOptionsEditorConfig&lt;TOptions, TSettings &amp; StringFieldConfigSettings, string[]&gt;</code> | |
<b>Returns:</b>
`this`
### addTextInput method
<b>Signature</b>
@@ -135,6 +154,23 @@ addTextInput<TSettings>(config: PanelOptionsEditorConfig<TOptions, TSettings & S
`this`
### addTimeZonePicker method
<b>Signature</b>
```typescript
addTimeZonePicker<TSettings = any>(config: PanelOptionsEditorConfig<TOptions, TSettings, string>): this;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| config | <code>PanelOptionsEditorConfig&lt;TOptions, TSettings, string&gt;</code> | |
<b>Returns:</b>
`this`
### addUnitPicker method
<b>Signature</b>
docs/sources/packages_api/data/panelplugin.md
+2 -2
View File
@@ -50,7 +50,7 @@ import { PanelPlugin } from '@grafana/data';
| [setNoPadding()](#setnopadding-method) | | |
| [setPanelChangeHandler(handler)](#setpanelchangehandler-method) | | This function is called when the visualization was changed. This passes in the panel model for previous visualisation options inspection and panel model updates.<!-- -->This is useful for supporting PanelModel API updates when changing between Angular and React panels. |
| [setPanelOptions(builder)](#setpaneloptions-method) | | Enables panel options editor creation |
| [useFieldConfig(config)](#usefieldconfig-method) | | Allows specyfing which standard field config options panel should use and defining default values |
| [useFieldConfig(config)](#usefieldconfig-method) | | Allows specifying which standard field config options panel should use and defining default values |
### constructor(panel)
@@ -285,7 +285,7 @@ export const plugin = new PanelPlugin<ShapePanelOptions>(ShapePanel)
### useFieldConfig method
Allows specyfing which standard field config options panel should use and defining default values
Allows specifying which standard field config options panel should use and defining default values
<b>Signature</b>
docs/sources/packages_api/data/panelprops.md
+2 -2
View File
@@ -34,7 +34,7 @@ import { PanelProps } from '@grafana/data';
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | Template variables interpolation function |
| [timeRange](#timerange-property) | <code>TimeRange</code> | Time range of the current dashboard |
| [timeZone](#timezone-property) | <code>TimeZone</code> | Time zone of the current dashboard |
| [transparent](#transparent-property) | <code>boolean</code> | Indicathes whether or not panel should be rendered transparent |
| [transparent](#transparent-property) | <code>boolean</code> | Indicates whether or not panel should be rendered transparent |
| [width](#width-property) | <code>number</code> | Current width of the panel |
### data property
@@ -149,7 +149,7 @@ timeZone: TimeZone;
### transparent property
Indicathes whether or not panel should be rendered transparent
Indicates whether or not panel should be rendered transparent
<b>Signature</b>
docs/sources/packages_api/data/queryresultmeta.md
+11 -18
View File
@@ -25,13 +25,12 @@ import { QueryResultMeta } from '@grafana/data';
| --- | --- | --- |
| [alignmentPeriod](#alignmentperiod-property) | <code>string</code> | |
| [custom](#custom-property) | <code>Record&lt;string, any&gt;</code> | DatasSource Specific Values |
| [executedQueryString](#executedquerystring-property) | <code>string</code> | This is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector |
| [gmdMeta](#gmdmeta-property) | <code>any[]</code> | Legacy data source specific, should be moved to custom |
| [json](#json-property) | <code>boolean</code> | |
| [limit](#limit-property) | <code>number</code> | |
| [notices](#notices-property) | <code>QueryResultMetaNotice[]</code> | Meta Notices |
| [preferredVisualisationType](#preferredvisualisationtype-property) | <code>PreferredVisualisationType</code> | Currently used to show results in Explore only in preferred visualisation option |
| [query](#query-property) | <code>string</code> | |
| [rawQuery](#rawquery-property) | <code>string</code> | |
| [searchWords](#searchwords-property) | <code>string[]</code> | |
| [stats](#stats-property) | <code>QueryResultMetaStat[]</code> | Stats |
| [transformations](#transformations-property) | <code>string[]</code> | Used to track transformation ids that where part of the processing |
@@ -54,6 +53,16 @@ DatasSource Specific Values
custom?: Record<string, any>;
```
### executedQueryString property
This is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector
<b>Signature</b>
```typescript
executedQueryString?: string;
```
### gmdMeta property
Legacy data source specific, should be moved to custom
@@ -100,22 +109,6 @@ Currently used to show results in Explore only in preferred visualisation option
preferredVisualisationType?: PreferredVisualisationType;
```
### query property
<b>Signature</b>
```typescript
query?: string;
```
### rawQuery property
<b>Signature</b>
```typescript
rawQuery?: string;
```
### searchWords property
<b>Signature</b>
docs/sources/packages_api/data/rangeutil/getrelativetimeslist.md
+68 -22
View File
@@ -414,17 +414,40 @@ export declare function getRelativeTimesList(timepickerSettings: any, currentDis
to: string;
display: string;
section: number;
}[]) => U_3 | readonly U_3[], thisArg?: This | undefined) => U_3[]) | {
<U_4>(this: U_4[][][][][][][][], depth: 7): U_4[];
<U_5>(this: U_5[][][][][][][], depth: 6): U_5[];
<U_6>(this: U_6[][][][][][], depth: 5): U_6[];
<U_7>(this: U_7[][][][][], depth: 4): U_7[];
<U_8>(this: U_8[][][][], depth: 3): U_8[];
<U_9>(this: U_9[][][], depth: 2): U_9[];
<U_10>(this: U_10[][], depth?: 1 | undefined): U_10[];
<U_11>(this: U_11[], depth: 0): U_11[];
<U_12>(depth?: number | undefined): any[];
})[]>;
}[]) => U_3 | readonly U_3[], thisArg?: This | undefined) => U_3[]) | (<A, D extends number = 1>(this: A, depth?: D | undefined) => {
done: A;
recur: A extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? any[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D] extends -1 ? "done" : "recur"] : A;
}[D extends -1 ? "done" : "recur"][]))[]>;
```
<b>Import</b>
@@ -841,15 +864,38 @@ const { getRelativeTimesList } = rangeUtil;
to: string;
display: string;
section: number;
}[]) => U_3 | readonly U_3[], thisArg?: This | undefined) => U_3[]) | {
<U_4>(this: U_4[][][][][][][][], depth: 7): U_4[];
<U_5>(this: U_5[][][][][][][], depth: 6): U_5[];
<U_6>(this: U_6[][][][][][], depth: 5): U_6[];
<U_7>(this: U_7[][][][][], depth: 4): U_7[];
<U_8>(this: U_8[][][][], depth: 3): U_8[];
<U_9>(this: U_9[][][], depth: 2): U_9[];
<U_10>(this: U_10[][], depth?: 1 | undefined): U_10[];
<U_11>(this: U_11[], depth: 0): U_11[];
<U_12>(depth?: number | undefined): any[];
})[]>`
}[]) => U_3 | readonly U_3[], thisArg?: This | undefined) => U_3[]) | (<A, D extends number = 1>(this: A, depth?: D | undefined) => {
done: A;
recur: A extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? {
done: InnerArr;
recur: InnerArr extends readonly (infer InnerArr)[] ? any[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]] extends -1 ? "done" : "recur"] : InnerArr;
}[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D] extends -1 ? "done" : "recur"] : A;
}[D extends -1 ? "done" : "recur"][]))[]>`
docs/sources/packages_api/data/reducedataoptions.md
+11
View File
@@ -26,6 +26,7 @@ import { ReduceDataOptions } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [calcs](#calcs-property) | <code>string[]</code> | When !values, pick one value for the whole field |
| [fields](#fields-property) | <code>string</code> | Which fields to show. By default this is only numeric fields |
| [limit](#limit-property) | <code>number</code> | if showing all values limit |
| [values](#values-property) | <code>boolean</code> | |
@@ -39,6 +40,16 @@ When !values, pick one value for the whole field
calcs: string[];
```
### fields property
Which fields to show. By default this is only numeric fields
<b>Signature</b>
```typescript
fields?: string;
```
### limit property
if showing all values limit
docs/sources/packages_api/data/selectfieldconfigsettings.md
+23 -1
View File
@@ -23,10 +23,32 @@ import { SelectFieldConfigSettings } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [options](#options-property) | <code>Array&lt;SelectableValue&lt;T&gt;&gt;</code> | |
| [allowCustomValue](#allowcustomvalue-property) | <code>boolean</code> | |
| [getOptions](#getoptions-property) | <code>(context: FieldOverrideContext) =&gt; Promise&lt;Array&lt;SelectableValue&lt;T&gt;&gt;&gt;</code> | Optionally use the context to define the options |
| [options](#options-property) | <code>Array&lt;SelectableValue&lt;T&gt;&gt;</code> | The default options |
### allowCustomValue property
<b>Signature</b>
```typescript
allowCustomValue?: boolean;
```
### getOptions property
Optionally use the context to define the options
<b>Signature</b>
```typescript
getOptions?: (context: FieldOverrideContext) => Promise<Array<SelectableValue<T>>>;
```
### options property
The default options
<b>Signature</b>
```typescript
docs/sources/packages_api/data/standardeditorcontext.md
+61
View File
@@ -0,0 +1,61 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "StandardEditorContext"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## StandardEditorContext interface
<b>Signature</b>
```typescript
export interface StandardEditorContext<TOptions>
```
<b>Import</b>
```typescript
import { StandardEditorContext } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [data](#data-property) | <code>DataFrame[]</code> | |
| [getSuggestions](#getsuggestions-property) | <code>(scope?: VariableSuggestionsScope) =&gt; VariableSuggestion[]</code> | |
| [options](#options-property) | <code>TOptions</code> | |
| [replaceVariables](#replacevariables-property) | <code>InterpolateFunction</code> | |
### data property
<b>Signature</b>
```typescript
data?: DataFrame[];
```
### getSuggestions property
<b>Signature</b>
```typescript
getSuggestions?: (scope?: VariableSuggestionsScope) => VariableSuggestion[];
```
### options property
<b>Signature</b>
```typescript
options?: TOptions;
```
### replaceVariables property
<b>Signature</b>
```typescript
replaceVariables?: InterpolateFunction;
```
docs/sources/packages_api/data/standardeditorprops.md
+10 -1
View File
@@ -12,7 +12,7 @@ type = "docs"
<b>Signature</b>
```typescript
export interface StandardEditorProps<TValue = any, TSettings = any>
export interface StandardEditorProps<TValue = any, TSettings = any, TOptions = any>
```
<b>Import</b>
@@ -23,10 +23,19 @@ import { StandardEditorProps } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [context](#context-property) | <code>StandardEditorContext&lt;TOptions&gt;</code> | |
| [item](#item-property) | <code>StandardEditorsRegistryItem&lt;TValue, TSettings&gt;</code> | |
| [onChange](#onchange-property) | <code>(value?: TValue) =&gt; void</code> | |
| [value](#value-property) | <code>TValue</code> | |
### context property
<b>Signature</b>
```typescript
context: StandardEditorContext<TOptions>;
```
### item property
<b>Signature</b>
docs/sources/packages_api/data/standardtransformers.md
+1
View File
@@ -29,6 +29,7 @@ standardTransformers: {
renameFieldsTransformer: import("..").DataTransformerInfo<import("./transformers/rename").RenameFieldsTransformerOptions>;
labelsToFieldsTransformer: import("..").DataTransformerInfo<import("./transformers/labelsToFields").LabelsToFieldsOptions>;
ensureColumnsTransformer: import("..").DataTransformerInfo<any>;
mergeTransformer: import("..").DataTransformerInfo<import("./transformers/merge/merge").MergeTransformerOptions>;
}
```
<b>Import</b>
docs/sources/packages_api/data/timezonecountry.md
+43
View File
@@ -0,0 +1,43 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TimeZoneCountry"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TimeZoneCountry interface
<b>Signature</b>
```typescript
export interface TimeZoneCountry
```
<b>Import</b>
```typescript
import { TimeZoneCountry } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [code](#code-property) | <code>string</code> | |
| [name](#name-property) | <code>string</code> | |
### code property
<b>Signature</b>
```typescript
code: string;
```
### name property
<b>Signature</b>
```typescript
name: string;
```
docs/sources/packages_api/data/timezoneformatuserfriendly.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
timeZoneFormatUserFriendly: (timeZone: string | undefined) => string | undefined
timeZoneFormatUserFriendly: (timeZone: TimeZone | undefined) => string | undefined
```
<b>Import</b>
docs/sources/packages_api/data/timezoneinfo.md
+70
View File
@@ -0,0 +1,70 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TimeZoneInfo"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TimeZoneInfo interface
<b>Signature</b>
```typescript
export interface TimeZoneInfo
```
<b>Import</b>
```typescript
import { TimeZoneInfo } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [abbreviation](#abbreviation-property) | <code>string</code> | |
| [countries](#countries-property) | <code>TimeZoneCountry[]</code> | |
| [name](#name-property) | <code>string</code> | |
| [offsetInMins](#offsetinmins-property) | <code>number</code> | |
| [zone](#zone-property) | <code>string</code> | |
### abbreviation property
<b>Signature</b>
```typescript
abbreviation: string;
```
### countries property
<b>Signature</b>
```typescript
countries: TimeZoneCountry[];
```
### name property
<b>Signature</b>
```typescript
name: string;
```
### offsetInMins property
<b>Signature</b>
```typescript
offsetInMins: number;
```
### zone property
<b>Signature</b>
```typescript
zone: string;
```
docs/sources/packages_api/data/trace.md
+33
View File
@@ -0,0 +1,33 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Trace"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## Trace type
### Trace type
<b>Signature</b>
```typescript
export declare type Trace = TraceData & {
duration: number;
endTime: number;
spans: TraceSpan[];
startTime: number;
traceName: string;
services: Array<{
name: string;
numberOfSpans: number;
}>;
};
```
<b>Import</b>
```typescript
import { Trace } from '@grafana/data';
```
docs/sources/packages_api/data/tracedata.md
+27
View File
@@ -0,0 +1,27 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceData"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceData type
### TraceData type
<b>Signature</b>
```typescript
export declare type TraceData = {
processes: Record<string, TraceProcess>;
traceID: string;
warnings?: string[] | null;
};
```
<b>Import</b>
```typescript
import { TraceData } from '@grafana/data';
```
docs/sources/packages_api/data/tracekeyvaluepair.md
+29
View File
@@ -0,0 +1,29 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceKeyValuePair"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceKeyValuePair type
### TraceKeyValuePair type
All timestamps are in microseconds
<b>Signature</b>
```typescript
export declare type TraceKeyValuePair = {
key: string;
type?: string;
value: any;
};
```
<b>Import</b>
```typescript
import { TraceKeyValuePair } from '@grafana/data';
```
docs/sources/packages_api/data/tracelink.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceLink"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceLink type
### TraceLink type
<b>Signature</b>
```typescript
export declare type TraceLink = {
url: string;
text: string;
};
```
<b>Import</b>
```typescript
import { TraceLink } from '@grafana/data';
```
docs/sources/packages_api/data/tracelog.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceLog"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceLog type
### TraceLog type
<b>Signature</b>
```typescript
export declare type TraceLog = {
timestamp: number;
fields: TraceKeyValuePair[];
};
```
<b>Import</b>
```typescript
import { TraceLog } from '@grafana/data';
```
docs/sources/packages_api/data/traceprocess.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceProcess"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceProcess type
### TraceProcess type
<b>Signature</b>
```typescript
export declare type TraceProcess = {
serviceName: string;
tags: TraceKeyValuePair[];
};
```
<b>Import</b>
```typescript
import { TraceProcess } from '@grafana/data';
```
docs/sources/packages_api/data/tracespan.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceSpan"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceSpan type
### TraceSpan type
<b>Signature</b>
```typescript
export declare type TraceSpan = TraceSpanData & {
depth: number;
hasChildren: boolean;
process: TraceProcess;
relativeStartTime: number;
tags: NonNullable<TraceSpanData['tags']>;
references: NonNullable<TraceSpanData['references']>;
warnings: NonNullable<TraceSpanData['warnings']>;
subsidiarilyReferencedBy: TraceSpanReference[];
};
```
<b>Import</b>
```typescript
import { TraceSpan } from '@grafana/data';
```
docs/sources/packages_api/data/tracespandata.md
+35
View File
@@ -0,0 +1,35 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceSpanData"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceSpanData type
### TraceSpanData type
<b>Signature</b>
```typescript
export declare type TraceSpanData = {
spanID: string;
traceID: string;
processID: string;
operationName: string;
startTime: number;
duration: number;
logs: TraceLog[];
tags?: TraceKeyValuePair[];
references?: TraceSpanReference[];
warnings?: string[] | null;
flags: number;
};
```
<b>Import</b>
```typescript
import { TraceSpanData } from '@grafana/data';
```
docs/sources/packages_api/data/tracespanreference.md
+28
View File
@@ -0,0 +1,28 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "TraceSpanReference"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## TraceSpanReference type
### TraceSpanReference type
<b>Signature</b>
```typescript
export declare type TraceSpanReference = {
refType: 'CHILD_OF' | 'FOLLOWS_FROM';
span?: TraceSpan | null | undefined;
spanID: string;
traceID: string;
};
```
<b>Import</b>
```typescript
import { TraceSpanReference } from '@grafana/data';
```
docs/sources/packages_api/data/transformeruiprops.md
+2 -2
View File
@@ -23,13 +23,13 @@ import { TransformerUIProps } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [input](#input-property) | <code>DataFrame[]</code> | Pre-transform data rames |
| [input](#input-property) | <code>DataFrame[]</code> | Pre-transform data frames |
| [onChange](#onchange-property) | <code>(options: T) =&gt; void</code> | |
| [options](#options-property) | <code>T</code> | Transformer configuration, persisted on panel's model |
### input property
Pre-transform data rames
Pre-transform data frames
<b>Signature</b>
docs/sources/packages_api/data/updatedatasourcepluginresetoption.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
updateDatasourcePluginResetOption: <J, S extends {} = KeyValue<any>>(props: DataSourcePluginOptionsEditorProps<import("../types").DataSourceJsonData, {}>, key: string) => void
updateDatasourcePluginResetOption: <J, S extends {} = KeyValue<any>>(props: DataSourcePluginOptionsEditorProps, key: string) => void
```
<b>Import</b>
docs/sources/packages_api/data/variabletype.md
+1 -1
View File
@@ -14,7 +14,7 @@ type = "docs"
<b>Signature</b>
```typescript
export declare type VariableType = 'query' | 'adhoc' | 'constant' | 'datasource' | 'interval' | 'textbox' | 'custom';
export declare type VariableType = 'query' | 'adhoc' | 'constant' | 'datasource' | 'interval' | 'textbox' | 'custom' | 'system';
```
<b>Import</b>
docs/sources/packages_api/data/vector.md
+2 -2
View File
@@ -30,7 +30,7 @@ import { Vector } from '@grafana/data';
| Method | Description |
| --- | --- |
| [get(index)](#get-method) | Access the value by index (Like an array) |
| [toArray()](#toarray-method) | Get the resutls as an array. |
| [toArray()](#toarray-method) | Get the results as an array. |
### length property
@@ -61,7 +61,7 @@ get(index: number): T;
### toArray method
Get the resutls as an array.
Get the results as an array.
<b>Signature</b>