mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: generated a 7.0 version of the packages reference docs. (#24708)
* fixes so we match the transformer based on name properly. * changed the signature on the FieldMatcher. * introduced a names option so you can filter in name specificly. * changed so the matcher UI uses the new options format. * moved the exported functions together. * changing editors a bit. * made the filter by name work with both regex and name filtering. * fixed failing tests and make sure we always parse regex the same way. * removed unused code. * simplified to make the existing field overrides still working. * fixed issue reported by hugo. * added tests for the name matcher. * added tests for filter by name. * added more tests. * generated new version of the packages docs. * fixed spelling error. * regenerated the docs.
This commit is contained in:
Marcus Andersson
GitHub
parent
713fe39b1f
commit
6a0abf895e
@ -18,6 +18,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [AppendedVectors](./appendedvectors/) | This may be more trouble than it is worth. This trades some computation time for RAM -- rather than allocate a new array the size of all previous arrays, this just points the correct index to their original array values |
|
||||
| [AppPlugin](./appplugin/) | |
|
||||
| [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. |
|
||||
| [ConstantVector](./constantvector/) | |
|
||||
@ -34,13 +35,13 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [PanelOptionsEditorBuilder](./paneloptionseditorbuilder/) | Fluent API for declarative creation of panel options |
|
||||
| [PanelPlugin](./panelplugin/) | |
|
||||
| [Registry](./registry/) | |
|
||||
| [ScaledVector](./scaledvector/) | |
|
||||
| [SortedVector](./sortedvector/) | Values are returned in the order defined by the input parameter |
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [BinaryOperationID](./binaryoperationid/) | |
|
||||
| [ColorScheme](./colorscheme/) | |
|
||||
| [CoreApp](./coreapp/) | |
|
||||
| [CSVHeaderStyle](./csvheaderstyle/) | |
|
||||
@ -96,9 +97,11 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [getDecimalsForValue(value, decimalOverride)](./getdecimalsforvalue/) | |
|
||||
| [getDisplayProcessor(options)](./getdisplayprocessor/) | |
|
||||
| [getDisplayValueAlignmentFactors(values)](./getdisplayvaluealignmentfactors/) | |
|
||||
| [getFieldDisplayName(field, frame, allFrames)](./getfielddisplayname/) | |
|
||||
| [getFieldMatcher(config)](./getfieldmatcher/) | |
|
||||
| [getFlotPairs({ xField, yField, nullValueMode })](./getflotpairs/) | |
|
||||
| [getFlotPairsConstant(seriesData, range)](./getflotpairsconstant/) | Returns a constant series based on the first value from the provide series. |
|
||||
| [getFrameDisplayName(frame, index)](./getframedisplayname/) | Get an appropriate display title |
|
||||
| [getFrameMatchers(config)](./getframematchers/) | |
|
||||
| [getLogLevel(line)](./getloglevel/) | Returns the log level of a log line. Parse the line for level words. If no level is found, it returns <code>LogLevel.unknown</code>.<!-- -->Example: <code>getLogLevel('WARN 1999-12-31 this is great') // LogLevel.warn</code> |
|
||||
| [getLogLevelFromKey(key)](./getloglevelfromkey/) | |
|
||||
@ -111,13 +114,13 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [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? |
|
||||
| [hasLinks(field)](./haslinks/) | |
|
||||
| [locale(value, decimals)](./locale/) | |
|
||||
| [parseFlags(text)](./parseflags/) | Converts any mode modifiers in the text to the Javascript equivalent flag |
|
||||
| [parseLabels(labels)](./parselabels/) | Returns a map of label keys to value from an input selector string.<!-- -->Example: <code>parseLabels('{job="foo", instance="bar"}) // {job: "foo", instance: "bar"}</code> |
|
||||
| [readCSV(csv, options)](./readcsv/) | |
|
||||
| [reduceField(options)](./reducefield/) | |
|
||||
| [renderMarkdown(str)](./rendermarkdown/) | |
|
||||
| [resultsToDataFrames(rsp)](./resultstodataframes/) | |
|
||||
| [reverseDataFrame(data)](./reversedataframe/) | Returns a copy with all values reversed |
|
||||
| [scaledUnits(factor, extArray)](./scaledunits/) | |
|
||||
| [setMarkdownOptions(optionsOverride)](./setmarkdownoptions/) | |
|
||||
@ -128,6 +131,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [stringToJsRegex(str)](./stringtojsregex/) | |
|
||||
| [stringToMs(str)](./stringtoms/) | |
|
||||
| [toCSV(data, config)](./tocsv/) | |
|
||||
| [toDataFrame(data)](./todataframe/) | Inspect any object and return the results as a DataFrame |
|
||||
| [toDataFrameDTO(data)](./todataframedto/) | Returns a copy that does not include functions |
|
||||
| [toFixed(value, decimals)](./tofixed/) | |
|
||||
| [toFixedScaled(value, decimals, scaledDecimals, additionalDecimals, ext)](./tofixedscaled/) | |
|
||||
@ -153,7 +157,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [AppRootProps](./approotprops/) | |
|
||||
| [ArrowDataFrame](./arrowdataframe/) | |
|
||||
| [BuildInfo](./buildinfo/) | Describes the build information that will be available via the Grafana configuration. |
|
||||
| [CalculateFieldTransformerOptions](./calculatefieldtransformeroptions/) | |
|
||||
| [ColorFieldConfigSettings](./colorfieldconfigsettings/) | |
|
||||
| [Column](./column/) | |
|
||||
| [ConfigOverrideRule](./configoverriderule/) | |
|
||||
@ -186,9 +189,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/) | |
|
||||
| [DateTimeOptions](./datetimeoptions/) | The type describing date and time options. Used for all the helper functions available to parse or format date and time values. |
|
||||
| [DateTimeOptionsWhenParsing](./datetimeoptionswhenparsing/) | The type that describes options that can be passed when parsing a date and time value. |
|
||||
| [DateTimeOptionsWithFormat](./datetimeoptionswithformat/) | The type describing the options that can be passed to the [dateTimeFormat](./data/datetimeformat.md) helper function to control how the date and time value passed to the function is formatted. |
|
||||
| [DecimalInfo](./decimalinfo/) | |
|
||||
| [Dimension](./dimension/) | |
|
||||
| [DisplayValue](./displayvalue/) | |
|
||||
@ -211,9 +214,8 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [FieldOverrideContext](./fieldoverridecontext/) | |
|
||||
| [FieldOverrideEditorProps](./fieldoverrideeditorprops/) | |
|
||||
| [FieldReducerInfo](./fieldreducerinfo/) | |
|
||||
| [FieldState](./fieldstate/) | |
|
||||
| [FieldWithIndex](./fieldwithindex/) | |
|
||||
| [FilterFieldsByNameTransformerOptions](./filterfieldsbynametransformeroptions/) | |
|
||||
| [FilterFramesByRefIdTransformerOptions](./filterframesbyrefidtransformeroptions/) | |
|
||||
| [FlotDataPoint](./flotdatapoint/) | |
|
||||
| [FormattedValue](./formattedvalue/) | |
|
||||
| [FrameMatcherInfo](./framematcherinfo/) | |
|
||||
@ -242,7 +244,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [NavModelBreadcrumb](./navmodelbreadcrumb/) | |
|
||||
| [NavModelItem](./navmodelitem/) | |
|
||||
| [NumberFieldConfigSettings](./numberfieldconfigsettings/) | |
|
||||
| [OrganizeFieldsTransformerOptions](./organizefieldstransformeroptions/) | |
|
||||
| [PanelData](./paneldata/) | |
|
||||
| [PanelEditorProps](./paneleditorprops/) | |
|
||||
| [PanelModel](./panelmodel/) | |
|
||||
@ -270,7 +271,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [RawTimeRange](./rawtimerange/) | |
|
||||
| [ReadWriteVector](./readwritevector/) | Apache arrow vectors are Read/Write |
|
||||
| [ReduceDataOptions](./reducedataoptions/) | Options for how to turn DataFrames into an array of display values |
|
||||
| [ReduceTransformerOptions](./reducetransformeroptions/) | |
|
||||
| [RegexpOrNamesMatcherOptions](./regexpornamesmatcheroptions/) | |
|
||||
| [RegistryItem](./registryitem/) | |
|
||||
| [RegistryItemWithOptions](./registryitemwithoptions/) | |
|
||||
| [ScaledValue](./scaledvalue/) | |
|
||||
@ -279,7 +280,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [ScreenshotInfo](./screenshotinfo/) | |
|
||||
| [SelectableValue](./selectablevalue/) | Used in select elements |
|
||||
| [SelectFieldConfigSettings](./selectfieldconfigsettings/) | |
|
||||
| [SeriesToColumnsOptions](./seriestocolumnsoptions/) | |
|
||||
| [StandardEditorProps](./standardeditorprops/) | |
|
||||
| [StandardEditorsRegistryItem](./standardeditorsregistryitem/) | |
|
||||
| [StringFieldConfigSettings](./stringfieldconfigsettings/) | |
|
||||
@ -319,19 +319,19 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [binaryOperators](./binaryoperators/) | |
|
||||
| [booleanOverrideProcessor](./booleanoverrideprocessor/) | |
|
||||
| [createDimension](./createdimension/) | |
|
||||
| [createOrderFieldsComparer](./createorderfieldscomparer/) | |
|
||||
| [DataLinkBuiltInVars](./datalinkbuiltinvars/) | |
|
||||
| [dataLinksOverrideProcessor](./datalinksoverrideprocessor/) | |
|
||||
| [dateTime](./datetime/) | |
|
||||
| [dateTimeAsMoment](./datetimeasmoment/) | |
|
||||
| [dateTimeFormat](./datetimeformat/) | |
|
||||
| [dateTimeFormatISO](./datetimeformatiso/) | |
|
||||
| [dateTimeFormatTimeAgo](./datetimeformattimeago/) | |
|
||||
| [dateTimeFormatWithAbbrevation](./datetimeformatwithabbrevation/) | |
|
||||
| [dateTimeFormat](./datetimeformat/) | Helper function to format date and time according to the specified options. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->. |
|
||||
| [dateTimeFormatISO](./datetimeformatiso/) | Helper function to format date and time according to the standard ISO format e.g. 2013-02-04T22:44:30.652Z. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->. |
|
||||
| [dateTimeFormatTimeAgo](./datetimeformattimeago/) | Helper function to return elapsed time since passed date. The returned value will be formatted in a human readable format e.g. 4 years ago. If no options are supplied, then default values are used. For more details, see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [dateTimeFormatWithAbbrevation](./datetimeformatwithabbrevation/) | Helper function to format date and time according to the Grafana default formatting, but it also appends the time zone abbreviation at the end e.g. 2020-05-20 13:37:00 CET. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [dateTimeForTimeZone](./datetimefortimezone/) | |
|
||||
| [dateTimeParse](./datetimeparse/) | |
|
||||
| [dateTimeParse](./datetimeparse/) | Helper function to parse a number, text or Date to a DateTime value. If a timeZone is supplied the incoming value is parsed with that timeZone as a base. The only exception to this is if the passed value is in a UTC-based format. Then it will use UTC as the base. Examples on UTC-based values are Unix epoch and ISO formatted strings.<!-- -->It can also parse the Grafana quick date and time format, e.g. now-6h will be parsed as Date.now() - 6 hours and returned as a valid DateTime value.<!-- -->If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [DEFAULT\_DATE\_TIME\_FORMAT](./default_date_time_format/) | |
|
||||
| [DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT](./default_field_display_values_limit/) | |
|
||||
| [DefaultTimeRange](./defaulttimerange/) | |
|
||||
@ -381,7 +381,6 @@ 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/) | |
|
||||
@ -390,8 +389,10 @@ 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/) | |
|
||||
| [TIME\_SERIES\_TIME\_FIELD\_NAME](./time_series_time_field_name/) | |
|
||||
| [TIME\_SERIES\_VALUE\_FIELD\_NAME](./time_series_value_field_name/) | |
|
||||
| [timeZoneAbbrevation](./timezoneabbrevation/) | Helper function to return only the time zone abbreviation for a given date and time value. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [timeZoneFormatUserFriendly](./timezoneformatuserfriendly/) | |
|
||||
| [toDuration](./toduration/) | |
|
||||
| [toLegacyResponseData](./tolegacyresponsedata/) | |
|
||||
| [toPascalCase](./topascalcase/) | |
|
||||
@ -405,6 +406,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [valueMappingsOverrideProcessor](./valuemappingsoverrideprocessor/) | |
|
||||
| [VAR\_CALC](./var_calc/) | |
|
||||
| [VAR\_CELL\_PREFIX](./var_cell_prefix/) | |
|
||||
| [VAR\_FIELD\_LABELS](./var_field_labels/) | |
|
||||
| [VAR\_FIELD\_NAME](./var_field_name/) | |
|
||||
| [VAR\_SERIES\_NAME](./var_series_name/) | |
|
||||
|
||||
@ -412,15 +414,14 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [BinaryOperation](./binaryoperation/) | |
|
||||
| [Color](./color/) | |
|
||||
| [ColorDefinition](./colordefinition/) | |
|
||||
| [DataQueryResponseData](./dataqueryresponsedata/) | |
|
||||
| [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/) | |
|
||||
@ -440,6 +441,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [PanelMigrationHandler](./panelmigrationhandler/) | Called when a panel is first loaded with current panel model |
|
||||
| [PanelOptionEditorsRegistry](./paneloptioneditorsregistry/) | |
|
||||
| [PanelTypeChangedHandler](./paneltypechangedhandler/) | Called before a panel is initialized. Allows panel inspection for any updates before changing the panel type. |
|
||||
| [PreferredVisualisationType](./preferredvisualisationtype/) | |
|
||||
| [ScaleCalculator](./scalecalculator/) | |
|
||||
| [Subtract](./subtract/) | |
|
||||
| [TimeFragment](./timefragment/) | |
|
||||
@ -447,7 +449,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [TimeSeriesValue](./timeseriesvalue/) | |
|
||||
| [TimeZone](./timezone/) | |
|
||||
| [TimeZoneBrowser](./timezonebrowser/) | |
|
||||
| [TimeZoneResolver](./timezoneresolver/) | |
|
||||
| [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/) | |
|
||||
| [UrlQueryMap](./urlquerymap/) | Type to represent the values parsed from the query string. |
|
||||
| [UrlQueryValue](./urlqueryvalue/) | Type to represent the value of a single query variable. |
|
||||
|
||||
@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setTimeZoneResolver"
|
||||
title = "BinaryOperation"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## setTimeZoneResolver variable
|
||||
## BinaryOperation type
|
||||
|
||||
### setTimeZoneResolver variable
|
||||
### BinaryOperation type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setTimeZoneResolver: (resolver: TimeZoneResolver) => void
|
||||
export declare type BinaryOperation = (left: number, right: number) => number;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setTimeZoneResolver } from '@grafana/data';
|
||||
import { BinaryOperation } from '@grafana/data';
|
||||
```
|
||||
33
docs/sources/packages_api/data/binaryoperationid.md
Normal file
33
docs/sources/packages_api/data/binaryoperationid.md
Normal file
@ -0,0 +1,33 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BinaryOperationID"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## BinaryOperationID enum
|
||||
|
||||
### BinaryOperationID enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum BinaryOperationID
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BinaryOperationID } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Add | <code>"+"</code> | |
|
||||
| Divide | <code>"/"</code> | |
|
||||
| Multiply | <code>"*"</code> | |
|
||||
| Subtract | <code>"-"</code> | |
|
||||
|
||||
@ -2,28 +2,28 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ScaledVector"
|
||||
title = "BinaryOperationVector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## ScaledVector class
|
||||
## BinaryOperationVector class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class ScaledVector implements Vector<number>
|
||||
export declare class BinaryOperationVector implements Vector<number>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ScaledVector } from '@grafana/data';
|
||||
import { BinaryOperationVector } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(source, scale)](#constructor-sourcescale) | | Constructs a new instance of the <code>ScaledVector</code> class |
|
||||
| [constructor(left, right, operation)](#constructor-leftrightoperation) | | Constructs a new instance of the <code>BinaryOperationVector</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
@ -39,21 +39,22 @@ import { ScaledVector } from '@grafana/data';
|
||||
| [toArray()](#toarray-method) | | |
|
||||
| [toJSON()](#tojson-method) | | |
|
||||
|
||||
### constructor(source, scale)
|
||||
### constructor(left, right, operation)
|
||||
|
||||
Constructs a new instance of the `ScaledVector` class
|
||||
Constructs a new instance of the `BinaryOperationVector` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(source: Vector<number>, scale: number);
|
||||
constructor(left: Vector<number>, right: Vector<number>, operation: BinaryOperation);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| source | <code>Vector<number></code> | |
|
||||
| scale | <code>number</code> | |
|
||||
| left | <code>Vector<number></code> | |
|
||||
| right | <code>Vector<number></code> | |
|
||||
| operation | <code>BinaryOperation</code> | |
|
||||
|
||||
### length property
|
||||
|
||||
@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeParser"
|
||||
title = "binaryOperators"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## DateTimeParser type
|
||||
## binaryOperators variable
|
||||
|
||||
### DateTimeParser type
|
||||
### binaryOperators variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DateTimeParser<T extends DateTimeOptions = DateTimeOptions> = (value: DateTimeInput, options?: T) => DateTime;
|
||||
binaryOperators: Registry<BinaryOperatorInfo>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeParser } from '@grafana/data';
|
||||
import { binaryOperators } from '@grafana/data';
|
||||
```
|
||||
@ -1,70 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CalculateFieldTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## CalculateFieldTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface CalculateFieldTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CalculateFieldTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [alias](#alias-property) | <code>string</code> | |
|
||||
| [include](#include-property) | <code>string</code> | |
|
||||
| [nullValueMode](#nullvaluemode-property) | <code>NullValueMode</code> | |
|
||||
| [reducer](#reducer-property) | <code>ReducerID</code> | |
|
||||
| [replaceFields](#replacefields-property) | <code>boolean</code> | |
|
||||
|
||||
### alias property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alias?: string;
|
||||
```
|
||||
|
||||
### include property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
include?: string;
|
||||
```
|
||||
|
||||
### nullValueMode property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
nullValueMode?: NullValueMode;
|
||||
```
|
||||
|
||||
### reducer property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reducer: ReducerID;
|
||||
```
|
||||
|
||||
### replaceFields property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
replaceFields?: boolean;
|
||||
```
|
||||
@ -23,10 +23,19 @@ import { Column } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [custom](#custom-property) | <code>Record<string, any></code> | |
|
||||
| [filterable](#filterable-property) | <code>boolean</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### custom property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
custom?: Record<string, any>;
|
||||
```
|
||||
|
||||
### filterable property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -28,6 +28,7 @@ import { DataTransformerID } from '@grafana/data';
|
||||
| --- | --- | --- |
|
||||
| append | <code>"append"</code> | |
|
||||
| calculateField | <code>"calculateField"</code> | |
|
||||
| ensureColumns | <code>"ensureColumns"</code> | |
|
||||
| filterByRefId | <code>"filterByRefId"</code> | |
|
||||
| filterFields | <code>"filterFields"</code> | |
|
||||
| filterFieldsByName | <code>"filterFieldsByName"</code> | |
|
||||
|
||||
@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormat variable
|
||||
|
||||
Helper function to format date and time according to the specified options. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormatISO variable
|
||||
|
||||
Helper function to format date and time according to the standard ISO format e.g. 2013-02-04T22:44:30.652Z. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormatTimeAgo variable
|
||||
|
||||
Helper function to return elapsed time since passed date. The returned value will be formatted in a human readable format e.g. 4 years ago. If no options are supplied, then default values are used. For more details, see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormatWithAbbrevation variable
|
||||
|
||||
Helper function to format date and time according to the Grafana default formatting, but it also appends the time zone abbreviation at the end e.g. 2020-05-20 13:37:00 CET. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -9,6 +9,8 @@ type = "docs"
|
||||
|
||||
## DateTimeOptions interface
|
||||
|
||||
The type describing date and time options. Used for all the helper functions available to parse or format date and time values.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@ -23,10 +25,12 @@ import { DateTimeOptions } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [timeZone](#timezone-property) | <code>TimeZone</code> | |
|
||||
| [timeZone](#timezone-property) | <code>TimeZone</code> | Specify this if you want to override the timeZone used when parsing or formatting a date and time value. If no timeZone is set, the default timeZone for the current user is used. |
|
||||
|
||||
### timeZone property
|
||||
|
||||
Specify this if you want to override the timeZone used when parsing or formatting a date and time value. If no timeZone is set, the default timeZone for the current user is used.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -9,6 +9,8 @@ type = "docs"
|
||||
|
||||
## DateTimeOptionsWhenParsing interface
|
||||
|
||||
The type that describes options that can be passed when parsing a date and time value.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@ -23,10 +25,14 @@ import { DateTimeOptionsWhenParsing } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [roundUp](#roundup-property) | <code>boolean</code> | |
|
||||
| [roundUp](#roundup-property) | <code>boolean</code> | If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.<!-- -->Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00. |
|
||||
|
||||
### roundUp property
|
||||
|
||||
If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.
|
||||
|
||||
Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -9,6 +9,8 @@ type = "docs"
|
||||
|
||||
## DateTimeOptionsWithFormat interface
|
||||
|
||||
The type describing the options that can be passed to the [dateTimeFormat](./data/datetimeformat.md) helper function to control how the date and time value passed to the function is formatted.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@ -23,11 +25,13 @@ import { DateTimeOptionsWithFormat } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [defaultWithMS](#defaultwithms-property) | <code>boolean</code> | |
|
||||
| [format](#format-property) | <code>string</code> | |
|
||||
| [defaultWithMS](#defaultwithms-property) | <code>boolean</code> | Set this value to <code>true</code> if you want to include milliseconds when formatting date and time values in the default [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) format. |
|
||||
| [format](#format-property) | <code>string</code> | Specify a [momentjs](https://momentjs.com/docs/#/displaying/format) format to use a custom formatting pattern of the date and time value. If no format is set, then [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) is used. |
|
||||
|
||||
### defaultWithMS property
|
||||
|
||||
Set this value to `true` if you want to include milliseconds when formatting date and time values in the default [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) format.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@ -36,6 +40,8 @@ defaultWithMS?: boolean;
|
||||
|
||||
### format property
|
||||
|
||||
Specify a [momentjs](https://momentjs.com/docs/#/displaying/format) format to use a custom formatting pattern of the date and time value. If no format is set, then [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) is used.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -11,6 +11,12 @@ type = "docs"
|
||||
|
||||
### dateTimeParse variable
|
||||
|
||||
Helper function to parse a number, text or Date to a DateTime value. If a timeZone is supplied the incoming value is parsed with that timeZone as a base. The only exception to this is if the passed value is in a UTC-based format. Then it will use UTC as the base. Examples on UTC-based values are Unix epoch and ISO formatted strings.
|
||||
|
||||
It can also parse the Grafana quick date and time format, e.g. now-6h will be parsed as Date.now() - 6 hours and returned as a valid DateTime value.
|
||||
|
||||
If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -24,6 +24,7 @@ import { ExploreStartPageProps } from '@grafana/data';
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [datasource](#datasource-property) | <code>DataSourceApi</code> | |
|
||||
| [exploreId](#exploreid-property) | <code>any</code> | |
|
||||
| [exploreMode](#exploremode-property) | <code>ExploreMode</code> | |
|
||||
| [onClickExample](#onclickexample-property) | <code>(query: DataQuery) => void</code> | |
|
||||
|
||||
@ -35,6 +36,14 @@ import { ExploreStartPageProps } from '@grafana/data';
|
||||
datasource?: DataSourceApi;
|
||||
```
|
||||
|
||||
### exploreId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exploreId?: any;
|
||||
```
|
||||
|
||||
### exploreMode property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -23,26 +23,16 @@ import { Field } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
|
||||
| [config](#config-property) | <code>FieldConfig</code> | Meta info about how field and how to display it |
|
||||
| [display](#display-property) | <code>DisplayProcessor</code> | Convert a value for display |
|
||||
| [getLinks](#getlinks-property) | <code>(config: ValueLinkConfig) => Array<LinkModel<Field>></code> | Get value data links with variables interpolated |
|
||||
| [labels](#labels-property) | <code>Labels</code> | |
|
||||
| [name](#name-property) | <code>string</code> | Name of the field (column) |
|
||||
| [parse](#parse-property) | <code>(value: any) => T</code> | Convert text to the field value |
|
||||
| [state](#state-property) | <code>FieldState | null</code> | Cached values with appropriate display and id values |
|
||||
| [type](#type-property) | <code>FieldType</code> | Field value type (string, number, etc) |
|
||||
| [values](#values-property) | <code>V</code> | |
|
||||
|
||||
### calcs property
|
||||
|
||||
Cache of reduced values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
calcs?: FieldCalcs;
|
||||
```
|
||||
|
||||
### config property
|
||||
|
||||
Meta info about how field and how to display it
|
||||
@ -101,6 +91,16 @@ Convert text to the field value
|
||||
parse?: (value: any) => T;
|
||||
```
|
||||
|
||||
### state property
|
||||
|
||||
Cached values with appropriate display and id values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
state?: FieldState | null;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
Field value type (string, number, etc)
|
||||
|
||||
@ -37,9 +37,10 @@ import { FieldCache } from '@grafana/data';
|
||||
| --- | --- | --- |
|
||||
| [getFieldByName(name)](#getfieldbyname-method) | | Returns the first field with the given name. |
|
||||
| [getFields(type)](#getfields-method) | | |
|
||||
| [getFirstFieldOfType(type)](#getfirstfieldoftype-method) | | |
|
||||
| [getFirstFieldOfType(type, includeHidden)](#getfirstfieldoftype-method) | | |
|
||||
| [hasFieldNamed(name)](#hasfieldnamed-method) | | |
|
||||
| [hasFieldOfType(type)](#hasfieldoftype-method) | | |
|
||||
| [hasFieldWithNameAndType(name, type)](#hasfieldwithnameandtype-method) | | |
|
||||
|
||||
### constructor(data)
|
||||
|
||||
@ -105,13 +106,14 @@ getFields(type?: FieldType): FieldWithIndex[];
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getFirstFieldOfType(type: FieldType): FieldWithIndex | undefined;
|
||||
getFirstFieldOfType(type: FieldType, includeHidden?: boolean): FieldWithIndex | undefined;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| type | <code>FieldType</code> | |
|
||||
| includeHidden | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@ -151,3 +153,21 @@ hasFieldOfType(type: FieldType): boolean;
|
||||
|
||||
`boolean`
|
||||
|
||||
### hasFieldWithNameAndType method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasFieldWithNameAndType(name: string, type: FieldType): boolean;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | <code>string</code> | |
|
||||
| type | <code>FieldType</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FieldCalcs
|
||||
export interface FieldCalcs extends Record<string, any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
@ -30,6 +30,7 @@ import { FieldConfig } from '@grafana/data';
|
||||
| [color](#color-property) | <code>FieldColor</code> | |
|
||||
| [custom](#custom-property) | <code>TOptions</code> | |
|
||||
| [decimals](#decimals-property) | <code>number | null</code> | |
|
||||
| [displayName](#displayname-property) | <code>string</code> | |
|
||||
| [filterable](#filterable-property) | <code>boolean</code> | |
|
||||
| [links](#links-property) | <code>DataLink[]</code> | |
|
||||
| [mappings](#mappings-property) | <code>ValueMapping[]</code> | |
|
||||
@ -37,9 +38,7 @@ import { FieldConfig } from '@grafana/data';
|
||||
| [min](#min-property) | <code>number | null</code> | |
|
||||
| [noValue](#novalue-property) | <code>string</code> | |
|
||||
| [nullValueMode](#nullvaluemode-property) | <code>NullValueMode</code> | |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | |
|
||||
| [thresholds](#thresholds-property) | <code>ThresholdsConfig</code> | |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### color property
|
||||
@ -66,6 +65,14 @@ custom?: TOptions;
|
||||
decimals?: number | null;
|
||||
```
|
||||
|
||||
### displayName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
displayName?: string;
|
||||
```
|
||||
|
||||
### filterable property
|
||||
|
||||
<b>Signature</b>
|
||||
@ -122,14 +129,6 @@ noValue?: string;
|
||||
nullValueMode?: NullValueMode;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars?: ScopedVars;
|
||||
```
|
||||
|
||||
### thresholds property
|
||||
|
||||
<b>Signature</b>
|
||||
@ -138,14 +137,6 @@ scopedVars?: ScopedVars;
|
||||
thresholds?: ThresholdsConfig;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
||||
### unit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -27,6 +27,7 @@ import { FieldDisplay } from '@grafana/data';
|
||||
| [display](#display-property) | <code>DisplayValue</code> | |
|
||||
| [field](#field-property) | <code>FieldConfig</code> | |
|
||||
| [getLinks](#getlinks-property) | <code>() => LinkModel[]</code> | |
|
||||
| [hasLinks](#haslinks-property) | <code>boolean</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [rowIndex](#rowindex-property) | <code>number</code> | |
|
||||
| [sparkline](#sparkline-property) | <code>GraphSeriesValue[][]</code> | |
|
||||
@ -64,6 +65,14 @@ field: FieldConfig;
|
||||
getLinks?: () => LinkModel[];
|
||||
```
|
||||
|
||||
### hasLinks property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasLinks: boolean;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -14,7 +14,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type FieldMatcher = (field: Field) => boolean;
|
||||
export declare type FieldMatcher = (field: Field, frame: DataFrame, allFrames: DataFrame[]) => boolean;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
@ -27,6 +27,9 @@ import { FieldMatcherID } from '@grafana/data';
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| byName | <code>"byName"</code> | |
|
||||
| byNames | <code>"byNames"</code> | |
|
||||
| byRegexp | <code>"byRegexp"</code> | |
|
||||
| byRegexpOrNames | <code>"byRegexpOrNames"</code> | |
|
||||
| byType | <code>"byType"</code> | |
|
||||
| numeric | <code>"numeric"</code> | |
|
||||
| time | <code>"time"</code> | |
|
||||
|
||||
58
docs/sources/packages_api/data/fieldstate.md
Normal file
58
docs/sources/packages_api/data/fieldstate.md
Normal file
@ -0,0 +1,58 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FieldState"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FieldState interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FieldState
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FieldState } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
|
||||
| [displayName](#displayname-property) | <code>string | null</code> | An appropriate name for the field (does not include frame info) |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | Appropriate values for templating |
|
||||
|
||||
### calcs property
|
||||
|
||||
Cache of reduced values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
calcs?: FieldCalcs;
|
||||
```
|
||||
|
||||
### displayName property
|
||||
|
||||
An appropriate name for the field (does not include frame info)
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
displayName?: string | null;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
Appropriate values for templating
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars?: ScopedVars;
|
||||
```
|
||||
@ -1,43 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FilterFieldsByNameTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FilterFieldsByNameTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FilterFieldsByNameTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FilterFieldsByNameTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [exclude](#exclude-property) | <code>string[]</code> | |
|
||||
| [include](#include-property) | <code>string[]</code> | |
|
||||
|
||||
### exclude property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exclude?: string[];
|
||||
```
|
||||
|
||||
### include property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
include?: string[];
|
||||
```
|
||||
@ -1,43 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FilterFramesByRefIdTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FilterFramesByRefIdTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FilterFramesByRefIdTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FilterFramesByRefIdTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [exclude](#exclude-property) | <code>string</code> | |
|
||||
| [include](#include-property) | <code>string</code> | |
|
||||
|
||||
### exclude property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exclude?: string;
|
||||
```
|
||||
|
||||
### include property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
include?: string;
|
||||
```
|
||||
35
docs/sources/packages_api/data/getfielddisplayname.md
Normal file
35
docs/sources/packages_api/data/getfielddisplayname.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getFieldDisplayName"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getFieldDisplayName() function
|
||||
|
||||
### getFieldDisplayName() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getFieldDisplayName(field: Field, frame?: DataFrame, allFrames?: DataFrame[]): string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getFieldDisplayName } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| field | <code>Field</code> | |
|
||||
| frame | <code>DataFrame</code> | |
|
||||
| allFrames | <code>DataFrame[]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
36
docs/sources/packages_api/data/getframedisplayname.md
Normal file
36
docs/sources/packages_api/data/getframedisplayname.md
Normal file
@ -0,0 +1,36 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getFrameDisplayName"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getFrameDisplayName() function
|
||||
|
||||
### getFrameDisplayName() function
|
||||
|
||||
Get an appropriate display title
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getFrameDisplayName(frame: DataFrame, index?: number): string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getFrameDisplayName } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| frame | <code>DataFrame</code> | |
|
||||
| index | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
@ -24,7 +24,7 @@ import { GrafanaThemeCommons } from '@grafana/data';
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [border](#border-property) | <code>{</code><br/><code> radius: {</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> };</code><br/><code> width: {</code><br/><code> sm: string;</code><br/><code> };</code><br/><code> }</code> | |
|
||||
| [breakpoints](#breakpoints-property) | <code>{</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> xl: string;</code><br/><code> }</code> | |
|
||||
| [breakpoints](#breakpoints-property) | <code>{</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> xl: string;</code><br/><code> xxl: string;</code><br/><code> }</code> | |
|
||||
| [height](#height-property) | <code>{</code><br/><code> sm: number;</code><br/><code> md: number;</code><br/><code> lg: number;</code><br/><code> }</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [panelHeaderHeight](#panelheaderheight-property) | <code>number</code> | |
|
||||
@ -61,6 +61,7 @@ breakpoints: {
|
||||
md: string;
|
||||
lg: string;
|
||||
xl: string;
|
||||
xxl: string;
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@ -2,32 +2,32 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "resultsToDataFrames"
|
||||
title = "hasLinks"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## resultsToDataFrames() function
|
||||
## hasLinks() function
|
||||
|
||||
### resultsToDataFrames() function
|
||||
### hasLinks() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function resultsToDataFrames(rsp: any): DataFrame[];
|
||||
export declare function hasLinks(field: Field): boolean;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { resultsToDataFrames } from '@grafana/data';
|
||||
import { hasLinks } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rsp | <code>any</code> | |
|
||||
| field | <code>Field</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataFrame[]`
|
||||
`boolean`
|
||||
|
||||
@ -37,7 +37,9 @@ import { LogLevel } from '@grafana/data';
|
||||
| eror | <code>"error"</code> | |
|
||||
| err | <code>"error"</code> | |
|
||||
| error | <code>"error"</code> | |
|
||||
| fatal | <code>"critical"</code> | |
|
||||
| info | <code>"info"</code> | |
|
||||
| information | <code>"info"</code> | |
|
||||
| notice | <code>"info"</code> | |
|
||||
| trace | <code>"trace"</code> | |
|
||||
| unknown | <code>"unknown"</code> | |
|
||||
|
||||
@ -34,6 +34,7 @@ import { LogRowModel } from '@grafana/data';
|
||||
| [rowIndex](#rowindex-property) | <code>number</code> | |
|
||||
| [searchWords](#searchwords-property) | <code>string[]</code> | |
|
||||
| [timeEpochMs](#timeepochms-property) | <code>number</code> | |
|
||||
| [timeEpochNs](#timeepochns-property) | <code>string</code> | |
|
||||
| [timeFromNow](#timefromnow-property) | <code>string</code> | |
|
||||
| [timeLocal](#timelocal-property) | <code>string</code> | |
|
||||
| [timeUtc](#timeutc-property) | <code>string</code> | |
|
||||
@ -128,6 +129,14 @@ searchWords?: string[];
|
||||
timeEpochMs: number;
|
||||
```
|
||||
|
||||
### timeEpochNs property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeEpochNs: string;
|
||||
```
|
||||
|
||||
### timeFromNow property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -1,34 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "OrganizeFieldsTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## OrganizeFieldsTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface OrganizeFieldsTransformerOptions extends OrderFieldsTransformerOptions, RenameFieldsTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { OrganizeFieldsTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [excludeByName](#excludebyname-property) | <code>Record<string, boolean></code> | |
|
||||
|
||||
### excludeByName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
excludeByName: Record<string, boolean>;
|
||||
```
|
||||
@ -32,6 +32,7 @@ import { PanelEvents } from '@grafana/data';
|
||||
| --- | --- |
|
||||
| [componentDidMount](./componentdidmount/) | |
|
||||
| [dataError](./dataerror/) | |
|
||||
| [dataFramesReceived](./dataframesreceived/) | |
|
||||
| [dataReceived](./datareceived/) | |
|
||||
| [dataSnapshotLoad](./datasnapshotload/) | |
|
||||
| [editModeInitialized](./editmodeinitialized/) | |
|
||||
|
||||
@ -2,22 +2,23 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "createOrderFieldsComparer"
|
||||
title = "dataFramesReceived"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## createOrderFieldsComparer variable
|
||||
## PanelEvents.dataFramesReceived variable
|
||||
|
||||
### createOrderFieldsComparer variable
|
||||
### PanelEvents.dataFramesReceived variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
createOrderFieldsComparer: (indexByName: Record<string, number>) => (a: string, b: string) => number
|
||||
dataFramesReceived: import("./appEvents").AppEvent<DataFrame[]>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { createOrderFieldsComparer } from '@grafana/data';
|
||||
import { PanelEvents } from '@grafana/data';
|
||||
const { dataFramesReceived } = PanelEvents;
|
||||
```
|
||||
@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeFormatter"
|
||||
title = "PreferredVisualisationType"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## DateTimeFormatter type
|
||||
## PreferredVisualisationType type
|
||||
|
||||
### DateTimeFormatter type
|
||||
### PreferredVisualisationType type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DateTimeFormatter<T extends DateTimeOptions = DateTimeOptions> = (dateInUtc: DateTimeInput, options?: T) => string;
|
||||
export declare type PreferredVisualisationType = 'graph' | 'table';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeFormatter } from '@grafana/data';
|
||||
import { PreferredVisualisationType } from '@grafana/data';
|
||||
```
|
||||
@ -27,6 +27,8 @@ import { QueryEditorProps } from '@grafana/data';
|
||||
| [datasource](#datasource-property) | <code>DSType</code> | |
|
||||
| [exploreId](#exploreid-property) | <code>any</code> | |
|
||||
| [exploreMode](#exploremode-property) | <code>ExploreMode</code> | |
|
||||
| [history](#history-property) | <code>HistoryItem[]</code> | |
|
||||
| [onBlur](#onblur-property) | <code>() => void</code> | |
|
||||
| [onChange](#onchange-property) | <code>(value: TQuery) => void</code> | |
|
||||
| [onRunQuery](#onrunquery-property) | <code>() => void</code> | |
|
||||
| [query](#query-property) | <code>TQuery</code> | |
|
||||
@ -65,6 +67,22 @@ exploreId?: any;
|
||||
exploreMode?: ExploreMode;
|
||||
```
|
||||
|
||||
### history property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
history?: HistoryItem[];
|
||||
```
|
||||
|
||||
### onBlur property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onBlur?: () => void;
|
||||
```
|
||||
|
||||
### onChange property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -29,6 +29,7 @@ import { QueryResultMeta } from '@grafana/data';
|
||||
| [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> | |
|
||||
@ -89,6 +90,16 @@ Meta Notices
|
||||
notices?: QueryResultMetaNotice[];
|
||||
```
|
||||
|
||||
### preferredVisualisationType property
|
||||
|
||||
Currently used to show results in Explore only in preferred visualisation option
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
preferredVisualisationType?: PreferredVisualisationType;
|
||||
```
|
||||
|
||||
### query property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -23,15 +23,15 @@ import { QueryResultMetaStat } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
| [displayName](#displayname-property) | <code>string</code> | |
|
||||
| [value](#value-property) | <code>number</code> | |
|
||||
|
||||
### title property
|
||||
### displayName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title: string;
|
||||
displayName: string;
|
||||
```
|
||||
|
||||
### value property
|
||||
|
||||
@ -14,7 +14,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
convertRawToRange: (raw: RawTimeRange) => TimeRange
|
||||
convertRawToRange: (raw: RawTimeRange, timeZone?: string | undefined) => TimeRange
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
@ -2,42 +2,42 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ReduceTransformerOptions"
|
||||
title = "RegexpOrNamesMatcherOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## ReduceTransformerOptions interface
|
||||
## RegexpOrNamesMatcherOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface ReduceTransformerOptions
|
||||
export interface RegexpOrNamesMatcherOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ReduceTransformerOptions } from '@grafana/data';
|
||||
import { RegexpOrNamesMatcherOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [fields](#fields-property) | <code>MatcherConfig</code> | |
|
||||
| [reducers](#reducers-property) | <code>ReducerID[]</code> | |
|
||||
| [names](#names-property) | <code>string[]</code> | |
|
||||
| [pattern](#pattern-property) | <code>string</code> | |
|
||||
|
||||
### fields property
|
||||
### names property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
fields?: MatcherConfig;
|
||||
names?: string[];
|
||||
```
|
||||
|
||||
### reducers property
|
||||
### pattern property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reducers: ReducerID[];
|
||||
pattern?: string;
|
||||
```
|
||||
@ -1,34 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "SeriesToColumnsOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## SeriesToColumnsOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface SeriesToColumnsOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { SeriesToColumnsOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [byField](#byfield-property) | <code>string</code> | |
|
||||
|
||||
### byField property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
byField?: string;
|
||||
```
|
||||
@ -28,6 +28,7 @@ standardTransformers: {
|
||||
seriesToColumnsTransformer: import("..").DataTransformerInfo<import("./transformers/seriesToColumns").SeriesToColumnsOptions>;
|
||||
renameFieldsTransformer: import("..").DataTransformerInfo<import("./transformers/rename").RenameFieldsTransformerOptions>;
|
||||
labelsToFieldsTransformer: import("..").DataTransformerInfo<import("./transformers/labelsToFields").LabelsToFieldsOptions>;
|
||||
ensureColumnsTransformer: import("..").DataTransformerInfo<any>;
|
||||
}
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "TIME_SERIES_TIME_FIELD_NAME"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## TIME\_SERIES\_TIME\_FIELD\_NAME variable
|
||||
|
||||
### TIME\_SERIES\_TIME\_FIELD\_NAME variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
TIME_SERIES_TIME_FIELD_NAME = "Time"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { TIME_SERIES_TIME_FIELD_NAME } from '@grafana/data';
|
||||
```
|
||||
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "TIME_SERIES_VALUE_FIELD_NAME"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## TIME\_SERIES\_VALUE\_FIELD\_NAME variable
|
||||
|
||||
### TIME\_SERIES\_VALUE\_FIELD\_NAME variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
TIME_SERIES_VALUE_FIELD_NAME = "Value"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { TIME_SERIES_VALUE_FIELD_NAME } from '@grafana/data';
|
||||
```
|
||||
@ -26,6 +26,7 @@ import { TimeSeries } from '@grafana/data';
|
||||
| [datapoints](#datapoints-property) | <code>TimeSeriesPoints</code> | |
|
||||
| [tags](#tags-property) | <code>Labels</code> | |
|
||||
| [target](#target-property) | <code>string</code> | |
|
||||
| [title](#title-property) | <code>string</code> | If name is manually configured via an alias / legend pattern |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### datapoints property
|
||||
@ -52,6 +53,16 @@ tags?: Labels;
|
||||
target: string;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
If name is manually configured via an alias / legend pattern
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
||||
### unit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### timeZoneAbbrevation variable
|
||||
|
||||
Helper function to return only the time zone abbreviation for a given date and time value. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
23
docs/sources/packages_api/data/timezoneformatuserfriendly.md
Normal file
23
docs/sources/packages_api/data/timezoneformatuserfriendly.md
Normal file
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "timeZoneFormatUserFriendly"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## timeZoneFormatUserFriendly variable
|
||||
|
||||
### timeZoneFormatUserFriendly variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeZoneFormatUserFriendly: (timeZone: string | undefined) => string | undefined
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { timeZoneFormatUserFriendly } from '@grafana/data';
|
||||
```
|
||||
@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### TimeZoneResolver type
|
||||
|
||||
The type to describe the time zone resolver function that will be used to access the default time zone of a user.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@ -7,17 +7,29 @@ keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## toDataFrame variable
|
||||
## toDataFrame() function
|
||||
|
||||
### toDataFrame variable
|
||||
### toDataFrame() function
|
||||
|
||||
Inspect any object and return the results as a DataFrame
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toDataFrame: (data: any) => DataFrame
|
||||
export declare function toDataFrame(data: any): DataFrame;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { toDataFrame } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| data | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataFrame`
|
||||
|
||||
|
||||
23
docs/sources/packages_api/data/var_field_labels.md
Normal file
23
docs/sources/packages_api/data/var_field_labels.md
Normal file
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "VAR_FIELD_LABELS"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## VAR\_FIELD\_LABELS variable
|
||||
|
||||
### VAR\_FIELD\_LABELS variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
VAR_FIELD_LABELS = "__field.labels"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { VAR_FIELD_LABELS } from '@grafana/data';
|
||||
```
|
||||
@ -35,6 +35,8 @@ A library containing services, configurations etc. used to interact with the Gra
|
||||
| [getEchoSrv()](./getechosrv/) | Used to retrieve the [EchoSrv](./runtime/echosrv.md) that can be used to report events to registered echo backends. |
|
||||
| [getLocationSrv()](./getlocationsrv/) | Used to retrieve the [LocationSrv](./runtime/locationsrv.md) that can be used to automatically navigate the user to a new place in Grafana. |
|
||||
| [loadPluginCss(options)](./loadplugincss/) | Use this to load css for a Grafana plugin by specifying a [PluginCssOptions](./runtime/plugincssoptions.md) containing styling for the dark and the light theme. |
|
||||
| [toDataQueryError(err)](./todataqueryerror/) | Convert an object into a DataQueryError -- if this is an HTTP response, it will put the correct values in the error filds |
|
||||
| [toDataQueryResponse(res)](./todataqueryresponse/) | Parse the results from \`<!-- -->/api/ds/query |
|
||||
|
||||
## Interfaces
|
||||
|
||||
@ -58,7 +60,7 @@ A library containing services, configurations etc. used to interact with the Gra
|
||||
| [MetaAnalyticsEvent](./metaanalyticsevent/) | Describes meta analytics event with predefined [EchoEventType.MetaAnalytics](./runtime/echoeventtype/metaanalytics.md) type. |
|
||||
| [PluginCssOptions](./plugincssoptions/) | Option to specify a plugin css that should be applied for the dark and the light theme. |
|
||||
| [SizeMeta](./sizemeta/) | Describes a size with width/height |
|
||||
| [TemplateSrv](./templatesrv/) | Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.<!-- -->For a more in-depth description visit: https://grafana.com/docs/grafana/latest/variables/templates-and-variables |
|
||||
| [TemplateSrv](./templatesrv/) | Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.<!-- -->For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating |
|
||||
|
||||
## Variables
|
||||
|
||||
@ -66,6 +68,7 @@ A library containing services, configurations etc. used to interact with the Gra
|
||||
| --- | --- |
|
||||
| [config](./config/) | Use this to access the [GrafanaBootConfig](./runtime/grafanabootconfig.md) for the current running Grafana instance. |
|
||||
| [getBackendSrv](./getbackendsrv/) | Used to retrieve the [BackendSrv](./runtime/backendsrv.md) that can be used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. |
|
||||
| [getLegacyAngularInjector](./getlegacyangularinjector/) | <b><i>(BETA)</i></b> WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future. |
|
||||
| [getTemplateSrv](./gettemplatesrv/) | Used to retrieve the [TemplateSrv](./runtime/templatesrv.md) that can be used to fetch available template variables. |
|
||||
| [registerEchoBackend](./registerechobackend/) | Used to register echo backends that will receive Grafana echo events during application runtime. |
|
||||
| [reportMetaAnalytics](./reportmetaanalytics/) | Helper function to report meta analytics to the [EchoSrv](./runtime/echosrv.md)<!-- -->. |
|
||||
|
||||
@ -37,7 +37,6 @@ import { DataSourceWithBackend } from '@grafana/runtime';
|
||||
| [postResource(path, body)](#postresource-method) | | Send a POST request to the datasource resource path |
|
||||
| [query(request)](#query-method) | | Ideally final -- any other implementation may not work as expected |
|
||||
| [testDatasource()](#testdatasource-method) | | Checks the plugin health |
|
||||
| [toDataQueryResponse(rsp)](#todataqueryresponse-method) | | This makes the arrow library loading async. |
|
||||
|
||||
### constructor(instanceSettings)
|
||||
|
||||
@ -159,22 +158,3 @@ testDatasource(): Promise<any>;
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### toDataQueryResponse method
|
||||
|
||||
This makes the arrow library loading async.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toDataQueryResponse(rsp: any): Promise<DataQueryResponse>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rsp | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<DataQueryResponse>`
|
||||
|
||||
|
||||
@ -0,0 +1,28 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getLegacyAngularInjector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getLegacyAngularInjector variable
|
||||
|
||||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
||||
>
|
||||
|
||||
### getLegacyAngularInjector variable
|
||||
|
||||
WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getLegacyAngularInjector: () => auto.IInjectorService
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getLegacyAngularInjector } from '@grafana/runtime';
|
||||
```
|
||||
@ -11,7 +11,7 @@ type = "docs"
|
||||
|
||||
Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.
|
||||
|
||||
For a more in-depth description visit: https://grafana.com/docs/grafana/latest/variables/templates-and-variables
|
||||
For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@ -27,10 +27,13 @@ import { TemplateSrv } from '@grafana/runtime';
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [getVariables()](#getvariables-method) | |
|
||||
| [getVariables()](#getvariables-method) | List the dashboard variables |
|
||||
| [replace(target, scopedVars, format)](#replace-method) | Replace the values within the target string. See also |
|
||||
|
||||
### getVariables method
|
||||
|
||||
List the dashboard variables
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@ -40,3 +43,24 @@ getVariables(): VariableModel[];
|
||||
|
||||
`VariableModel[]`
|
||||
|
||||
### replace method
|
||||
|
||||
Replace the values within the target string. See also
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
replace(target: string, scopedVars?: ScopedVars, format?: string | Function): string;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| target | <code>string</code> | |
|
||||
| scopedVars | <code>ScopedVars</code> | |
|
||||
| format | <code>string | Function</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
|
||||
35
docs/sources/packages_api/runtime/todataqueryerror.md
Normal file
35
docs/sources/packages_api/runtime/todataqueryerror.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "toDataQueryError"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## toDataQueryError() function
|
||||
|
||||
### toDataQueryError() function
|
||||
|
||||
Convert an object into a DataQueryError -- if this is an HTTP response, it will put the correct values in the error filds
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function toDataQueryError(err: any): DataQueryError;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { toDataQueryError } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| err | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataQueryError`
|
||||
|
||||
35
docs/sources/packages_api/runtime/todataqueryresponse.md
Normal file
35
docs/sources/packages_api/runtime/todataqueryresponse.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "toDataQueryResponse"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## toDataQueryResponse() function
|
||||
|
||||
### toDataQueryResponse() function
|
||||
|
||||
Parse the results from \`<!-- -->/api/ds/query
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function toDataQueryResponse(res: any): DataQueryResponse;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { toDataQueryResponse } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| res | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataQueryResponse`
|
||||
|
||||
@ -97,12 +97,13 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [stylesFactory(stylesCreator)](./stylesfactory/) | Creates memoized version of styles creator |
|
||||
| [SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, })](./suggestionsplugin/) | |
|
||||
| [useTheme()](./usetheme/) | |
|
||||
| [ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, })](./valuepicker/) | |
|
||||
| [ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, })](./valuepicker/) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [BadgeProps](./badgeprops/) | |
|
||||
| [BigValueSparkline](./bigvaluesparkline/) | |
|
||||
| [CascaderOption](./cascaderoption/) | |
|
||||
| [CompletionItem](./completionitem/) | |
|
||||
@ -142,6 +143,7 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [Alert](./alert/) | |
|
||||
| [ALERTING\_COLOR](./alerting_color/) | |
|
||||
| [AlphaNotice](./alphanotice/) | |
|
||||
| [Badge](./badge/) | |
|
||||
| [Button](./button/) | |
|
||||
| [ButtonCascader](./buttoncascader/) | |
|
||||
| [CallToActionCard](./calltoactioncard/) | |
|
||||
@ -165,10 +167,11 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [Drawer](./drawer/) | |
|
||||
| [EmptySearchResult](./emptysearchresult/) | |
|
||||
| [ErrorWithStack](./errorwithstack/) | |
|
||||
| [FeatureInfoBox](./featureinfobox/) | |
|
||||
| [Field](./field/) | |
|
||||
| [FieldConfigItemHeaderTitle](./fieldconfigitemheadertitle/) | |
|
||||
| [fieldMatchersUI](./fieldmatchersui/) | |
|
||||
| [Forms](./forms/) | |
|
||||
| [FilterPill](./filterpill/) | |
|
||||
| [FullWidthButtonContainer](./fullwidthbuttoncontainer/) | |
|
||||
| [getAvailableIcons](./getavailableicons/) | |
|
||||
| [getButtonStyles](./getbuttonstyles/) | |
|
||||
@ -176,12 +179,11 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [getLogRowStyles](./getlogrowstyles/) | |
|
||||
| [getStandardFieldConfigs](./getstandardfieldconfigs/) | Returns collection of common field config properties definitions |
|
||||
| [getStandardOptionEditors](./getstandardoptioneditors/) | Returns collection of standard option editors definitions |
|
||||
| [getStandardTransformers](./getstandardtransformers/) | |
|
||||
| [getTheme](./gettheme/) | |
|
||||
| [GraphContextMenu](./graphcontextmenu/) | |
|
||||
| [GraphLegend](./graphlegend/) | |
|
||||
| [graphTickFormatter](./graphtickformatter/) | |
|
||||
| [graphTimeFormat](./graphtimeformat/) | |
|
||||
| [graphTimeFormatter](./graphtimeformatter/) | |
|
||||
| [GraphWithLegend](./graphwithlegend/) | |
|
||||
| [hasValidationEvent](./hasvalidationevent/) | |
|
||||
| [HorizontalGroup](./horizontalgroup/) | |
|
||||
@ -244,6 +246,7 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [TimeRangePicker](./timerangepicker/) | |
|
||||
| [ToggleButton](./togglebutton/) | |
|
||||
| [Tooltip](./tooltip/) | |
|
||||
| [useStyles](./usestyles/) | Hook for using memoized styles with access to the theme. |
|
||||
| [validate](./validate/) | |
|
||||
| [VerticalGroup](./verticalgroup/) | |
|
||||
| [withTheme](./withtheme/) | |
|
||||
@ -253,6 +256,7 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [AlertVariant](./alertvariant/) | |
|
||||
| [BadgeColor](./badgecolor/) | |
|
||||
| [ButtonProps](./buttonprops/) | |
|
||||
| [ButtonVariant](./buttonvariant/) | |
|
||||
| [FormAPI](./formapi/) | |
|
||||
|
||||
@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getStandardTransformers"
|
||||
title = "Badge"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getStandardTransformers variable
|
||||
## Badge variable
|
||||
|
||||
### getStandardTransformers variable
|
||||
### Badge variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getStandardTransformers: () => TransformerRegistyItem<any>[]
|
||||
Badge: React.NamedExoticComponent<BadgeProps>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getStandardTransformers } from '@grafana/ui';
|
||||
import { Badge } from '@grafana/ui';
|
||||
```
|
||||
@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "graphTimeFormatter"
|
||||
title = "BadgeColor"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## graphTimeFormatter variable
|
||||
## BadgeColor type
|
||||
|
||||
### graphTimeFormatter variable
|
||||
### BadgeColor type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
graphTimeFormatter: (timeZone?: string | undefined) => (epoch: number, format: string) => string
|
||||
export declare type BadgeColor = 'blue' | 'red' | 'green' | 'orange' | 'purple';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { graphTimeFormatter } from '@grafana/ui';
|
||||
import { BadgeColor } from '@grafana/ui';
|
||||
```
|
||||
61
docs/sources/packages_api/ui/badgeprops.md
Normal file
61
docs/sources/packages_api/ui/badgeprops.md
Normal file
@ -0,0 +1,61 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BadgeProps"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## BadgeProps interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface BadgeProps
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BadgeProps } from '@grafana/ui';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [color](#color-property) | <code>BadgeColor</code> | |
|
||||
| [icon](#icon-property) | <code>IconName</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
| [tooltip](#tooltip-property) | <code>string</code> | |
|
||||
|
||||
### color property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
color: BadgeColor;
|
||||
```
|
||||
|
||||
### icon property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
icon?: IconName;
|
||||
```
|
||||
|
||||
### text property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
text: string;
|
||||
```
|
||||
|
||||
### tooltip property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
tooltip?: string;
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
@ -16,7 +16,7 @@ type = "docs"
|
||||
```typescript
|
||||
ColorPicker: React.FunctionComponent<Pick<import("./ColorPickerPopover").Props<import("./ColorPickerPopover").CustomPickersDescriptor> & {
|
||||
children?: ColorPickerTriggerRenderer | undefined;
|
||||
}, "onChange" | "color" | "children" | "customPickers" | "onColorChange" | "enableNamedColors" | "updatePopperPosition">>
|
||||
}, "onChange" | "color" | "children" | "onColorChange" | "enableNamedColors" | "customPickers" | "updatePopperPosition">>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
23
docs/sources/packages_api/ui/featureinfobox.md
Normal file
23
docs/sources/packages_api/ui/featureinfobox.md
Normal file
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FeatureInfoBox"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FeatureInfoBox variable
|
||||
|
||||
### FeatureInfoBox variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
FeatureInfoBox: React.MemoExoticComponent<React.ForwardRefExoticComponent<FeatureInfoBox & React.RefAttributes<HTMLDivElement>>>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FeatureInfoBox } from '@grafana/ui';
|
||||
```
|
||||
23
docs/sources/packages_api/ui/filterpill.md
Normal file
23
docs/sources/packages_api/ui/filterpill.md
Normal file
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FilterPill"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FilterPill variable
|
||||
|
||||
### FilterPill variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
FilterPill: React.FC<FilterPillProps>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FilterPill } from '@grafana/ui';
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
@ -35,7 +35,7 @@ import { Gauge } from '@grafana/ui';
|
||||
| [componentDidUpdate()](#componentdidupdate-method) | | |
|
||||
| [draw()](#draw-method) | | |
|
||||
| [getFontScale(length)](#getfontscale-method) | | |
|
||||
| [getFormattedThresholds()](#getformattedthresholds-method) | | |
|
||||
| [getFormattedThresholds(decimals)](#getformattedthresholds-method) | | |
|
||||
| [render()](#render-method) | | |
|
||||
|
||||
### canvasElement property
|
||||
@ -117,8 +117,14 @@ getFontScale(length: number): number;
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getFormattedThresholds(): Threshold[];
|
||||
getFormattedThresholds(decimals: number): Threshold[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| decimals | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Threshold[]`
|
||||
|
||||
23
docs/sources/packages_api/ui/graphtickformatter.md
Normal file
23
docs/sources/packages_api/ui/graphtickformatter.md
Normal file
@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "graphTickFormatter"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## graphTickFormatter variable
|
||||
|
||||
### graphTickFormatter variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
graphTickFormatter: (epoch: number, axis: any) => string
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { graphTickFormatter } from '@grafana/ui';
|
||||
```
|
||||
@ -14,7 +14,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type IconName = 'fa fa-spinner' | 'grafana' | 'question-circle' | 'angle-up' | 'history' | 'angle-down' | 'filter' | 'angle-left' | 'angle-right' | 'pen' | 'envelope' | 'percentage' | 'rocket' | 'power' | 'trash-alt' | 'slack' | 'download-alt' | 'mobile-android' | 'plus-square' | 'folder-plus' | 'folder-open' | 'folder' | 'file-copy-alt' | 'file-alt' | 'exchange-alt' | 'import' | 'exclamation-triangle' | 'times' | 'signin' | 'cloud-upload' | 'step-backward' | 'square-shape' | 'share-alt' | 'tag-alt' | 'forward' | 'check' | 'check-circle' | 'copy' | 'lock' | 'unlock' | 'panel-add' | 'arrow-random' | 'arrow-down' | 'arrows-h' | 'comment-alt' | 'code-branch' | 'arrow-right' | 'circle' | 'arrow-up' | 'arrow-from-right' | 'keyboard' | 'search' | 'chart-line' | 'search-minus' | 'clock-nine' | 'sync' | 'sign-in-alt' | 'cloud-download' | 'cog' | 'bars' | 'save' | 'apps' | 'link' | 'upload' | 'columns' | 'home-alt' | 'channel-add' | 'calendar-alt' | 'play' | 'pause' | 'calculator-alt' | 'compass' | 'sliders-v-alt' | 'bell' | 'database' | 'user' | 'camera' | 'plug' | 'shield' | 'key-skeleton-alt' | 'users-alt' | 'graph-bar' | 'book' | 'bolt' | 'comments-alt' | 'document-info' | 'info-circle' | 'bug' | 'cube' | 'star' | 'list-ul' | 'edit' | 'eye' | 'eye-slash' | 'monitor' | 'plus-circle' | 'arrow-left' | 'repeat' | 'external-link-alt' | 'minus' | 'signal' | 'search-plus' | 'minus-circle' | 'table' | 'plus' | 'heart' | 'heart-break' | 'ellipsis-v' | 'favorite' | 'line-alt' | 'sort-amount-down';
|
||||
export declare type IconName = 'fa fa-spinner' | 'grafana' | 'question-circle' | 'angle-up' | 'history' | 'angle-down' | 'filter' | 'angle-left' | 'angle-right' | 'pen' | 'envelope' | 'percentage' | 'rocket' | 'power' | 'trash-alt' | 'slack' | 'download-alt' | 'mobile-android' | 'plus-square' | 'folder-plus' | 'folder-open' | 'folder' | 'file-copy-alt' | 'file-alt' | 'exchange-alt' | 'import' | 'exclamation-triangle' | 'times' | 'signin' | 'cloud-upload' | 'step-backward' | 'square-shape' | 'share-alt' | 'tag-alt' | 'forward' | 'check' | 'check-circle' | 'copy' | 'lock' | 'unlock' | 'panel-add' | 'arrow-random' | 'arrow-down' | 'arrows-h' | 'comment-alt' | 'code-branch' | 'arrow-right' | 'circle' | 'arrow-up' | 'arrow-from-right' | 'keyboard' | 'search' | 'chart-line' | 'search-minus' | 'clock-nine' | 'sync' | 'sign-in-alt' | 'cloud-download' | 'cog' | 'bars' | 'save' | 'apps' | 'link' | 'upload' | 'columns' | 'home-alt' | 'channel-add' | 'calendar-alt' | 'play' | 'pause' | 'calculator-alt' | 'compass' | 'sliders-v-alt' | 'bell' | 'database' | 'user' | 'camera' | 'plug' | 'shield' | 'key-skeleton-alt' | 'users-alt' | 'graph-bar' | 'book' | 'bolt' | 'comments-alt' | 'document-info' | 'info-circle' | 'bug' | 'cube' | 'star' | 'list-ul' | 'edit' | 'eye' | 'eye-slash' | 'monitor' | 'plus-circle' | 'arrow-left' | 'repeat' | 'external-link-alt' | 'minus' | 'signal' | 'search-plus' | 'minus-circle' | 'table' | 'plus' | 'heart' | 'heart-break' | 'ellipsis-v' | 'favorite' | 'line-alt' | 'sort-amount-down' | 'cloud';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -23,7 +23,6 @@ import { UnitPicker } from '@grafana/ui';
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> width: number;</code><br/><code> }</code> | |
|
||||
| [onChange](#onchange-property) | | <code>(value: SelectableValue<string>) => void</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
@ -32,16 +31,6 @@ import { UnitPicker } from '@grafana/ui';
|
||||
| --- | --- | --- |
|
||||
| [render()](#render-method) | | |
|
||||
|
||||
### defaultProps property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
static defaultProps: {
|
||||
width: number;
|
||||
};
|
||||
```
|
||||
|
||||
### onChange property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
25
docs/sources/packages_api/ui/usestyles.md
Normal file
25
docs/sources/packages_api/ui/usestyles.md
Normal file
@ -0,0 +1,25 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "useStyles"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## useStyles variable
|
||||
|
||||
### useStyles variable
|
||||
|
||||
Hook for using memoized styles with access to the theme.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
useStyles: (getStyles: (theme?: GrafanaTheme | undefined) => any) => any
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { useStyles } from '@grafana/ui';
|
||||
```
|
||||
@ -14,7 +14,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function ValuePicker<T>({ label, icon, options, onChange, variant, size, isFullWidth, }: ValuePickerProps<T>): JSX.Element;
|
||||
export declare function ValuePicker<T>({ label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, }: ValuePickerProps<T>): JSX.Element;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
@ -25,7 +25,7 @@ import { ValuePicker } from '@grafana/ui';
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| { label, icon, options, onChange, variant, size, isFullWidth, } | <code>ValuePickerProps<T></code> | |
|
||||
| { label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, } | <code>ValuePickerProps<T></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
||||
@ -82,7 +82,7 @@ export interface Field<T = any, V = Vector<T>> {
|
||||
labels?: Labels;
|
||||
|
||||
/**
|
||||
* Cached values with appropriate dispaly and id values
|
||||
* Cached values with appropriate display and id values
|
||||
*/
|
||||
state?: FieldState | null;
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user