mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: adding first version of the auto-generated packages API docs. (#22107)
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
This commit is contained in:
Marcus Andersson
GitHub
parent
89e6c45090
commit
6bc369629d
@ -935,7 +935,7 @@ jobs:
|
||||
- run:
|
||||
# Important: all words have to be in lowercase, and separated by "\n".
|
||||
name: exclude known exceptions
|
||||
command: 'echo -e "unknwon\nreferer\nerrorstring" > words_to_ignore.txt'
|
||||
command: 'echo -e "unknwon\nreferer\nerrorstring\neror" > words_to_ignore.txt'
|
||||
- run:
|
||||
name: check documentation spelling errors
|
||||
command: 'codespell -I ./words_to_ignore.txt docs/'
|
||||
|
||||
@ -343,6 +343,17 @@
|
||||
link: /http_api/team/
|
||||
- name: Users
|
||||
link: /http_api/user/
|
||||
- name: SDK Reference
|
||||
link: /packages_api/
|
||||
children:
|
||||
- name: "@grafana/data"
|
||||
link: /packages_api/data/
|
||||
- name: "@grafana/e2e"
|
||||
link: /packages_api/e2e/
|
||||
- name: "@grafana/runtime"
|
||||
link: /packages_api/runtime/
|
||||
- name: "@grafana/ui"
|
||||
link: /packages_api/ui/
|
||||
- name: Developers
|
||||
link: /developers/
|
||||
children:
|
||||
|
||||
21
docs/sources/packages_api/_index.md
Normal file
21
docs/sources/packages_api/_index.md
Normal file
@ -0,0 +1,21 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "API Reference"
|
||||
keywords = ["grafana","documentation","sdk"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## API Reference
|
||||
|
||||
### Packages
|
||||
|
||||
| Package | Description |
|
||||
| --- | --- |
|
||||
| [@grafana/data](./data/) | A library containing most of the core functionality and data types used in Grafana. |
|
||||
| [@grafana/e2e](./e2e/) | A library for writing end-to-end tests for Grafana and its ecosystem. |
|
||||
| [@grafana/runtime](./runtime/) | A library containing services, configurations etc. used to interact with the Grafana engine. |
|
||||
| [@grafana/ui](./ui/) | A library containing the different design components of the Grafana ecosystem. |
|
||||
|
||||
388
docs/sources/packages_api/data/_index.md
Normal file
388
docs/sources/packages_api/data/_index.md
Normal file
@ -0,0 +1,388 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "@grafana/data"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## @grafana/data package
|
||||
|
||||
A library containing most of the core functionality and data types used in Grafana.
|
||||
|
||||
## Classes
|
||||
|
||||
| Class | Description |
|
||||
| --- | --- |
|
||||
| [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/) | |
|
||||
| [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/) | |
|
||||
| [CSVReader](./csvreader/) | |
|
||||
| [DataFrameView](./dataframeview/) | <b><i>(BETA)</i></b> This abstraction will present the contents of a DataFrame as if it were a well typed javascript object Vector. |
|
||||
| [DataSourceApi](./datasourceapi/) | The main data source abstraction interface, represents an instance of a data source<!-- -->Although this is a class, datasource implementations do not \*yet\* need to extend it. As such, we can not yet add functions with default implementations. |
|
||||
| [DataSourcePlugin](./datasourceplugin/) | |
|
||||
| [FieldCache](./fieldcache/) | |
|
||||
| [GrafanaPlugin](./grafanaplugin/) | |
|
||||
| [LanguageProvider](./languageprovider/) | |
|
||||
| [MutableDataFrame](./mutabledataframe/) | |
|
||||
| [PanelPlugin](./panelplugin/) | |
|
||||
| [Registry](./registry/) | |
|
||||
| [ScaledVector](./scaledvector/) | |
|
||||
| [SortedVector](./sortedvector/) | Values are returned in the order defined by the input parameter |
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [ColorScheme](./colorscheme/) | |
|
||||
| [CoreApp](./coreapp/) | |
|
||||
| [CSVHeaderStyle](./csvheaderstyle/) | |
|
||||
| [DataSourceStatus](./datasourcestatus/) | |
|
||||
| [DataTransformerID](./datatransformerid/) | |
|
||||
| [ExploreMode](./exploremode/) | |
|
||||
| [FieldColorMode](./fieldcolormode/) | |
|
||||
| [FieldMatcherID](./fieldmatcherid/) | |
|
||||
| [FieldType](./fieldtype/) | |
|
||||
| [FrameMatcherID](./framematcherid/) | Field name matchers |
|
||||
| [GrafanaThemeType](./grafanathemetype/) | |
|
||||
| [LoadingState](./loadingstate/) | |
|
||||
| [LogLevel](./loglevel/) | Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation. |
|
||||
| [LogsDedupDescription](./logsdedupdescription/) | |
|
||||
| [LogsDedupStrategy](./logsdedupstrategy/) | |
|
||||
| [LogsMetaKind](./logsmetakind/) | |
|
||||
| [MappingType](./mappingtype/) | |
|
||||
| [MatcherID](./matcherid/) | |
|
||||
| [NullValueMode](./nullvaluemode/) | |
|
||||
| [OrgRole](./orgrole/) | |
|
||||
| [PluginIncludeType](./pluginincludetype/) | |
|
||||
| [PluginState](./pluginstate/) | |
|
||||
| [PluginType](./plugintype/) | |
|
||||
| [ReducerID](./reducerid/) | |
|
||||
| [ThresholdsMode](./thresholdsmode/) | |
|
||||
| [VariableOrigin](./variableorigin/) | |
|
||||
| [VariableSuggestionsScope](./variablesuggestionsscope/) | |
|
||||
| [VizOrientation](./vizorientation/) | |
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [addLogLevelToSeries(series, lineIndex)](./addlogleveltoseries/) | |
|
||||
| [applyFieldOverrides(options)](./applyfieldoverrides/) | Return a copy of the DataFrame with all rules applied |
|
||||
| [arrowTableToDataFrame(table)](./arrowtabletodataframe/) | |
|
||||
| [base64StringToArrowTable(text)](./base64stringtoarrowtable/) | |
|
||||
| [calculateFieldStats(rows, extractor)](./calculatefieldstats/) | |
|
||||
| [calculateLogsLabelStats(rows, label)](./calculatelogslabelstats/) | |
|
||||
| [calculateStats(values)](./calculatestats/) | |
|
||||
| [eventFactory(name)](./eventfactory/) | |
|
||||
| [findCommonLabels(labelsSets)](./findcommonlabels/) | Returns a map labels that are common to the given label sets. |
|
||||
| [findHighlightChunksInText({ searchWords, textToHighlight, })](./findhighlightchunksintext/) | Adapt findMatchesInText for react-highlight-words findChunks handler. See https://github.com/bvaughn/react-highlight-words\#props |
|
||||
| [findMatchesInText(haystack, needle)](./findmatchesintext/) | Returns a list of substring regexp matches. |
|
||||
| [findUniqueLabels(labels, commonLabels)](./finduniquelabels/) | Returns a map of labels that are in <code>labels</code>, but not in <code>commonLabels</code>. |
|
||||
| [formatLabels(labels, defaultValue)](./formatlabels/) | Serializes the given labels to a string. |
|
||||
| [formattedValueToString(val)](./formattedvaluetostring/) | |
|
||||
| [getActiveThreshold(value, thresholds)](./getactivethreshold/) | |
|
||||
| [getDataFrameRow(data, row)](./getdataframerow/) | Wrapper to get an array from each field value |
|
||||
| [getDecimalsForValue(value, decimalOverride)](./getdecimalsforvalue/) | |
|
||||
| [getDisplayProcessor(options)](./getdisplayprocessor/) | |
|
||||
| [getDisplayValueAlignmentFactors(values)](./getdisplayvaluealignmentfactors/) | |
|
||||
| [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. |
|
||||
| [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/) | |
|
||||
| [getParser(line)](./getparser/) | |
|
||||
| [getScaleCalculator(field, theme)](./getscalecalculator/) | |
|
||||
| [getValueFormat(id)](./getvalueformat/) | |
|
||||
| [getValueFormats()](./getvalueformats/) | |
|
||||
| [getValueFormatterIndex()](./getvalueformatterindex/) | |
|
||||
| [grafanaDataFrameToArrowTable(data)](./grafanadataframetoarrowtable/) | |
|
||||
| [guessFieldTypeForField(field)](./guessfieldtypeforfield/) | Looks at the data to guess the column type. This ignores any existing setting |
|
||||
| [guessFieldTypeFromValue(v)](./guessfieldtypefromvalue/) | Given a value this will guess the best column type<!-- -->TODO: better Date/Time support! Look for standard date strings? |
|
||||
| [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/) | |
|
||||
| [simpleCountUnit(symbol)](./simplecountunit/) | |
|
||||
| [sortDataFrame(data, sortIndex, reverse)](./sortdataframe/) | |
|
||||
| [sortThresholds(thresholds)](./sortthresholds/) | Sorts the thresholds |
|
||||
| [stringStartsAsRegEx(str)](./stringstartsasregex/) | |
|
||||
| [stringToJsRegex(str)](./stringtojsregex/) | |
|
||||
| [stringToMs(str)](./stringtoms/) | |
|
||||
| [toCSV(data, config)](./tocsv/) | |
|
||||
| [toDataFrameDTO(data)](./todataframedto/) | Returns a copy that does not include functions |
|
||||
| [toFixed(value, decimals)](./tofixed/) | |
|
||||
| [toFixedScaled(value, decimals, scaledDecimals, additionalDecimals, ext)](./tofixedscaled/) | |
|
||||
| [toFixedUnit(unit, asPrefix)](./tofixedunit/) | |
|
||||
| [toFloatOrUndefined(value)](./tofloatorundefined/) | |
|
||||
| [toIntegerOrUndefined(value)](./tointegerorundefined/) | |
|
||||
| [toNumberString(value)](./tonumberstring/) | |
|
||||
| [transformDataFrame(options, data)](./transformdataframe/) | Apply configured transformations to the input data |
|
||||
| [updateDatasourcePluginOption(props, key, val)](./updatedatasourcepluginoption/) | |
|
||||
| [updateDatasourcePluginResetOption(props, key)](./updatedatasourcepluginresetoption/) | |
|
||||
| [validateFieldConfig(config)](./validatefieldconfig/) | This checks that all options on FieldConfig make sense. It mutates any value that needs fixed. In particular this makes sure that the first threshold value is -Infinity (not valid in JSON) |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [AbsoluteTimeRange](./absolutetimerange/) | |
|
||||
| [AngularPanelMenuItem](./angularpanelmenuitem/) | |
|
||||
| [AnnotationEvent](./annotationevent/) | |
|
||||
| [AnnotationQueryRequest](./annotationqueryrequest/) | Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md |
|
||||
| [AppEvent](./appevent/) | |
|
||||
| [AppPluginMeta](./apppluginmeta/) | |
|
||||
| [AppRootProps](./approotprops/) | |
|
||||
| [ArrowDataFrame](./arrowdataframe/) | |
|
||||
| [Column](./column/) | |
|
||||
| [ConfigOverrideRule](./configoverriderule/) | |
|
||||
| [CreatePlotOverlay](./createplotoverlay/) | |
|
||||
| [CSVConfig](./csvconfig/) | |
|
||||
| [CSVOptions](./csvoptions/) | |
|
||||
| [CSVParseCallbacks](./csvparsecallbacks/) | |
|
||||
| [DataFrame](./dataframe/) | |
|
||||
| [DataFrameDTO](./dataframedto/) | Like a DataFrame, but fields may be a FieldDTO |
|
||||
| [DataLink](./datalink/) | Link configuration. The values may contain variables that need to be processed before running |
|
||||
| [DataLinkClickEvent](./datalinkclickevent/) | Callback info for DataLink click events |
|
||||
| [DataQuery](./dataquery/) | |
|
||||
| [DataQueryError](./dataqueryerror/) | |
|
||||
| [DataQueryRequest](./dataqueryrequest/) | |
|
||||
| [DataQueryResponse](./dataqueryresponse/) | |
|
||||
| [DataSourceConstructor](./datasourceconstructor/) | |
|
||||
| [DataSourceInstanceSettings](./datasourceinstancesettings/) | Frontend settings model that is passed to Datasource constructor. This differs a bit from the model above as this data model is available to every user who has access to a data source (Viewers+). This is loaded in bootData (on page load), or from: /api/frontend/settings |
|
||||
| [DataSourceJsonData](./datasourcejsondata/) | |
|
||||
| [DataSourcePluginComponents](./datasourceplugincomponents/) | |
|
||||
| [DataSourcePluginMeta](./datasourcepluginmeta/) | |
|
||||
| [DataSourcePluginOptionsEditorProps](./datasourcepluginoptionseditorprops/) | |
|
||||
| [DataSourceSelectItem](./datasourceselectitem/) | |
|
||||
| [DataSourceSettings](./datasourcesettings/) | Data Source instance edit model. This is returned from: /api/datasources |
|
||||
| [DataTransformerConfig](./datatransformerconfig/) | |
|
||||
| [DataTransformerInfo](./datatransformerinfo/) | |
|
||||
| [DateTime](./datetime/) | |
|
||||
| [DateTimeBuiltinFormat](./datetimebuiltinformat/) | |
|
||||
| [DateTimeDuration](./datetimeduration/) | |
|
||||
| [DateTimeLocale](./datetimelocale/) | |
|
||||
| [DecimalInfo](./decimalinfo/) | |
|
||||
| [Dimension](./dimension/) | |
|
||||
| [DisplayValue](./displayvalue/) | |
|
||||
| [DisplayValueAlignmentFactors](./displayvaluealignmentfactors/) | These represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues |
|
||||
| [DynamicConfigValue](./dynamicconfigvalue/) | |
|
||||
| [ExploreQueryFieldProps](./explorequeryfieldprops/) | |
|
||||
| [ExploreStartPageProps](./explorestartpageprops/) | |
|
||||
| [Field](./field/) | |
|
||||
| [FieldCalcs](./fieldcalcs/) | |
|
||||
| [FieldColor](./fieldcolor/) | |
|
||||
| [FieldConfig](./fieldconfig/) | Every property is optional<!-- -->Plugins may extend this with additional properties. Something like series overrides |
|
||||
| [FieldConfigEditorProps](./fieldconfigeditorprops/) | |
|
||||
| [FieldConfigSource](./fieldconfigsource/) | |
|
||||
| [FieldDisplay](./fielddisplay/) | |
|
||||
| [FieldDisplayOptions](./fielddisplayoptions/) | |
|
||||
| [FieldDTO](./fielddto/) | Like a field, but properties are optional and values may be a simple array |
|
||||
| [FieldMatcherInfo](./fieldmatcherinfo/) | |
|
||||
| [FieldOverrideContext](./fieldoverridecontext/) | |
|
||||
| [FieldOverrideEditorProps](./fieldoverrideeditorprops/) | |
|
||||
| [FieldPropertyEditorItem](./fieldpropertyeditoritem/) | |
|
||||
| [FieldReducerInfo](./fieldreducerinfo/) | |
|
||||
| [FieldWithIndex](./fieldwithindex/) | |
|
||||
| [FilterFieldsByNameTransformerOptions](./filterfieldsbynametransformeroptions/) | |
|
||||
| [FilterFramesByRefIdTransformerOptions](./filterframesbyrefidtransformeroptions/) | |
|
||||
| [FlotDataPoint](./flotdatapoint/) | |
|
||||
| [FormattedValue](./formattedvalue/) | |
|
||||
| [FrameMatcherInfo](./framematcherinfo/) | |
|
||||
| [GetFieldDisplayValuesOptions](./getfielddisplayvaluesoptions/) | |
|
||||
| [GrafanaTheme](./grafanatheme/) | |
|
||||
| [GrafanaThemeCommons](./grafanathemecommons/) | |
|
||||
| [GraphSeriesXY](./graphseriesxy/) | View model projection of a series |
|
||||
| [HistoryItem](./historyitem/) | |
|
||||
| [IntervalValues](./intervalvalues/) | |
|
||||
| [Labels](./labels/) | |
|
||||
| [LinkModel](./linkmodel/) | Processed Link Model. The values are ready to use |
|
||||
| [LinkModelSupplier](./linkmodelsupplier/) | Provides a way to produce links on demand<!-- -->TODO: ScopedVars in in GrafanaUI package! |
|
||||
| [LogLabelStatsModel](./loglabelstatsmodel/) | |
|
||||
| [LogRowModel](./logrowmodel/) | |
|
||||
| [LogSearchMatch](./logsearchmatch/) | |
|
||||
| [LogsMetaItem](./logsmetaitem/) | |
|
||||
| [LogsModel](./logsmodel/) | |
|
||||
| [LogsParser](./logsparser/) | |
|
||||
| [MatcherConfig](./matcherconfig/) | |
|
||||
| [MetadataInspectorProps](./metadatainspectorprops/) | |
|
||||
| [MetricFindValue](./metricfindvalue/) | |
|
||||
| [MutableVector](./mutablevector/) | Vector with standard manipulation functions |
|
||||
| [NavModel](./navmodel/) | |
|
||||
| [NavModelBreadcrumb](./navmodelbreadcrumb/) | |
|
||||
| [NavModelItem](./navmodelitem/) | |
|
||||
| [PanelData](./paneldata/) | |
|
||||
| [PanelEditorProps](./paneleditorprops/) | |
|
||||
| [PanelMenuItem](./panelmenuitem/) | |
|
||||
| [PanelModel](./panelmodel/) | |
|
||||
| [PanelPluginMeta](./panelpluginmeta/) | |
|
||||
| [PanelProps](./panelprops/) | |
|
||||
| [PluginBuildInfo](./pluginbuildinfo/) | |
|
||||
| [PluginConfigPage](./pluginconfigpage/) | |
|
||||
| [PluginConfigPageProps](./pluginconfigpageprops/) | |
|
||||
| [PluginDependencies](./plugindependencies/) | |
|
||||
| [PluginInclude](./plugininclude/) | |
|
||||
| [PluginMeta](./pluginmeta/) | |
|
||||
| [PluginMetaInfo](./pluginmetainfo/) | |
|
||||
| [QueryEditorProps](./queryeditorprops/) | |
|
||||
| [QueryFix](./queryfix/) | |
|
||||
| [QueryFixAction](./queryfixaction/) | |
|
||||
| [QueryHint](./queryhint/) | |
|
||||
| [QueryResultBase](./queryresultbase/) | |
|
||||
| [QueryResultMeta](./queryresultmeta/) | |
|
||||
| [RangeMap](./rangemap/) | |
|
||||
| [RawTimeRange](./rawtimerange/) | |
|
||||
| [ReadWriteVector](./readwritevector/) | Apache arrow vectors are Read/Write |
|
||||
| [ReduceTransformerOptions](./reducetransformeroptions/) | |
|
||||
| [RegistryItem](./registryitem/) | |
|
||||
| [RegistryItemWithOptions](./registryitemwithoptions/) | |
|
||||
| [ScaledValue](./scaledvalue/) | |
|
||||
| [ScopedVar](./scopedvar/) | |
|
||||
| [ScopedVars](./scopedvars/) | |
|
||||
| [ScreenshotInfo](./screenshotinfo/) | |
|
||||
| [SelectableValue](./selectablevalue/) | Used in select elements |
|
||||
| [TableData](./tabledata/) | |
|
||||
| [TextMatch](./textmatch/) | |
|
||||
| [Threshold](./threshold/) | |
|
||||
| [ThresholdsConfig](./thresholdsconfig/) | |
|
||||
| [TimeOption](./timeoption/) | |
|
||||
| [TimeOptions](./timeoptions/) | |
|
||||
| [TimeRange](./timerange/) | |
|
||||
| [TimeSeries](./timeseries/) | |
|
||||
| [UserOrgDTO](./userorgdto/) | |
|
||||
| [ValueFormat](./valueformat/) | |
|
||||
| [ValueFormatCategory](./valueformatcategory/) | |
|
||||
| [ValueMap](./valuemap/) | |
|
||||
| [VariableSuggestion](./variablesuggestion/) | |
|
||||
| [Vector](./vector/) | |
|
||||
| [YAxis](./yaxis/) | |
|
||||
|
||||
## Namespaces
|
||||
|
||||
| Namespace | Description |
|
||||
| --- | --- |
|
||||
| [AppEvents](./appevents/) | |
|
||||
| [dateMath](./datemath/) | |
|
||||
| [PanelEvents](./panelevents/) | |
|
||||
| [rangeUtil](./rangeutil/) | |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [createDimension](./createdimension/) | |
|
||||
| [dateTime](./datetime/) | |
|
||||
| [dateTimeAsMoment](./datetimeasmoment/) | |
|
||||
| [dateTimeForTimeZone](./datetimefortimezone/) | |
|
||||
| [DEFAULT\_DATE\_TIME\_FORMAT](./default_date_time_format/) | |
|
||||
| [DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT](./default_field_display_values_limit/) | |
|
||||
| [DefaultTimeRange](./defaulttimerange/) | |
|
||||
| [DefaultTimeZone](./defaulttimezone/) | |
|
||||
| [deprecationWarning](./deprecationwarning/) | |
|
||||
| [escapeStringForRegex](./escapestringforregex/) | |
|
||||
| [fieldMatchers](./fieldmatchers/) | |
|
||||
| [fieldReducers](./fieldreducers/) | |
|
||||
| [frameMatchers](./framematchers/) | |
|
||||
| [getAllValuesFromDimension](./getallvaluesfromdimension/) | |
|
||||
| [getColorByName](./getcolorbyname/) | |
|
||||
| [getColorDefinition](./getcolordefinition/) | |
|
||||
| [getColorDefinitionByName](./getcolordefinitionbyname/) | |
|
||||
| [getColorForTheme](./getcolorfortheme/) | |
|
||||
| [getColorFromHexRgbOrName](./getcolorfromhexrgborname/) | |
|
||||
| [getColorName](./getcolorname/) | |
|
||||
| [getColumnFromDimension](./getcolumnfromdimension/) | |
|
||||
| [getColumnsFromDimension](./getcolumnsfromdimension/) | |
|
||||
| [getDimensionByName](./getdimensionbyname/) | |
|
||||
| [getFieldDisplayValues](./getfielddisplayvalues/) | |
|
||||
| [getLocaleData](./getlocaledata/) | |
|
||||
| [getMappedValue](./getmappedvalue/) | |
|
||||
| [getNamedColorPalette](./getnamedcolorpalette/) | |
|
||||
| [getSeriesTimeStep](./getseriestimestep/) | Returns minimal time step from series time field |
|
||||
| [getTimeField](./gettimefield/) | |
|
||||
| [getTimeZoneGroups](./gettimezonegroups/) | |
|
||||
| [getValueFromDimension](./getvaluefromdimension/) | |
|
||||
| [guessFieldTypes](./guessfieldtypes/) | |
|
||||
| [hasMsResolution](./hasmsresolution/) | Checks if series time field has ms resolution |
|
||||
| [isDataFrame](./isdataframe/) | |
|
||||
| [isDateTime](./isdatetime/) | |
|
||||
| [ISO\_8601](./iso_8601/) | |
|
||||
| [isTableData](./istabledata/) | |
|
||||
| [LogsParsers](./logsparsers/) | |
|
||||
| [MISSING\_VALUE](./missing_value/) | |
|
||||
| [MS\_DATE\_TIME\_FORMAT](./ms_date_time_format/) | |
|
||||
| [objRemoveUndefined](./objremoveundefined/) | |
|
||||
| [onUpdateDatasourceJsonDataOption](./onupdatedatasourcejsondataoption/) | |
|
||||
| [onUpdateDatasourceJsonDataOptionSelect](./onupdatedatasourcejsondataoptionselect/) | |
|
||||
| [onUpdateDatasourceOption](./onupdatedatasourceoption/) | |
|
||||
| [onUpdateDatasourceResetOption](./onupdatedatasourceresetoption/) | |
|
||||
| [onUpdateDatasourceSecureJsonDataOption](./onupdatedatasourcesecurejsondataoption/) | |
|
||||
| [onUpdateDatasourceSecureJsonDataOptionSelect](./onupdatedatasourcesecurejsondataoptionselect/) | |
|
||||
| [setLocale](./setlocale/) | |
|
||||
| [standardFieldConfigEditorRegistry](./standardfieldconfigeditorregistry/) | |
|
||||
| [TIME\_FORMAT](./time_format/) | |
|
||||
| [toDataFrame](./todataframe/) | |
|
||||
| [toDuration](./toduration/) | |
|
||||
| [toLegacyResponseData](./tolegacyresponsedata/) | |
|
||||
| [toUtc](./toutc/) | |
|
||||
| [transformersRegistry](./transformersregistry/) | |
|
||||
| [unEscapeStringFromRegex](./unescapestringfromregex/) | |
|
||||
| [updateDatasourcePluginJsonDataOption](./updatedatasourcepluginjsondataoption/) | |
|
||||
| [updateDatasourcePluginSecureJsonDataOption](./updatedatasourcepluginsecurejsondataoption/) | |
|
||||
| [VAR\_CALC](./var_calc/) | |
|
||||
| [VAR\_CELL\_PREFIX](./var_cell_prefix/) | |
|
||||
| [VAR\_FIELD\_NAME](./var_field_name/) | |
|
||||
| [VAR\_SERIES\_NAME](./var_series_name/) | |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [Color](./color/) | |
|
||||
| [ColorDefinition](./colordefinition/) | |
|
||||
| [DataQueryResponseData](./dataqueryresponsedata/) | |
|
||||
| [DataSourceOptionsType](./datasourceoptionstype/) | |
|
||||
| [DataSourceQueryType](./datasourcequerytype/) | |
|
||||
| [DataTransformer](./datatransformer/) | Immutable data transformation |
|
||||
| [DateTimeInput](./datetimeinput/) | |
|
||||
| [DecimalCount](./decimalcount/) | |
|
||||
| [Dimensions](./dimensions/) | |
|
||||
| [DisplayProcessor](./displayprocessor/) | |
|
||||
| [DurationInput](./durationinput/) | |
|
||||
| [DurationUnit](./durationunit/) | |
|
||||
| [FieldConfigEditorRegistry](./fieldconfigeditorregistry/) | |
|
||||
| [FieldMatcher](./fieldmatcher/) | |
|
||||
| [FormatInput](./formatinput/) | |
|
||||
| [FrameMatcher](./framematcher/) | |
|
||||
| [GraphSeriesValue](./graphseriesvalue/) | |
|
||||
| [InterpolateFunction](./interpolatefunction/) | |
|
||||
| [KeyValue](./keyvalue/) | |
|
||||
| [LegacyResponseData](./legacyresponsedata/) | Starting in v6.2 DataFrame can represent both TimeSeries and TableData |
|
||||
| [LinkTarget](./linktarget/) | |
|
||||
| [MutableField](./mutablefield/) | |
|
||||
| [NavIndex](./navindex/) | |
|
||||
| [Omit](./omit/) | |
|
||||
| [PanelMigrationHandler](./panelmigrationhandler/) | Called when a panel is first loaded with current panel model |
|
||||
| [PanelTypeChangedHandler](./paneltypechangedhandler/) | Called before a panel is initialized |
|
||||
| [ScaleCalculator](./scalecalculator/) | |
|
||||
| [Subtract](./subtract/) | |
|
||||
| [TimeFragment](./timefragment/) | |
|
||||
| [TimeSeriesPoints](./timeseriespoints/) | |
|
||||
| [TimeSeriesValue](./timeseriesvalue/) | |
|
||||
| [TimeZone](./timezone/) | |
|
||||
| [TimeZoneBrowser](./timezonebrowser/) | |
|
||||
| [TimeZoneUtc](./timezoneutc/) | |
|
||||
| [ValueFormatter](./valueformatter/) | |
|
||||
| [ValueMapping](./valuemapping/) | |
|
||||
|
||||
44
docs/sources/packages_api/data/absolutetimerange.md
Normal file
44
docs/sources/packages_api/data/absolutetimerange.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AbsoluteTimeRange"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AbsoluteTimeRange interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AbsoluteTimeRange
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AbsoluteTimeRange } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [from](#from-property) | <code>number</code> | |
|
||||
| [to](#to-property) | <code>number</code> | |
|
||||
|
||||
### from property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
from: number;
|
||||
```
|
||||
|
||||
### to property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
to: number;
|
||||
```
|
||||
35
docs/sources/packages_api/data/addlogleveltoseries.md
Normal file
35
docs/sources/packages_api/data/addlogleveltoseries.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "addLogLevelToSeries"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## addLogLevelToSeries() function
|
||||
|
||||
### addLogLevelToSeries() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function addLogLevelToSeries(series: DataFrame, lineIndex: number): DataFrame;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { addLogLevelToSeries } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| series | <code>DataFrame</code> | |
|
||||
| lineIndex | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataFrame`
|
||||
|
||||
89
docs/sources/packages_api/data/angularpanelmenuitem.md
Normal file
89
docs/sources/packages_api/data/angularpanelmenuitem.md
Normal file
@ -0,0 +1,89 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AngularPanelMenuItem"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AngularPanelMenuItem interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AngularPanelMenuItem
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AngularPanelMenuItem } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [click](#click-property) | <code>Function</code> | |
|
||||
| [divider](#divider-property) | <code>boolean</code> | |
|
||||
| [href](#href-property) | <code>string</code> | |
|
||||
| [icon](#icon-property) | <code>string</code> | |
|
||||
| [shortcut](#shortcut-property) | <code>string</code> | |
|
||||
| [submenu](#submenu-property) | <code>any[]</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
|
||||
### click property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
click: Function;
|
||||
```
|
||||
|
||||
### divider property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
divider: boolean;
|
||||
```
|
||||
|
||||
### href property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
href: string;
|
||||
```
|
||||
|
||||
### icon property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
icon: string;
|
||||
```
|
||||
|
||||
### shortcut property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
shortcut: string;
|
||||
```
|
||||
|
||||
### submenu property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
submenu: any[];
|
||||
```
|
||||
|
||||
### text property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
text: string;
|
||||
```
|
||||
170
docs/sources/packages_api/data/annotationevent.md
Normal file
170
docs/sources/packages_api/data/annotationevent.md
Normal file
@ -0,0 +1,170 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AnnotationEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AnnotationEvent interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AnnotationEvent
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AnnotationEvent } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [annotation](#annotation-property) | <code>any</code> | |
|
||||
| [avatarUrl](#avatarurl-property) | <code>string</code> | |
|
||||
| [dashboardId](#dashboardid-property) | <code>number</code> | |
|
||||
| [email](#email-property) | <code>string</code> | |
|
||||
| [id](#id-property) | <code>string</code> | |
|
||||
| [isRegion](#isregion-property) | <code>boolean</code> | |
|
||||
| [login](#login-property) | <code>string</code> | |
|
||||
| [panelId](#panelid-property) | <code>number</code> | |
|
||||
| [source](#source-property) | <code>any</code> | |
|
||||
| [tags](#tags-property) | <code>string[]</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
| [time](#time-property) | <code>number</code> | |
|
||||
| [timeEnd](#timeend-property) | <code>number</code> | |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
| [type](#type-property) | <code>string</code> | |
|
||||
| [userId](#userid-property) | <code>number</code> | |
|
||||
|
||||
### annotation property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
annotation?: any;
|
||||
```
|
||||
|
||||
### avatarUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
avatarUrl?: string;
|
||||
```
|
||||
|
||||
### dashboardId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dashboardId?: number;
|
||||
```
|
||||
|
||||
### email property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
email?: string;
|
||||
```
|
||||
|
||||
### id property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
id?: string;
|
||||
```
|
||||
|
||||
### isRegion property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
isRegion?: boolean;
|
||||
```
|
||||
|
||||
### login property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
login?: string;
|
||||
```
|
||||
|
||||
### panelId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
panelId?: number;
|
||||
```
|
||||
|
||||
### source property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
source?: any;
|
||||
```
|
||||
|
||||
### tags property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
tags?: string[];
|
||||
```
|
||||
|
||||
### text property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
text?: string;
|
||||
```
|
||||
|
||||
### time property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
time?: number;
|
||||
```
|
||||
|
||||
### timeEnd property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeEnd?: number;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
type?: string;
|
||||
```
|
||||
|
||||
### userId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
userId?: number;
|
||||
```
|
||||
68
docs/sources/packages_api/data/annotationqueryrequest.md
Normal file
68
docs/sources/packages_api/data/annotationqueryrequest.md
Normal file
@ -0,0 +1,68 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AnnotationQueryRequest"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AnnotationQueryRequest interface
|
||||
|
||||
Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AnnotationQueryRequest<MoreOptions = {}>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AnnotationQueryRequest } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [annotation](#annotation-property) | <code>{</code><br/><code> datasource: string;</code><br/><code> enable: boolean;</code><br/><code> name: string;</code><br/><code> } & MoreOptions</code> | |
|
||||
| [dashboard](#dashboard-property) | <code>any</code> | |
|
||||
| [range](#range-property) | <code>TimeRange</code> | |
|
||||
| [rangeRaw](#rangeraw-property) | <code>RawTimeRange</code> | |
|
||||
|
||||
### annotation property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
annotation: {
|
||||
datasource: string;
|
||||
enable: boolean;
|
||||
name: string;
|
||||
} & MoreOptions;
|
||||
```
|
||||
|
||||
### dashboard property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dashboard: any;
|
||||
```
|
||||
|
||||
### range property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
range: TimeRange;
|
||||
```
|
||||
|
||||
### rangeRaw property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
rangeRaw: RawTimeRange;
|
||||
```
|
||||
153
docs/sources/packages_api/data/appendedvectors.md
Normal file
153
docs/sources/packages_api/data/appendedvectors.md
Normal file
@ -0,0 +1,153 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AppendedVectors"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppendedVectors class
|
||||
|
||||
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
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class AppendedVectors<T = any> implements Vector<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppendedVectors } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(startAt)](#constructor-startat) | | Constructs a new instance of the <code>AppendedVectors</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [length](#length-property) | | <code>number</code> | |
|
||||
| [source](#source-property) | | <code>Array<AppendedVectorInfo<T>></code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [append(v)](#append-method) | | |
|
||||
| [get(index)](#get-method) | | |
|
||||
| [setLength(length)](#setlength-method) | | Make the vector look like it is this long |
|
||||
| [toArray()](#toarray-method) | | |
|
||||
| [toJSON()](#tojson-method) | | |
|
||||
|
||||
### constructor(startAt)
|
||||
|
||||
Constructs a new instance of the `AppendedVectors` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(startAt?: number);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| startAt | <code>number</code> | |
|
||||
|
||||
### length property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
length: number;
|
||||
```
|
||||
|
||||
### source property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
source: Array<AppendedVectorInfo<T>>;
|
||||
```
|
||||
|
||||
### append method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
append(v: Vector<T>): AppendedVectorInfo<T>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| v | <code>Vector<T></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`AppendedVectorInfo<T>`
|
||||
|
||||
### get method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(index: number): T;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| index | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`T`
|
||||
|
||||
### setLength method
|
||||
|
||||
Make the vector look like it is this long
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setLength(length: number): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| length | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### toArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toArray(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
### toJSON method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toJSON(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
44
docs/sources/packages_api/data/appevent.md
Normal file
44
docs/sources/packages_api/data/appevent.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AppEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppEvent interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AppEvent<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppEvent } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [payload](#payload-property) | <code>T</code> | |
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readonly name: string;
|
||||
```
|
||||
|
||||
### payload property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
payload?: T;
|
||||
```
|
||||
39
docs/sources/packages_api/data/appevents.md
Normal file
39
docs/sources/packages_api/data/appevents.md
Normal file
@ -0,0 +1,39 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AppEvents"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppEvents namespace
|
||||
|
||||
### AppEvents namespace
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare namespace AppEvents
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppEvents } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [alertError](./alerterror/) | |
|
||||
| [alertSuccess](./alertsuccess/) | |
|
||||
| [alertWarning](./alertwarning/) | |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [AlertPayload](./alertpayload/) | |
|
||||
|
||||
25
docs/sources/packages_api/data/appevents/alerterror.md
Normal file
25
docs/sources/packages_api/data/appevents/alerterror.md
Normal file
@ -0,0 +1,25 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "alertError"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppEvents.alertError variable
|
||||
|
||||
### AppEvents.alertError variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertError: AppEvent<AlertPayload>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppEvents } from '@grafana/data';
|
||||
const { alertError } = AppEvents;
|
||||
```
|
||||
25
docs/sources/packages_api/data/appevents/alertpayload.md
Normal file
25
docs/sources/packages_api/data/appevents/alertpayload.md
Normal file
@ -0,0 +1,25 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AlertPayload"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppEvents.AlertPayload type
|
||||
|
||||
### AppEvents.AlertPayload type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
type AlertPayload = [string, string?];
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppEvents } from '@grafana/data';
|
||||
const { AlertPayload } = AppEvents;
|
||||
```
|
||||
25
docs/sources/packages_api/data/appevents/alertsuccess.md
Normal file
25
docs/sources/packages_api/data/appevents/alertsuccess.md
Normal file
@ -0,0 +1,25 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "alertSuccess"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppEvents.alertSuccess variable
|
||||
|
||||
### AppEvents.alertSuccess variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertSuccess: AppEvent<AlertPayload>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppEvents } from '@grafana/data';
|
||||
const { alertSuccess } = AppEvents;
|
||||
```
|
||||
25
docs/sources/packages_api/data/appevents/alertwarning.md
Normal file
25
docs/sources/packages_api/data/appevents/alertwarning.md
Normal file
@ -0,0 +1,25 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "alertWarning"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppEvents.alertWarning variable
|
||||
|
||||
### AppEvents.alertWarning variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertWarning: AppEvent<AlertPayload>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppEvents } from '@grafana/data';
|
||||
const { alertWarning } = AppEvents;
|
||||
```
|
||||
36
docs/sources/packages_api/data/applyfieldoverrides.md
Normal file
36
docs/sources/packages_api/data/applyfieldoverrides.md
Normal file
@ -0,0 +1,36 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "applyFieldOverrides"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## applyFieldOverrides() function
|
||||
|
||||
### applyFieldOverrides() function
|
||||
|
||||
Return a copy of the DataFrame with all rules applied
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function applyFieldOverrides(options: ApplyFieldOverrideOptions): DataFrame[];
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { applyFieldOverrides } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>ApplyFieldOverrideOptions</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataFrame[]`
|
||||
|
||||
120
docs/sources/packages_api/data/appplugin.md
Normal file
120
docs/sources/packages_api/data/appplugin.md
Normal file
@ -0,0 +1,120 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AppPlugin"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppPlugin class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppPlugin } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [angularPages](#angularpages-property) | | <code>{</code><br/><code> [component: string]: any;</code><br/><code> }</code> | |
|
||||
| [root](#root-property) | | <code>ComponentClass<AppRootProps<T>></code> | |
|
||||
| [rootNav](#rootnav-property) | | <code>NavModel</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [init(meta)](#init-method) | | Called after the module has loaded, and before the app is used. This function may be called multiple times on the same instance. The first time, <code>this.meta</code> will be undefined |
|
||||
| [setComponentsFromLegacyExports(pluginExports)](#setcomponentsfromlegacyexports-method) | | |
|
||||
| [setRootPage(root, rootNav)](#setrootpage-method) | | Set the component displayed under: /a/$<!-- -->{<!-- -->plugin-id<!-- -->}<!-- -->/\* |
|
||||
|
||||
### angularPages property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
angularPages?: {
|
||||
[component: string]: any;
|
||||
};
|
||||
```
|
||||
|
||||
### root property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
root?: ComponentClass<AppRootProps<T>>;
|
||||
```
|
||||
|
||||
### rootNav property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
rootNav?: NavModel;
|
||||
```
|
||||
|
||||
### init method
|
||||
|
||||
Called after the module has loaded, and before the app is used. This function may be called multiple times on the same instance. The first time, `this.meta` will be undefined
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
init(meta: AppPluginMeta): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| meta | <code>AppPluginMeta</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### setComponentsFromLegacyExports method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setComponentsFromLegacyExports(pluginExports: any): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| pluginExports | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### setRootPage method
|
||||
|
||||
Set the component displayed under: /a/$<!-- -->{<!-- -->plugin-id<!-- -->}<!-- -->/\*
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setRootPage(root: ComponentClass<AppRootProps<T>>, rootNav?: NavModel): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| root | <code>ComponentClass<AppRootProps<T>></code> | |
|
||||
| rootNav | <code>NavModel</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
22
docs/sources/packages_api/data/apppluginmeta.md
Normal file
22
docs/sources/packages_api/data/apppluginmeta.md
Normal file
@ -0,0 +1,22 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AppPluginMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppPluginMeta interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AppPluginMeta<T = KeyValue> extends PluginMeta<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppPluginMeta } from '@grafana/data';
|
||||
```
|
||||
64
docs/sources/packages_api/data/approotprops.md
Normal file
64
docs/sources/packages_api/data/approotprops.md
Normal file
@ -0,0 +1,64 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AppRootProps"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AppRootProps interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AppRootProps<T = KeyValue>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AppRootProps } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [meta](#meta-property) | <code>AppPluginMeta<T></code> | |
|
||||
| [onNavChanged](#onnavchanged-property) | <code>(nav: NavModel) => void</code> | Pass the nav model to the container... is there a better way? |
|
||||
| [path](#path-property) | <code>string</code> | |
|
||||
| [query](#query-property) | <code>KeyValue</code> | |
|
||||
|
||||
### meta property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
meta: AppPluginMeta<T>;
|
||||
```
|
||||
|
||||
### onNavChanged property
|
||||
|
||||
Pass the nav model to the container... is there a better way?
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onNavChanged: (nav: NavModel) => void;
|
||||
```
|
||||
|
||||
### path property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
path: string;
|
||||
```
|
||||
|
||||
### query property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
query: KeyValue;
|
||||
```
|
||||
162
docs/sources/packages_api/data/arrayvector.md
Normal file
162
docs/sources/packages_api/data/arrayvector.md
Normal file
@ -0,0 +1,162 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ArrayVector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ArrayVector class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class ArrayVector<T = any> implements MutableVector<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ArrayVector } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(buffer)](#constructor-buffer) | | Constructs a new instance of the <code>ArrayVector</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [buffer](#buffer-property) | | <code>T[]</code> | |
|
||||
| [length](#length-property) | | <code>number</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [add(value)](#add-method) | | |
|
||||
| [get(index)](#get-method) | | |
|
||||
| [reverse()](#reverse-method) | | |
|
||||
| [set(index, value)](#set-method) | | |
|
||||
| [toArray()](#toarray-method) | | |
|
||||
| [toJSON()](#tojson-method) | | |
|
||||
|
||||
### constructor(buffer)
|
||||
|
||||
Constructs a new instance of the `ArrayVector` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(buffer?: T[]);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| buffer | <code>T[]</code> | |
|
||||
|
||||
### buffer property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
buffer: T[];
|
||||
```
|
||||
|
||||
### length property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get length(): number;
|
||||
```
|
||||
|
||||
### add method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
add(value: T): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| value | <code>T</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### get method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(index: number): T;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| index | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`T`
|
||||
|
||||
### reverse method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reverse(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### set method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
set(index: number, value: T): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| index | <code>number</code> | |
|
||||
| value | <code>T</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### toArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toArray(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
### toJSON method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toJSON(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
35
docs/sources/packages_api/data/arrowdataframe.md
Normal file
35
docs/sources/packages_api/data/arrowdataframe.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ArrowDataFrame"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ArrowDataFrame interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface ArrowDataFrame extends DataFrame
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ArrowDataFrame } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [table](#table-property) | <code>Table</code> | |
|
||||
|
||||
### table property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
table: Table;
|
||||
```
|
||||
34
docs/sources/packages_api/data/arrowtabletodataframe.md
Normal file
34
docs/sources/packages_api/data/arrowtabletodataframe.md
Normal file
@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "arrowTableToDataFrame"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## arrowTableToDataFrame() function
|
||||
|
||||
### arrowTableToDataFrame() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function arrowTableToDataFrame(table: Table): ArrowDataFrame;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { arrowTableToDataFrame } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| table | <code>Table</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`ArrowDataFrame`
|
||||
|
||||
34
docs/sources/packages_api/data/base64stringtoarrowtable.md
Normal file
34
docs/sources/packages_api/data/base64stringtoarrowtable.md
Normal file
@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "base64StringToArrowTable"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## base64StringToArrowTable() function
|
||||
|
||||
### base64StringToArrowTable() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function base64StringToArrowTable(text: string): Table;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { base64StringToArrowTable } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| text | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Table`
|
||||
|
||||
35
docs/sources/packages_api/data/calculatefieldstats.md
Normal file
35
docs/sources/packages_api/data/calculatefieldstats.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "calculateFieldStats"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## calculateFieldStats() function
|
||||
|
||||
### calculateFieldStats() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function calculateFieldStats(rows: LogRowModel[], extractor: RegExp): LogLabelStatsModel[];
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { calculateFieldStats } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rows | <code>LogRowModel[]</code> | |
|
||||
| extractor | <code>RegExp</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`LogLabelStatsModel[]`
|
||||
|
||||
35
docs/sources/packages_api/data/calculatelogslabelstats.md
Normal file
35
docs/sources/packages_api/data/calculatelogslabelstats.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "calculateLogsLabelStats"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## calculateLogsLabelStats() function
|
||||
|
||||
### calculateLogsLabelStats() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function calculateLogsLabelStats(rows: LogRowModel[], label: string): LogLabelStatsModel[];
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { calculateLogsLabelStats } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rows | <code>LogRowModel[]</code> | |
|
||||
| label | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`LogLabelStatsModel[]`
|
||||
|
||||
34
docs/sources/packages_api/data/calculatestats.md
Normal file
34
docs/sources/packages_api/data/calculatestats.md
Normal file
@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "calculateStats"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## calculateStats() function
|
||||
|
||||
### calculateStats() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function calculateStats(values: any[]): LogLabelStatsModel[];
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { calculateStats } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| values | <code>any[]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`LogLabelStatsModel[]`
|
||||
|
||||
45
docs/sources/packages_api/data/circulardataframe.md
Normal file
45
docs/sources/packages_api/data/circulardataframe.md
Normal file
@ -0,0 +1,45 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CircularDataFrame"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CircularDataFrame class
|
||||
|
||||
This dataframe can have values constantly added, and will never exceed the given capacity
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class CircularDataFrame<T = any> extends MutableDataFrame<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CircularDataFrame } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>CircularDataFrame</code> class |
|
||||
|
||||
### constructor(options)
|
||||
|
||||
Constructs a new instance of the `CircularDataFrame` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(options: CircularOptions);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>CircularOptions</code> | |
|
||||
|
||||
186
docs/sources/packages_api/data/circularvector.md
Normal file
186
docs/sources/packages_api/data/circularvector.md
Normal file
@ -0,0 +1,186 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CircularVector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CircularVector class
|
||||
|
||||
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.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class CircularVector<T = any> implements MutableVector<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CircularVector } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>CircularVector</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [add](#add-property) | | <code>(value: T) => void</code> | Add the value to the buffer |
|
||||
| [length](#length-property) | | <code>number</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [get(index)](#get-method) | | |
|
||||
| [reverse()](#reverse-method) | | |
|
||||
| [set(index, value)](#set-method) | | |
|
||||
| [setAppendMode(mode)](#setappendmode-method) | | |
|
||||
| [setCapacity(v)](#setcapacity-method) | | |
|
||||
| [toArray()](#toarray-method) | | |
|
||||
| [toJSON()](#tojson-method) | | |
|
||||
|
||||
### constructor(options)
|
||||
|
||||
Constructs a new instance of the `CircularVector` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(options: CircularOptions<T>);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>CircularOptions<T></code> | |
|
||||
|
||||
### add property
|
||||
|
||||
Add the value to the buffer
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
add: (value: T) => void;
|
||||
```
|
||||
|
||||
### length property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get length(): number;
|
||||
```
|
||||
|
||||
### get method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(index: number): T;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| index | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`T`
|
||||
|
||||
### reverse method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reverse(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### set method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
set(index: number, value: T): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| index | <code>number</code> | |
|
||||
| value | <code>T</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### setAppendMode method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setAppendMode(mode: 'head' | 'tail'): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| mode | <code>'head' | 'tail'</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### setCapacity method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setCapacity(v: number): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| v | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### toArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toArray(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
### toJSON method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toJSON(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
24
docs/sources/packages_api/data/color.md
Normal file
24
docs/sources/packages_api/data/color.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "Color"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## Color type
|
||||
|
||||
### Color type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type Color = 'green' | 'dark-green' | 'semi-dark-green' | 'light-green' | 'super-light-green' | 'yellow' | 'dark-yellow' | 'semi-dark-yellow' | 'light-yellow' | 'super-light-yellow' | 'red' | 'dark-red' | 'semi-dark-red' | 'light-red' | 'super-light-red' | 'blue' | 'dark-blue' | 'semi-dark-blue' | 'light-blue' | 'super-light-blue' | 'orange' | 'dark-orange' | 'semi-dark-orange' | 'light-orange' | 'super-light-orange' | 'purple' | 'dark-purple' | 'semi-dark-purple' | 'light-purple' | 'super-light-purple';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { Color } from '@grafana/data';
|
||||
```
|
||||
29
docs/sources/packages_api/data/colordefinition.md
Normal file
29
docs/sources/packages_api/data/colordefinition.md
Normal file
@ -0,0 +1,29 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ColorDefinition"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ColorDefinition type
|
||||
|
||||
### ColorDefinition type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type ColorDefinition = {
|
||||
hue: Hue;
|
||||
isPrimary?: boolean;
|
||||
name: Color;
|
||||
variants: ThemeVariants;
|
||||
};
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ColorDefinition } from '@grafana/data';
|
||||
```
|
||||
57
docs/sources/packages_api/data/colorscheme.md
Normal file
57
docs/sources/packages_api/data/colorscheme.md
Normal file
@ -0,0 +1,57 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ColorScheme"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ColorScheme enum
|
||||
|
||||
### ColorScheme enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum ColorScheme
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ColorScheme } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Blues | <code>"Blues"</code> | |
|
||||
| BrBG | <code>"BrBG"</code> | |
|
||||
| BuGn | <code>"BuGn"</code> | |
|
||||
| BuPu | <code>"BuPu"</code> | |
|
||||
| GnBu | <code>"GnBu"</code> | |
|
||||
| Greens | <code>"Greens"</code> | |
|
||||
| Greys | <code>"Greys"</code> | |
|
||||
| Oranges | <code>"Oranges"</code> | |
|
||||
| OrRd | <code>"OrRd"</code> | |
|
||||
| PiYG | <code>"PiYG"</code> | |
|
||||
| PRGn | <code>"PRGn"</code> | |
|
||||
| PuBu | <code>"PuBu"</code> | |
|
||||
| PuBuGn | <code>"PuBuGn"</code> | |
|
||||
| PuOr | <code>"PuOr"</code> | |
|
||||
| PuRd | <code>"PuRd"</code> | |
|
||||
| Purples | <code>"Purples"</code> | |
|
||||
| RdBu | <code>"RdBu"</code> | |
|
||||
| RdGy | <code>"RdGy"</code> | |
|
||||
| RdPu | <code>"RdPu"</code> | |
|
||||
| RdYlBu | <code>"RdYlBu"</code> | |
|
||||
| RdYlGn | <code>"RdYlGn"</code> | |
|
||||
| Reds | <code>"Reds"</code> | |
|
||||
| Spectral | <code>"Spectral"</code> | |
|
||||
| YlGn | <code>"YlGn"</code> | |
|
||||
| YlGnBu | <code>"YlGnBu"</code> | |
|
||||
| YlOrBr | <code>"YlOrBr"</code> | |
|
||||
| YlOrRd | <code>"YlOrRd"</code> | |
|
||||
|
||||
53
docs/sources/packages_api/data/column.md
Normal file
53
docs/sources/packages_api/data/column.md
Normal file
@ -0,0 +1,53 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "Column"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## Column interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface Column
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { Column } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [filterable](#filterable-property) | <code>boolean</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### filterable property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
filterable?: boolean;
|
||||
```
|
||||
|
||||
### text property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
text: string;
|
||||
```
|
||||
|
||||
### unit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
unit?: string;
|
||||
```
|
||||
44
docs/sources/packages_api/data/configoverriderule.md
Normal file
44
docs/sources/packages_api/data/configoverriderule.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ConfigOverrideRule"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ConfigOverrideRule interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface ConfigOverrideRule
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ConfigOverrideRule } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [matcher](#matcher-property) | <code>MatcherConfig</code> | |
|
||||
| [properties](#properties-property) | <code>DynamicConfigValue[]</code> | |
|
||||
|
||||
### matcher property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
matcher: MatcherConfig;
|
||||
```
|
||||
|
||||
### properties property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
properties: DynamicConfigValue[];
|
||||
```
|
||||
105
docs/sources/packages_api/data/constantvector.md
Normal file
105
docs/sources/packages_api/data/constantvector.md
Normal file
@ -0,0 +1,105 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ConstantVector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ConstantVector class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class ConstantVector<T = any> implements Vector<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ConstantVector } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(value, len)](#constructor-valuelen) | | Constructs a new instance of the <code>ConstantVector</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [length](#length-property) | | <code>number</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [get(index)](#get-method) | | |
|
||||
| [toArray()](#toarray-method) | | |
|
||||
| [toJSON()](#tojson-method) | | |
|
||||
|
||||
### constructor(value, len)
|
||||
|
||||
Constructs a new instance of the `ConstantVector` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(value: T, len: number);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| value | <code>T</code> | |
|
||||
| len | <code>number</code> | |
|
||||
|
||||
### length property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get length(): number;
|
||||
```
|
||||
|
||||
### get method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(index: number): T;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| index | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`T`
|
||||
|
||||
### toArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toArray(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
### toJSON method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toJSON(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
32
docs/sources/packages_api/data/coreapp.md
Normal file
32
docs/sources/packages_api/data/coreapp.md
Normal file
@ -0,0 +1,32 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CoreApp"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CoreApp enum
|
||||
|
||||
### CoreApp enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum CoreApp
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CoreApp } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Dashboard | <code>"dashboard"</code> | |
|
||||
| Explore | <code>"explore"</code> | |
|
||||
|
||||
24
docs/sources/packages_api/data/createdimension.md
Normal file
24
docs/sources/packages_api/data/createdimension.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "createDimension"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## createDimension variable
|
||||
|
||||
### createDimension variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
createDimension: (name: string, columns: Field<any, import("..").Vector<any>>[]) => Dimension<any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { createDimension } from '@grafana/data';
|
||||
```
|
||||
22
docs/sources/packages_api/data/createplotoverlay.md
Normal file
22
docs/sources/packages_api/data/createplotoverlay.md
Normal file
@ -0,0 +1,22 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CreatePlotOverlay"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CreatePlotOverlay interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface CreatePlotOverlay
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CreatePlotOverlay } from '@grafana/data';
|
||||
```
|
||||
71
docs/sources/packages_api/data/csvconfig.md
Normal file
71
docs/sources/packages_api/data/csvconfig.md
Normal file
@ -0,0 +1,71 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CSVConfig"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CSVConfig interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface CSVConfig
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CSVConfig } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [delimiter](#delimiter-property) | <code>string</code> | |
|
||||
| [encoding](#encoding-property) | <code>string</code> | |
|
||||
| [headerStyle](#headerstyle-property) | <code>CSVHeaderStyle</code> | |
|
||||
| [newline](#newline-property) | <code>string</code> | |
|
||||
| [quoteChar](#quotechar-property) | <code>string</code> | |
|
||||
|
||||
### delimiter property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
delimiter?: string;
|
||||
```
|
||||
|
||||
### encoding property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
encoding?: string;
|
||||
```
|
||||
|
||||
### headerStyle property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
headerStyle?: CSVHeaderStyle;
|
||||
```
|
||||
|
||||
### newline property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
newline?: string;
|
||||
```
|
||||
|
||||
### quoteChar property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
quoteChar?: string;
|
||||
```
|
||||
33
docs/sources/packages_api/data/csvheaderstyle.md
Normal file
33
docs/sources/packages_api/data/csvheaderstyle.md
Normal file
@ -0,0 +1,33 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CSVHeaderStyle"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CSVHeaderStyle enum
|
||||
|
||||
### CSVHeaderStyle enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum CSVHeaderStyle
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CSVHeaderStyle } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| full | <code>0</code> | |
|
||||
| name | <code>1</code> | |
|
||||
| none | <code>2</code> | |
|
||||
|
||||
44
docs/sources/packages_api/data/csvoptions.md
Normal file
44
docs/sources/packages_api/data/csvoptions.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CSVOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CSVOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface CSVOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CSVOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [callback](#callback-property) | <code>CSVParseCallbacks</code> | |
|
||||
| [config](#config-property) | <code>CSVConfig</code> | |
|
||||
|
||||
### callback property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
callback?: CSVParseCallbacks;
|
||||
```
|
||||
|
||||
### config property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
config?: CSVConfig;
|
||||
```
|
||||
46
docs/sources/packages_api/data/csvparsecallbacks.md
Normal file
46
docs/sources/packages_api/data/csvparsecallbacks.md
Normal file
@ -0,0 +1,46 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CSVParseCallbacks"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CSVParseCallbacks interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface CSVParseCallbacks
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CSVParseCallbacks } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [onHeader](#onheader-property) | <code>(fields: Field[]) => void</code> | Get a callback before any rows are processed This can return a modified table to force any Column configurations |
|
||||
| [onRow](#onrow-property) | <code>(row: any[]) => void</code> | |
|
||||
|
||||
### onHeader property
|
||||
|
||||
Get a callback before any rows are processed This can return a modified table to force any Column configurations
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onHeader: (fields: Field[]) => void;
|
||||
```
|
||||
|
||||
### onRow property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onRow: (row: any[]) => void;
|
||||
```
|
||||
116
docs/sources/packages_api/data/csvreader.md
Normal file
116
docs/sources/packages_api/data/csvreader.md
Normal file
@ -0,0 +1,116 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CSVReader"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## CSVReader class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class CSVReader
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CSVReader } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>CSVReader</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [callback](#callback-property) | | <code>CSVParseCallbacks</code> | |
|
||||
| [config](#config-property) | | <code>CSVConfig</code> | |
|
||||
| [current](#current-property) | | <code>MutableDataFrame</code> | |
|
||||
| [data](#data-property) | | <code>MutableDataFrame[]</code> | |
|
||||
| [state](#state-property) | | <code>ParseState</code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [readCSV(text)](#readcsv-method) | | |
|
||||
|
||||
### constructor(options)
|
||||
|
||||
Constructs a new instance of the `CSVReader` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(options?: CSVOptions);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>CSVOptions</code> | |
|
||||
|
||||
### callback property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
callback?: CSVParseCallbacks;
|
||||
```
|
||||
|
||||
### config property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
config: CSVConfig;
|
||||
```
|
||||
|
||||
### current property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
current: MutableDataFrame;
|
||||
```
|
||||
|
||||
### data property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
data: MutableDataFrame[];
|
||||
```
|
||||
|
||||
### state property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
state: ParseState;
|
||||
```
|
||||
|
||||
### readCSV method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readCSV(text: string): MutableDataFrame[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| text | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`MutableDataFrame[]`
|
||||
|
||||
53
docs/sources/packages_api/data/dataframe.md
Normal file
53
docs/sources/packages_api/data/dataframe.md
Normal file
@ -0,0 +1,53 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataFrame"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataFrame interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataFrame extends QueryResultBase
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataFrame } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [fields](#fields-property) | <code>Field[]</code> | |
|
||||
| [length](#length-property) | <code>number</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
|
||||
### fields property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
fields: Field[];
|
||||
```
|
||||
|
||||
### length property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
length: number;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name?: string;
|
||||
```
|
||||
46
docs/sources/packages_api/data/dataframedto.md
Normal file
46
docs/sources/packages_api/data/dataframedto.md
Normal file
@ -0,0 +1,46 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataFrameDTO"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataFrameDTO interface
|
||||
|
||||
Like a DataFrame, but fields may be a FieldDTO
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataFrameDTO extends QueryResultBase
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataFrameDTO } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [fields](#fields-property) | <code>Array<FieldDTO | Field></code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
|
||||
### fields property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
fields: Array<FieldDTO | Field>;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name?: string;
|
||||
```
|
||||
222
docs/sources/packages_api/data/dataframeview.md
Normal file
222
docs/sources/packages_api/data/dataframeview.md
Normal file
@ -0,0 +1,222 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataFrameView"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataFrameView class
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
This abstraction will present the contents of a DataFrame as if it were a well typed javascript object Vector.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class DataFrameView<T = any> implements Vector<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataFrameView } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
The [DataFrameView.get()](./data/dataframeview/get.md) is optimized for use in a loop and will return same object. See function for more details.
|
||||
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(data)](#constructor-data) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>DataFrameView</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [dataFrame](#dataframe-property) | | <code>DataFrame</code> | <b><i>(BETA)</i></b> |
|
||||
| [length](#length-property) | | <code>number</code> | <b><i>(BETA)</i></b> |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [forEachRow(iterator)](#foreachrow-method) | | <b><i>(BETA)</i></b> |
|
||||
| [get(idx)](#get-method) | | <b><i>(BETA)</i></b> The contents of the object returned from this function are optimized for use in a loop. All calls return the same object but the index has changed. |
|
||||
| [getFieldDisplayProcessor(colIndex)](#getfielddisplayprocessor-method) | | <b><i>(BETA)</i></b> Helper function to return the [DisplayProcessor](./data/displayprocessor.md) for a given field column. |
|
||||
| [map(iterator)](#map-method) | | <b><i>(BETA)</i></b> |
|
||||
| [toArray()](#toarray-method) | | <b><i>(BETA)</i></b> |
|
||||
| [toJSON()](#tojson-method) | | <b><i>(BETA)</i></b> |
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### constructor(data)
|
||||
|
||||
Constructs a new instance of the `DataFrameView` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(data: DataFrame);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| data | <code>DataFrame</code> | |
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### dataFrame property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get dataFrame(): DataFrame;
|
||||
```
|
||||
> 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.
|
||||
>
|
||||
|
||||
### length property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get length(): number;
|
||||
```
|
||||
> 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.
|
||||
>
|
||||
|
||||
### forEachRow method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
forEachRow(iterator: (row: T) => void): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| iterator | <code>(row: T) => void</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### get method
|
||||
|
||||
The contents of the object returned from this function are optimized for use in a loop. All calls return the same object but the index has changed.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(idx: number): T;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| idx | <code>number</code> | The index of the object you currently are inspecting |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`T`
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
```typescript
|
||||
// `first`, `second` and `third` will all point to the same contents at index 2:
|
||||
const first = view.get(0);
|
||||
const second = view.get(1);
|
||||
const third = view.get(2);
|
||||
|
||||
// If you need three different objects, consider something like:
|
||||
const first = { ...view.get(0) };
|
||||
const second = { ...view.get(1) };
|
||||
const third = { ...view.get(2) };
|
||||
|
||||
```
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### getFieldDisplayProcessor method
|
||||
|
||||
Helper function to return the [DisplayProcessor](./data/displayprocessor.md) for a given field column.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getFieldDisplayProcessor(colIndex: number): DisplayProcessor | null;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| colIndex | <code>number</code> | the field column index for the data frame. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DisplayProcessor | null`
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### map method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
map<V>(iterator: (item: T, index: number) => V): V[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| iterator | <code>(item: T, index: number) => V</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`V[]`
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### toArray method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toArray(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
> 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.
|
||||
>
|
||||
|
||||
### toJSON method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toJSON(): T[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`T[]`
|
||||
|
||||
73
docs/sources/packages_api/data/datalink.md
Normal file
73
docs/sources/packages_api/data/datalink.md
Normal file
@ -0,0 +1,73 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataLink"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataLink interface
|
||||
|
||||
Link configuration. The values may contain variables that need to be processed before running
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataLink
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataLink } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [onBuildUrl](#onbuildurl-property) | <code>(event: DataLinkClickEvent) => string</code> | |
|
||||
| [onClick](#onclick-property) | <code>(event: DataLinkClickEvent) => void</code> | |
|
||||
| [targetBlank](#targetblank-property) | <code>boolean</code> | |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
| [url](#url-property) | <code>string</code> | |
|
||||
|
||||
### onBuildUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onBuildUrl?: (event: DataLinkClickEvent) => string;
|
||||
```
|
||||
|
||||
### onClick property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onClick?: (event: DataLinkClickEvent) => void;
|
||||
```
|
||||
|
||||
### targetBlank property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
targetBlank?: boolean;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title: string;
|
||||
```
|
||||
|
||||
### url property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
url: string;
|
||||
```
|
||||
55
docs/sources/packages_api/data/datalinkclickevent.md
Normal file
55
docs/sources/packages_api/data/datalinkclickevent.md
Normal file
@ -0,0 +1,55 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataLinkClickEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataLinkClickEvent interface
|
||||
|
||||
Callback info for DataLink click events
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataLinkClickEvent<T = any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataLinkClickEvent } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [e](#e-property) | <code>any</code> | |
|
||||
| [origin](#origin-property) | <code>T</code> | |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | |
|
||||
|
||||
### e property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
e?: any;
|
||||
```
|
||||
|
||||
### origin property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
origin: T;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars: ScopedVars;
|
||||
```
|
||||
90
docs/sources/packages_api/data/dataquery.md
Normal file
90
docs/sources/packages_api/data/dataquery.md
Normal file
@ -0,0 +1,90 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataQuery"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataQuery interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataQuery
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataQuery } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [datasource](#datasource-property) | <code>string | null</code> | For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. |
|
||||
| [hide](#hide-property) | <code>boolean</code> | true if query is disabled (ie not executed / sent to TSDB) |
|
||||
| [key](#key-property) | <code>string</code> | Unique, guid like, string used in explore mode |
|
||||
| [maxLines](#maxlines-property) | <code>number</code> | For limiting result lines. |
|
||||
| [metric](#metric-property) | <code>any</code> | |
|
||||
| [refId](#refid-property) | <code>string</code> | A - Z |
|
||||
|
||||
### datasource property
|
||||
|
||||
For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
datasource?: string | null;
|
||||
```
|
||||
|
||||
### hide property
|
||||
|
||||
true if query is disabled (ie not executed / sent to TSDB)
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hide?: boolean;
|
||||
```
|
||||
|
||||
### key property
|
||||
|
||||
Unique, guid like, string used in explore mode
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
key?: string;
|
||||
```
|
||||
|
||||
### maxLines property
|
||||
|
||||
For limiting result lines.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
maxLines?: number;
|
||||
```
|
||||
|
||||
### metric property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
metric?: any;
|
||||
```
|
||||
|
||||
### refId property
|
||||
|
||||
A - Z
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
refId: string;
|
||||
```
|
||||
83
docs/sources/packages_api/data/dataqueryerror.md
Normal file
83
docs/sources/packages_api/data/dataqueryerror.md
Normal file
@ -0,0 +1,83 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataQueryError"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataQueryError interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataQueryError
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataQueryError } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [cancelled](#cancelled-property) | <code>boolean</code> | |
|
||||
| [data](#data-property) | <code>{</code><br/><code> message?: string;</code><br/><code> error?: string;</code><br/><code> }</code> | |
|
||||
| [message](#message-property) | <code>string</code> | |
|
||||
| [refId](#refid-property) | <code>string</code> | |
|
||||
| [status](#status-property) | <code>string</code> | |
|
||||
| [statusText](#statustext-property) | <code>string</code> | |
|
||||
|
||||
### cancelled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
cancelled?: boolean;
|
||||
```
|
||||
|
||||
### data property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
data?: {
|
||||
message?: string;
|
||||
error?: string;
|
||||
};
|
||||
```
|
||||
|
||||
### message property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
message?: string;
|
||||
```
|
||||
|
||||
### refId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
refId?: string;
|
||||
```
|
||||
|
||||
### status property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
status?: string;
|
||||
```
|
||||
|
||||
### statusText property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
statusText?: string;
|
||||
```
|
||||
188
docs/sources/packages_api/data/dataqueryrequest.md
Normal file
188
docs/sources/packages_api/data/dataqueryrequest.md
Normal file
@ -0,0 +1,188 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataQueryRequest"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataQueryRequest interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataQueryRequest<TQuery extends DataQuery = DataQuery>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataQueryRequest } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [app](#app-property) | <code>CoreApp | string</code> | |
|
||||
| [cacheTimeout](#cachetimeout-property) | <code>string</code> | |
|
||||
| [dashboardId](#dashboardid-property) | <code>number</code> | |
|
||||
| [endTime](#endtime-property) | <code>number</code> | |
|
||||
| [exploreMode](#exploremode-property) | <code>ExploreMode</code> | |
|
||||
| [interval](#interval-property) | <code>string</code> | |
|
||||
| [intervalMs](#intervalms-property) | <code>number</code> | |
|
||||
| [maxDataPoints](#maxdatapoints-property) | <code>number</code> | |
|
||||
| [panelId](#panelid-property) | <code>number</code> | |
|
||||
| [range](#range-property) | <code>TimeRange</code> | |
|
||||
| [rangeRaw](#rangeraw-property) | <code>RawTimeRange</code> | |
|
||||
| [requestId](#requestid-property) | <code>string</code> | |
|
||||
| [reverse](#reverse-property) | <code>boolean</code> | |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | |
|
||||
| [startTime](#starttime-property) | <code>number</code> | |
|
||||
| [targets](#targets-property) | <code>TQuery[]</code> | |
|
||||
| [timeInfo](#timeinfo-property) | <code>string</code> | |
|
||||
| [timezone](#timezone-property) | <code>string</code> | |
|
||||
|
||||
### app property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
app: CoreApp | string;
|
||||
```
|
||||
|
||||
### cacheTimeout property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
cacheTimeout?: string;
|
||||
```
|
||||
|
||||
### dashboardId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dashboardId: number;
|
||||
```
|
||||
|
||||
### endTime property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
endTime?: number;
|
||||
```
|
||||
|
||||
### exploreMode property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exploreMode?: ExploreMode;
|
||||
```
|
||||
|
||||
### interval property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
interval: string;
|
||||
```
|
||||
|
||||
### intervalMs property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
intervalMs?: number;
|
||||
```
|
||||
|
||||
### maxDataPoints property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
maxDataPoints?: number;
|
||||
```
|
||||
|
||||
### panelId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
panelId: number;
|
||||
```
|
||||
|
||||
### range property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
range?: TimeRange;
|
||||
```
|
||||
|
||||
### rangeRaw property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
rangeRaw?: RawTimeRange;
|
||||
```
|
||||
|
||||
### requestId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
requestId: string;
|
||||
```
|
||||
|
||||
### reverse property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reverse?: boolean;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars: ScopedVars;
|
||||
```
|
||||
|
||||
### startTime property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
startTime: number;
|
||||
```
|
||||
|
||||
### targets property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
targets: TQuery[];
|
||||
```
|
||||
|
||||
### timeInfo property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeInfo?: string;
|
||||
```
|
||||
|
||||
### timezone property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timezone: string;
|
||||
```
|
||||
70
docs/sources/packages_api/data/dataqueryresponse.md
Normal file
70
docs/sources/packages_api/data/dataqueryresponse.md
Normal file
@ -0,0 +1,70 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataQueryResponse"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataQueryResponse interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataQueryResponse
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataQueryResponse } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [data](#data-property) | <code>DataQueryResponseData[]</code> | The response data. When streaming, this may be empty or a partial result set |
|
||||
| [error](#error-property) | <code>DataQueryError</code> | Optionally include error info along with the response data |
|
||||
| [key](#key-property) | <code>string</code> | When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used) |
|
||||
| [state](#state-property) | <code>LoadingState</code> | Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined |
|
||||
|
||||
### data property
|
||||
|
||||
The response data. When streaming, this may be empty or a partial result set
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
data: DataQueryResponseData[];
|
||||
```
|
||||
|
||||
### error property
|
||||
|
||||
Optionally include error info along with the response data
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
error?: DataQueryError;
|
||||
```
|
||||
|
||||
### key property
|
||||
|
||||
When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used)
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
key?: string;
|
||||
```
|
||||
|
||||
### state property
|
||||
|
||||
Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
state?: LoadingState;
|
||||
```
|
||||
24
docs/sources/packages_api/data/dataqueryresponsedata.md
Normal file
24
docs/sources/packages_api/data/dataqueryresponsedata.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataQueryResponseData"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataQueryResponseData type
|
||||
|
||||
### DataQueryResponseData type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DataQueryResponseData = DataFrame | DataFrameDTO | LegacyResponseData;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataQueryResponseData } from '@grafana/data';
|
||||
```
|
||||
421
docs/sources/packages_api/data/datasourceapi.md
Normal file
421
docs/sources/packages_api/data/datasourceapi.md
Normal file
@ -0,0 +1,421 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceApi"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceApi class
|
||||
|
||||
The main data source abstraction interface, represents an instance of a data source
|
||||
|
||||
Although this is a class, datasource implementations do not \*yet\* need to extend it. As such, we can not yet add functions with default implementations.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare abstract class DataSourceApi<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceApi } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(instanceSettings)](#constructor-instancesettings) | | Constructs a new instance of the <code>DataSourceApi</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [components](#components-property) | | <code>DataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions></code> | Set after constructor call, as the data source instance is the most common thing to pass around we attach the components to this instance for easy access |
|
||||
| [getLogRowContext](#getlogrowcontext-property) | | <code><TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse></code> | Retrieve context for a given log row |
|
||||
| [id](#id-property) | | <code>number</code> | Set in constructor |
|
||||
| [init](#init-property) | | <code>() => void</code> | Initializes a datasource after instantiation |
|
||||
| [interval](#interval-property) | | <code>string</code> | min interval range |
|
||||
| [languageProvider](#languageprovider-property) | | <code>any</code> | Used in explore |
|
||||
| [meta](#meta-property) | | <code>DataSourcePluginMeta</code> | static information about the datasource |
|
||||
| [name](#name-property) | | <code>string</code> | Set in constructor |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [annotationQuery(options)](#annotationquery-method) | | Can be optionally implemented to allow datasource to be a source of annotations for dashboard. To be visible in the annotation editor <code>annotations</code> capability also needs to be enabled in plugin.json. |
|
||||
| [getHighlighterExpression(query)](#gethighlighterexpression-method) | | Used in explore |
|
||||
| [getQueryDisplayText(query)](#getquerydisplaytext-method) | | Convert a query to a simple text string |
|
||||
| [getQueryHints(query, results, rest)](#getqueryhints-method) | | Get hints for query improvements |
|
||||
| [getTagKeys(options)](#gettagkeys-method) | | Get tag keys for adhoc filters |
|
||||
| [getTagValues(options)](#gettagvalues-method) | | Get tag values for adhoc filters |
|
||||
| [getVersion(optionalOptions)](#getversion-method) | | |
|
||||
| [importQueries(queries, originMeta)](#importqueries-method) | | Imports queries from a different datasource |
|
||||
| [interpolateVariablesInQueries(queries, scopedVars)](#interpolatevariablesinqueries-method) | | |
|
||||
| [metricFindQuery(query, options)](#metricfindquery-method) | | Variable query action. |
|
||||
| [modifyQuery(query, action)](#modifyquery-method) | | Used in explore |
|
||||
| [query(request)](#query-method) | | Query for data, and optionally stream results |
|
||||
| [targetContainsTemplate(query)](#targetcontainstemplate-method) | | Used by alerting to check if query contains template variables |
|
||||
| [testDatasource()](#testdatasource-method) | | Test & verify datasource settings & connection details |
|
||||
|
||||
### constructor(instanceSettings)
|
||||
|
||||
Constructs a new instance of the `DataSourceApi` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
||||
|
||||
### components property
|
||||
|
||||
Set after constructor call, as the data source instance is the most common thing to pass around we attach the components to this instance for easy access
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
components?: DataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions>;
|
||||
```
|
||||
|
||||
### getLogRowContext property
|
||||
|
||||
Retrieve context for a given log row
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getLogRowContext?: <TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse>;
|
||||
```
|
||||
|
||||
### id property
|
||||
|
||||
Set in constructor
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readonly id: number;
|
||||
```
|
||||
|
||||
### init property
|
||||
|
||||
Initializes a datasource after instantiation
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
init?: () => void;
|
||||
```
|
||||
|
||||
### interval property
|
||||
|
||||
min interval range
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
interval?: string;
|
||||
```
|
||||
|
||||
### languageProvider property
|
||||
|
||||
Used in explore
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
languageProvider?: any;
|
||||
```
|
||||
|
||||
### meta property
|
||||
|
||||
static information about the datasource
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
meta?: DataSourcePluginMeta;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
Set in constructor
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readonly name: string;
|
||||
```
|
||||
|
||||
### annotationQuery method
|
||||
|
||||
Can be optionally implemented to allow datasource to be a source of annotations for dashboard. To be visible in the annotation editor `annotations` capability also needs to be enabled in plugin.json.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
annotationQuery?(options: AnnotationQueryRequest<TQuery>): Promise<AnnotationEvent[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>AnnotationQueryRequest<TQuery></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<AnnotationEvent[]>`
|
||||
|
||||
### getHighlighterExpression method
|
||||
|
||||
Used in explore
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getHighlighterExpression?(query: TQuery): string[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string[]`
|
||||
|
||||
### getQueryDisplayText method
|
||||
|
||||
Convert a query to a simple text string
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getQueryDisplayText?(query: TQuery): string;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
### getQueryHints method
|
||||
|
||||
Get hints for query improvements
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getQueryHints?(query: TQuery, results: any[], ...rest: any): QueryHint[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
| results | <code>any[]</code> | |
|
||||
| rest | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`QueryHint[]`
|
||||
|
||||
### getTagKeys method
|
||||
|
||||
Get tag keys for adhoc filters
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getTagKeys?(options?: any): Promise<MetricFindValue[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<MetricFindValue[]>`
|
||||
|
||||
### getTagValues method
|
||||
|
||||
Get tag values for adhoc filters
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getTagValues?(options: any): Promise<MetricFindValue[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<MetricFindValue[]>`
|
||||
|
||||
### getVersion method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getVersion?(optionalOptions?: any): Promise<string>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| optionalOptions | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<string>`
|
||||
|
||||
### importQueries method
|
||||
|
||||
Imports queries from a different datasource
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
importQueries?(queries: TQuery[], originMeta: PluginMeta): Promise<TQuery[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| queries | <code>TQuery[]</code> | |
|
||||
| originMeta | <code>PluginMeta</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<TQuery[]>`
|
||||
|
||||
### interpolateVariablesInQueries method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
interpolateVariablesInQueries?(queries: TQuery[], scopedVars: ScopedVars | {}): TQuery[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| queries | <code>TQuery[]</code> | |
|
||||
| scopedVars | <code>ScopedVars | {}</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`TQuery[]`
|
||||
|
||||
### metricFindQuery method
|
||||
|
||||
Variable query action.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
metricFindQuery?(query: any, options?: any): Promise<MetricFindValue[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>any</code> | |
|
||||
| options | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<MetricFindValue[]>`
|
||||
|
||||
### modifyQuery method
|
||||
|
||||
Used in explore
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
modifyQuery?(query: TQuery, action: QueryFixAction): TQuery;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
| action | <code>QueryFixAction</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`TQuery`
|
||||
|
||||
### query method
|
||||
|
||||
Query for data, and optionally stream results
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
abstract query(request: DataQueryRequest<TQuery>): Promise<DataQueryResponse> | Observable<DataQueryResponse>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| request | <code>DataQueryRequest<TQuery></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<DataQueryResponse> | Observable<DataQueryResponse>`
|
||||
|
||||
### targetContainsTemplate method
|
||||
|
||||
Used by alerting to check if query contains template variables
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
targetContainsTemplate?(query: TQuery): boolean;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
### testDatasource method
|
||||
|
||||
Test & verify datasource settings & connection details
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
abstract testDatasource(): Promise<any>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
46
docs/sources/packages_api/data/datasourceconstructor.md
Normal file
46
docs/sources/packages_api/data/datasourceconstructor.md
Normal file
@ -0,0 +1,46 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceConstructor"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceConstructor interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourceConstructor<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceConstructor } from '@grafana/data';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [new(instanceSettings, args)](#new-instancesettingsargs) | |
|
||||
|
||||
### new(instanceSettings, args)
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
new (instanceSettings: DataSourceInstanceSettings<TOptions>, ...args: any[]): DSType;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
||||
| args | <code>any[]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DSType`
|
||||
|
||||
129
docs/sources/packages_api/data/datasourceinstancesettings.md
Normal file
129
docs/sources/packages_api/data/datasourceinstancesettings.md
Normal file
@ -0,0 +1,129 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceInstanceSettings"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceInstanceSettings interface
|
||||
|
||||
Frontend settings model that is passed to Datasource constructor. This differs a bit from the model above as this data model is available to every user who has access to a data source (Viewers+). This is loaded in bootData (on page load), or from: /api/frontend/settings
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourceInstanceSettings<T extends DataSourceJsonData = DataSourceJsonData>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceInstanceSettings } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [basicAuth](#basicauth-property) | <code>string</code> | This is the full Authorization header if basic auth is ennabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposted to browser/Frontend so this will be empty then. |
|
||||
| [database](#database-property) | <code>string</code> | |
|
||||
| [id](#id-property) | <code>number</code> | |
|
||||
| [jsonData](#jsondata-property) | <code>T</code> | |
|
||||
| [meta](#meta-property) | <code>DataSourcePluginMeta</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [password](#password-property) | <code>string</code> | |
|
||||
| [type](#type-property) | <code>string</code> | |
|
||||
| [url](#url-property) | <code>string</code> | |
|
||||
| [username](#username-property) | <code>string</code> | |
|
||||
| [withCredentials](#withcredentials-property) | <code>boolean</code> | |
|
||||
|
||||
### basicAuth property
|
||||
|
||||
This is the full Authorization header if basic auth is ennabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposted to browser/Frontend so this will be empty then.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
basicAuth?: string;
|
||||
```
|
||||
|
||||
### database property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
database?: string;
|
||||
```
|
||||
|
||||
### id property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
id: number;
|
||||
```
|
||||
|
||||
### jsonData property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
jsonData: T;
|
||||
```
|
||||
|
||||
### meta property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
meta: DataSourcePluginMeta;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
|
||||
### password property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
password?: string;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
type: string;
|
||||
```
|
||||
|
||||
### url property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
url?: string;
|
||||
```
|
||||
|
||||
### username property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
username?: string;
|
||||
```
|
||||
|
||||
### withCredentials property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
withCredentials?: boolean;
|
||||
```
|
||||
44
docs/sources/packages_api/data/datasourcejsondata.md
Normal file
44
docs/sources/packages_api/data/datasourcejsondata.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceJsonData"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceJsonData interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourceJsonData
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceJsonData } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [authType](#authtype-property) | <code>string</code> | |
|
||||
| [defaultRegion](#defaultregion-property) | <code>string</code> | |
|
||||
|
||||
### authType property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
authType?: string;
|
||||
```
|
||||
|
||||
### defaultRegion property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
defaultRegion?: string;
|
||||
```
|
||||
24
docs/sources/packages_api/data/datasourceoptionstype.md
Normal file
24
docs/sources/packages_api/data/datasourceoptionstype.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceOptionsType"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceOptionsType type
|
||||
|
||||
### DataSourceOptionsType type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DataSourceOptionsType<DSType extends DataSourceApi<any, any>> = DSType extends DataSourceApi<infer _TQuery, infer TOptions> ? TOptions : never;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceOptionsType } from '@grafana/data';
|
||||
```
|
||||
287
docs/sources/packages_api/data/datasourceplugin.md
Normal file
287
docs/sources/packages_api/data/datasourceplugin.md
Normal file
@ -0,0 +1,287 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourcePlugin"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourcePlugin class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class DataSourcePlugin<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataSourceQueryType<DSType>, TOptions extends DataSourceJsonData = DataSourceOptionsType<DSType>, TSecureOptions = {}> extends GrafanaPlugin<DataSourcePluginMeta<TOptions>>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourcePlugin } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(DataSourceClass)](#constructor-datasourceclass) | | Constructs a new instance of the <code>DataSourcePlugin</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [components](#components-property) | | <code>DataSourcePluginComponents<DSType, TQuery, TOptions, TSecureOptions></code> | |
|
||||
| [DataSourceClass](#datasourceclass-property) | | <code>DataSourceConstructor<DSType, TQuery, TOptions></code> | |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [setAnnotationQueryCtrl(AnnotationsQueryCtrl)](#setannotationqueryctrl-method) | | |
|
||||
| [setComponentsFromLegacyExports(pluginExports)](#setcomponentsfromlegacyexports-method) | | |
|
||||
| [setConfigCtrl(ConfigCtrl)](#setconfigctrl-method) | | |
|
||||
| [setConfigEditor(editor)](#setconfigeditor-method) | | |
|
||||
| [setExploreLogsQueryField(ExploreQueryField)](#setexplorelogsqueryfield-method) | | |
|
||||
| [setExploreMetricsQueryField(ExploreQueryField)](#setexploremetricsqueryfield-method) | | |
|
||||
| [setExploreQueryField(ExploreQueryField)](#setexplorequeryfield-method) | | |
|
||||
| [setExploreStartPage(ExploreStartPage)](#setexplorestartpage-method) | | |
|
||||
| [setMetadataInspector(MetadataInspector)](#setmetadatainspector-method) | | |
|
||||
| [setQueryCtrl(QueryCtrl)](#setqueryctrl-method) | | |
|
||||
| [setQueryEditor(QueryEditor)](#setqueryeditor-method) | | |
|
||||
| [setVariableQueryEditor(VariableQueryEditor)](#setvariablequeryeditor-method) | | |
|
||||
|
||||
### constructor(DataSourceClass)
|
||||
|
||||
Constructs a new instance of the `DataSourcePlugin` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(DataSourceClass: DataSourceConstructor<DSType, TQuery, TOptions>);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| DataSourceClass | <code>DataSourceConstructor<DSType, TQuery, TOptions></code> | |
|
||||
|
||||
### components property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
components: DataSourcePluginComponents<DSType, TQuery, TOptions, TSecureOptions>;
|
||||
```
|
||||
|
||||
### DataSourceClass property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
DataSourceClass: DataSourceConstructor<DSType, TQuery, TOptions>;
|
||||
```
|
||||
|
||||
### setAnnotationQueryCtrl method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setAnnotationQueryCtrl(AnnotationsQueryCtrl: any): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| AnnotationsQueryCtrl | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setComponentsFromLegacyExports method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setComponentsFromLegacyExports(pluginExports: any): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| pluginExports | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### setConfigCtrl method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setConfigCtrl(ConfigCtrl: any): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ConfigCtrl | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setConfigEditor method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setConfigEditor(editor: ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| editor | <code>ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setExploreLogsQueryField method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setExploreLogsQueryField(ExploreQueryField: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ExploreQueryField | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setExploreMetricsQueryField method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setExploreMetricsQueryField(ExploreQueryField: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ExploreQueryField | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setExploreQueryField method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setExploreQueryField(ExploreQueryField: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ExploreQueryField | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setExploreStartPage method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setExploreStartPage(ExploreStartPage: ComponentType<ExploreStartPageProps>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ExploreStartPage | <code>ComponentType<ExploreStartPageProps></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setMetadataInspector method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setMetadataInspector(MetadataInspector: ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| MetadataInspector | <code>ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setQueryCtrl method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setQueryCtrl(QueryCtrl: any): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| QueryCtrl | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setQueryEditor method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setQueryEditor(QueryEditor: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| QueryEditor | <code>ComponentType<QueryEditorProps<DSType, TQuery, TOptions>></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
### setVariableQueryEditor method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setVariableQueryEditor(VariableQueryEditor: any): this;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| VariableQueryEditor | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
||||
116
docs/sources/packages_api/data/datasourceplugincomponents.md
Normal file
116
docs/sources/packages_api/data/datasourceplugincomponents.md
Normal file
@ -0,0 +1,116 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourcePluginComponents"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourcePluginComponents interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourcePluginComponents<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData, TSecureOptions = {}>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourcePluginComponents } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [AnnotationsQueryCtrl](#annotationsqueryctrl-property) | <code>any</code> | |
|
||||
| [ConfigEditor](#configeditor-property) | <code>ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>></code> | |
|
||||
| [ExploreLogsQueryField](#explorelogsqueryfield-property) | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
||||
| [ExploreMetricsQueryField](#exploremetricsqueryfield-property) | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
||||
| [ExploreQueryField](#explorequeryfield-property) | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
||||
| [ExploreStartPage](#explorestartpage-property) | <code>ComponentType<ExploreStartPageProps></code> | |
|
||||
| [MetadataInspector](#metadatainspector-property) | <code>ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>></code> | |
|
||||
| [QueryCtrl](#queryctrl-property) | <code>any</code> | |
|
||||
| [QueryEditor](#queryeditor-property) | <code>ComponentType<QueryEditorProps<DSType, TQuery, TOptions>></code> | |
|
||||
| [VariableQueryEditor](#variablequeryeditor-property) | <code>any</code> | |
|
||||
|
||||
### AnnotationsQueryCtrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
AnnotationsQueryCtrl?: any;
|
||||
```
|
||||
|
||||
### ConfigEditor property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ConfigEditor?: ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>>;
|
||||
```
|
||||
|
||||
### ExploreLogsQueryField property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ExploreLogsQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
|
||||
```
|
||||
|
||||
### ExploreMetricsQueryField property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ExploreMetricsQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
|
||||
```
|
||||
|
||||
### ExploreQueryField property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ExploreQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
|
||||
```
|
||||
|
||||
### ExploreStartPage property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ExploreStartPage?: ComponentType<ExploreStartPageProps>;
|
||||
```
|
||||
|
||||
### MetadataInspector property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
MetadataInspector?: ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>>;
|
||||
```
|
||||
|
||||
### QueryCtrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
QueryCtrl?: any;
|
||||
```
|
||||
|
||||
### QueryEditor property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
QueryEditor?: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>;
|
||||
```
|
||||
|
||||
### VariableQueryEditor property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
VariableQueryEditor?: any;
|
||||
```
|
||||
125
docs/sources/packages_api/data/datasourcepluginmeta.md
Normal file
125
docs/sources/packages_api/data/datasourcepluginmeta.md
Normal file
@ -0,0 +1,125 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourcePluginMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourcePluginMeta interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourcePluginMeta<T extends KeyValue = {}> extends PluginMeta<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourcePluginMeta } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [alerting](#alerting-property) | <code>boolean</code> | |
|
||||
| [annotations](#annotations-property) | <code>boolean</code> | |
|
||||
| [builtIn](#builtin-property) | <code>boolean</code> | |
|
||||
| [category](#category-property) | <code>string</code> | |
|
||||
| [hasQueryHelp](#hasqueryhelp-property) | <code>boolean</code> | |
|
||||
| [logs](#logs-property) | <code>boolean</code> | |
|
||||
| [metrics](#metrics-property) | <code>boolean</code> | |
|
||||
| [mixed](#mixed-property) | <code>boolean</code> | |
|
||||
| [queryOptions](#queryoptions-property) | <code>PluginMetaQueryOptions</code> | |
|
||||
| [sort](#sort-property) | <code>number</code> | |
|
||||
| [streaming](#streaming-property) | <code>boolean</code> | |
|
||||
|
||||
### alerting property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alerting?: boolean;
|
||||
```
|
||||
|
||||
### annotations property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
annotations?: boolean;
|
||||
```
|
||||
|
||||
### builtIn property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
builtIn?: boolean;
|
||||
```
|
||||
|
||||
### category property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
category?: string;
|
||||
```
|
||||
|
||||
### hasQueryHelp property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasQueryHelp?: boolean;
|
||||
```
|
||||
|
||||
### logs property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
logs?: boolean;
|
||||
```
|
||||
|
||||
### metrics property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
metrics?: boolean;
|
||||
```
|
||||
|
||||
### mixed property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
mixed?: boolean;
|
||||
```
|
||||
|
||||
### queryOptions property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
queryOptions?: PluginMetaQueryOptions;
|
||||
```
|
||||
|
||||
### sort property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
sort?: number;
|
||||
```
|
||||
|
||||
### streaming property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
streaming?: boolean;
|
||||
```
|
||||
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourcePluginOptionsEditorProps"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourcePluginOptionsEditorProps interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourcePluginOptionsEditorProps<JSONData = DataSourceJsonData, SecureJSONData = {}>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourcePluginOptionsEditorProps } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [onOptionsChange](#onoptionschange-property) | <code>(options: DataSourceSettings<JSONData, SecureJSONData>) => void</code> | |
|
||||
| [options](#options-property) | <code>DataSourceSettings<JSONData, SecureJSONData></code> | |
|
||||
|
||||
### onOptionsChange property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onOptionsChange: (options: DataSourceSettings<JSONData, SecureJSONData>) => void;
|
||||
```
|
||||
|
||||
### options property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
options: DataSourceSettings<JSONData, SecureJSONData>;
|
||||
```
|
||||
24
docs/sources/packages_api/data/datasourcequerytype.md
Normal file
24
docs/sources/packages_api/data/datasourcequerytype.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceQueryType"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceQueryType type
|
||||
|
||||
### DataSourceQueryType type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DataSourceQueryType<DSType extends DataSourceApi<any, any>> = DSType extends DataSourceApi<infer TQuery, infer _TOptions> ? TQuery : never;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceQueryType } from '@grafana/data';
|
||||
```
|
||||
62
docs/sources/packages_api/data/datasourceselectitem.md
Normal file
62
docs/sources/packages_api/data/datasourceselectitem.md
Normal file
@ -0,0 +1,62 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceSelectItem"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceSelectItem interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourceSelectItem
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceSelectItem } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [meta](#meta-property) | <code>DataSourcePluginMeta</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [sort](#sort-property) | <code>string</code> | |
|
||||
| [value](#value-property) | <code>string | null</code> | |
|
||||
|
||||
### meta property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
meta: DataSourcePluginMeta;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
|
||||
### sort property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
sort: string;
|
||||
```
|
||||
|
||||
### value property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
value: string | null;
|
||||
```
|
||||
208
docs/sources/packages_api/data/datasourcesettings.md
Normal file
208
docs/sources/packages_api/data/datasourcesettings.md
Normal file
@ -0,0 +1,208 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceSettings"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceSettings interface
|
||||
|
||||
Data Source instance edit model. This is returned from: /api/datasources
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourceSettings<T extends DataSourceJsonData = DataSourceJsonData, S = {}>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceSettings } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [access](#access-property) | <code>string</code> | |
|
||||
| [basicAuth](#basicauth-property) | <code>boolean</code> | |
|
||||
| [basicAuthPassword](#basicauthpassword-property) | <code>string</code> | |
|
||||
| [basicAuthUser](#basicauthuser-property) | <code>string</code> | |
|
||||
| [database](#database-property) | <code>string</code> | |
|
||||
| [id](#id-property) | <code>number</code> | |
|
||||
| [isDefault](#isdefault-property) | <code>boolean</code> | |
|
||||
| [jsonData](#jsondata-property) | <code>T</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [orgId](#orgid-property) | <code>number</code> | |
|
||||
| [password](#password-property) | <code>string</code> | |
|
||||
| [readOnly](#readonly-property) | <code>boolean</code> | |
|
||||
| [secureJsonData](#securejsondata-property) | <code>S</code> | |
|
||||
| [secureJsonFields](#securejsonfields-property) | <code>KeyValue<boolean></code> | |
|
||||
| [type](#type-property) | <code>string</code> | |
|
||||
| [typeLogoUrl](#typelogourl-property) | <code>string</code> | |
|
||||
| [url](#url-property) | <code>string</code> | |
|
||||
| [user](#user-property) | <code>string</code> | |
|
||||
| [version](#version-property) | <code>number</code> | |
|
||||
| [withCredentials](#withcredentials-property) | <code>boolean</code> | |
|
||||
|
||||
### access property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
access: string;
|
||||
```
|
||||
|
||||
### basicAuth property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
basicAuth: boolean;
|
||||
```
|
||||
|
||||
### basicAuthPassword property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
basicAuthPassword: string;
|
||||
```
|
||||
|
||||
### basicAuthUser property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
basicAuthUser: string;
|
||||
```
|
||||
|
||||
### database property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
database: string;
|
||||
```
|
||||
|
||||
### id property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
id: number;
|
||||
```
|
||||
|
||||
### isDefault property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
isDefault: boolean;
|
||||
```
|
||||
|
||||
### jsonData property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
jsonData: T;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
|
||||
### orgId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
orgId: number;
|
||||
```
|
||||
|
||||
### password property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
password: string;
|
||||
```
|
||||
|
||||
### readOnly property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readOnly: boolean;
|
||||
```
|
||||
|
||||
### secureJsonData property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
secureJsonData?: S;
|
||||
```
|
||||
|
||||
### secureJsonFields property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
secureJsonFields?: KeyValue<boolean>;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
type: string;
|
||||
```
|
||||
|
||||
### typeLogoUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
typeLogoUrl: string;
|
||||
```
|
||||
|
||||
### url property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
url: string;
|
||||
```
|
||||
|
||||
### user property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
user: string;
|
||||
```
|
||||
|
||||
### version property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
version?: number;
|
||||
```
|
||||
|
||||
### withCredentials property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
withCredentials: boolean;
|
||||
```
|
||||
32
docs/sources/packages_api/data/datasourcestatus.md
Normal file
32
docs/sources/packages_api/data/datasourcestatus.md
Normal file
@ -0,0 +1,32 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceStatus"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceStatus enum
|
||||
|
||||
### DataSourceStatus enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum DataSourceStatus
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceStatus } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Connected | <code>0</code> | |
|
||||
| Disconnected | <code>1</code> | |
|
||||
|
||||
26
docs/sources/packages_api/data/datatransformer.md
Normal file
26
docs/sources/packages_api/data/datatransformer.md
Normal file
@ -0,0 +1,26 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataTransformer"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataTransformer type
|
||||
|
||||
### DataTransformer type
|
||||
|
||||
Immutable data transformation
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DataTransformer = (data: DataFrame[]) => DataFrame[];
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataTransformer } from '@grafana/data';
|
||||
```
|
||||
44
docs/sources/packages_api/data/datatransformerconfig.md
Normal file
44
docs/sources/packages_api/data/datatransformerconfig.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataTransformerConfig"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataTransformerConfig interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataTransformerConfig<TOptions = any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataTransformerConfig } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [id](#id-property) | <code>string</code> | |
|
||||
| [options](#options-property) | <code>TOptions</code> | |
|
||||
|
||||
### id property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
||||
|
||||
### options property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
options: TOptions;
|
||||
```
|
||||
37
docs/sources/packages_api/data/datatransformerid.md
Normal file
37
docs/sources/packages_api/data/datatransformerid.md
Normal file
@ -0,0 +1,37 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataTransformerID"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataTransformerID enum
|
||||
|
||||
### DataTransformerID enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum DataTransformerID
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataTransformerID } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| append | <code>"append"</code> | |
|
||||
| filterByRefId | <code>"filterByRefId"</code> | |
|
||||
| filterFields | <code>"filterFields"</code> | |
|
||||
| filterFieldsByName | <code>"filterFieldsByName"</code> | |
|
||||
| filterFrames | <code>"filterFrames"</code> | |
|
||||
| noop | <code>"noop"</code> | |
|
||||
| reduce | <code>"reduce"</code> | |
|
||||
|
||||
35
docs/sources/packages_api/data/datatransformerinfo.md
Normal file
35
docs/sources/packages_api/data/datatransformerinfo.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataTransformerInfo"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataTransformerInfo interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataTransformerInfo<TOptions = any> extends RegistryItemWithOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataTransformerInfo } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [transformer](#transformer-property) | <code>(options: TOptions) => DataTransformer</code> | |
|
||||
|
||||
### transformer property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
transformer: (options: TOptions) => DataTransformer;
|
||||
```
|
||||
34
docs/sources/packages_api/data/datemath.md
Normal file
34
docs/sources/packages_api/data/datemath.md
Normal file
@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "dateMath"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateMath namespace
|
||||
|
||||
### dateMath namespace
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare namespace dateMath
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateMath } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [isMathString(text)](./ismathstring/) | |
|
||||
| [isValid(text)](./isvalid/) | Checks if text is a valid date which in this context means that it is either a Moment instance or it can be parsed by parse function. See parse function to see what is considered acceptable. |
|
||||
| [parse(text, roundUp, timezone)](./parse/) | Parses different types input to a moment instance. There is a specific formatting language that can be used if text arg is string. See unit tests for examples. |
|
||||
| [parseDateMath(mathString, time, roundUp)](./parsedatemath/) | Parses math part of the time string and shifts supplied time according to that math. See unit tests for examples. |
|
||||
|
||||
35
docs/sources/packages_api/data/datemath/ismathstring.md
Normal file
35
docs/sources/packages_api/data/datemath/ismathstring.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "isMathString"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateMath.isMathString() function
|
||||
|
||||
### dateMath.isMathString() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
function isMathString(text: string | DateTime | Date): boolean;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateMath } from '@grafana/data';
|
||||
const { isMathString } = dateMath;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| text | <code>string | DateTime | Date</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
37
docs/sources/packages_api/data/datemath/isvalid.md
Normal file
37
docs/sources/packages_api/data/datemath/isvalid.md
Normal file
@ -0,0 +1,37 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "isValid"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateMath.isValid() function
|
||||
|
||||
### dateMath.isValid() function
|
||||
|
||||
Checks if text is a valid date which in this context means that it is either a Moment instance or it can be parsed by parse function. See parse function to see what is considered acceptable.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
function isValid(text: string | DateTime): boolean;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateMath } from '@grafana/data';
|
||||
const { isValid } = dateMath;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| text | <code>string | DateTime</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
39
docs/sources/packages_api/data/datemath/parse.md
Normal file
39
docs/sources/packages_api/data/datemath/parse.md
Normal file
@ -0,0 +1,39 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "parse"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateMath.parse() function
|
||||
|
||||
### dateMath.parse() function
|
||||
|
||||
Parses different types input to a moment instance. There is a specific formatting language that can be used if text arg is string. See unit tests for examples.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
function parse(text: string | DateTime | Date, roundUp?: boolean, timezone?: TimeZone): DateTime | undefined;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateMath } from '@grafana/data';
|
||||
const { parse } = dateMath;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| text | <code>string | DateTime | Date</code> | |
|
||||
| roundUp | <code>boolean</code> | |
|
||||
| timezone | <code>TimeZone</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DateTime | undefined`
|
||||
|
||||
39
docs/sources/packages_api/data/datemath/parsedatemath.md
Normal file
39
docs/sources/packages_api/data/datemath/parsedatemath.md
Normal file
@ -0,0 +1,39 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "parseDateMath"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateMath.parseDateMath() function
|
||||
|
||||
### dateMath.parseDateMath() function
|
||||
|
||||
Parses math part of the time string and shifts supplied time according to that math. See unit tests for examples.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
function parseDateMath(mathString: string, time: any, roundUp?: boolean): DateTime | undefined;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateMath } from '@grafana/data';
|
||||
const { parseDateMath } = dateMath;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| mathString | <code>string</code> | |
|
||||
| time | <code>any</code> | |
|
||||
| roundUp | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DateTime | undefined`
|
||||
|
||||
24
docs/sources/packages_api/data/datetime.md
Normal file
24
docs/sources/packages_api/data/datetime.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "dateTime"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateTime variable
|
||||
|
||||
### dateTime variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dateTime: (input?: string | number | DateTime | Date | (string | number)[] | undefined, formatInput?: FormatInput) => DateTime
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateTime } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/datetimeasmoment.md
Normal file
24
docs/sources/packages_api/data/datetimeasmoment.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "dateTimeAsMoment"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateTimeAsMoment variable
|
||||
|
||||
### dateTimeAsMoment variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dateTimeAsMoment: (input?: string | number | DateTime | Date | (string | number)[] | undefined) => moment.Moment
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateTimeAsMoment } from '@grafana/data';
|
||||
```
|
||||
35
docs/sources/packages_api/data/datetimebuiltinformat.md
Normal file
35
docs/sources/packages_api/data/datetimebuiltinformat.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeBuiltinFormat"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DateTimeBuiltinFormat interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DateTimeBuiltinFormat
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeBuiltinFormat } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [\_\_momentBuiltinFormatBrand](#__momentbuiltinformatbrand-property) | <code>any</code> | |
|
||||
|
||||
### \_\_momentBuiltinFormatBrand property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
__momentBuiltinFormatBrand: any;
|
||||
```
|
||||
71
docs/sources/packages_api/data/datetimeduration.md
Normal file
71
docs/sources/packages_api/data/datetimeduration.md
Normal file
@ -0,0 +1,71 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeDuration"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DateTimeDuration interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DateTimeDuration
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeDuration } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [asHours](#ashours-property) | <code>() => number</code> | |
|
||||
| [asSeconds](#asseconds-property) | <code>() => number</code> | |
|
||||
| [hours](#hours-property) | <code>() => number</code> | |
|
||||
| [minutes](#minutes-property) | <code>() => number</code> | |
|
||||
| [seconds](#seconds-property) | <code>() => number</code> | |
|
||||
|
||||
### asHours property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
asHours: () => number;
|
||||
```
|
||||
|
||||
### asSeconds property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
asSeconds: () => number;
|
||||
```
|
||||
|
||||
### hours property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hours: () => number;
|
||||
```
|
||||
|
||||
### minutes property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
minutes: () => number;
|
||||
```
|
||||
|
||||
### seconds property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
seconds: () => number;
|
||||
```
|
||||
24
docs/sources/packages_api/data/datetimefortimezone.md
Normal file
24
docs/sources/packages_api/data/datetimefortimezone.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "dateTimeForTimeZone"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## dateTimeForTimeZone variable
|
||||
|
||||
### dateTimeForTimeZone variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dateTimeForTimeZone: (timezone?: string | undefined, input?: string | number | DateTime | Date | (string | number)[] | undefined, formatInput?: FormatInput) => DateTime
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { dateTimeForTimeZone } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/datetimeinput.md
Normal file
24
docs/sources/packages_api/data/datetimeinput.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeInput"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DateTimeInput type
|
||||
|
||||
### DateTimeInput type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DateTimeInput = Date | string | number | Array<string | number> | DateTime;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeInput } from '@grafana/data';
|
||||
```
|
||||
35
docs/sources/packages_api/data/datetimelocale.md
Normal file
35
docs/sources/packages_api/data/datetimelocale.md
Normal file
@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeLocale"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DateTimeLocale interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DateTimeLocale
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeLocale } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [firstDayOfWeek](#firstdayofweek-property) | <code>() => number</code> | |
|
||||
|
||||
### firstDayOfWeek property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
firstDayOfWeek: () => number;
|
||||
```
|
||||
24
docs/sources/packages_api/data/decimalcount.md
Normal file
24
docs/sources/packages_api/data/decimalcount.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DecimalCount"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DecimalCount type
|
||||
|
||||
### DecimalCount type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DecimalCount = number | null | undefined;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DecimalCount } from '@grafana/data';
|
||||
```
|
||||
44
docs/sources/packages_api/data/decimalinfo.md
Normal file
44
docs/sources/packages_api/data/decimalinfo.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DecimalInfo"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DecimalInfo interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DecimalInfo
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DecimalInfo } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [decimals](#decimals-property) | <code>DecimalCount</code> | |
|
||||
| [scaledDecimals](#scaleddecimals-property) | <code>DecimalCount</code> | |
|
||||
|
||||
### decimals property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
decimals: DecimalCount;
|
||||
```
|
||||
|
||||
### scaledDecimals property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scaledDecimals: DecimalCount;
|
||||
```
|
||||
24
docs/sources/packages_api/data/default_date_time_format.md
Normal file
24
docs/sources/packages_api/data/default_date_time_format.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DEFAULT_DATE_TIME_FORMAT"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DEFAULT\_DATE\_TIME\_FORMAT variable
|
||||
|
||||
### DEFAULT\_DATE\_TIME\_FORMAT variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
DEFAULT_DATE_TIME_FORMAT = "YYYY-MM-DD HH:mm:ss"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DEFAULT_DATE_TIME_FORMAT } from '@grafana/data';
|
||||
```
|
||||
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DEFAULT_FIELD_DISPLAY_VALUES_LIMIT"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT variable
|
||||
|
||||
### DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
DEFAULT_FIELD_DISPLAY_VALUES_LIMIT = 25
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DEFAULT_FIELD_DISPLAY_VALUES_LIMIT } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/defaulttimerange.md
Normal file
24
docs/sources/packages_api/data/defaulttimerange.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DefaultTimeRange"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DefaultTimeRange variable
|
||||
|
||||
### DefaultTimeRange variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
DefaultTimeRange: TimeRange
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DefaultTimeRange } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/defaulttimezone.md
Normal file
24
docs/sources/packages_api/data/defaulttimezone.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DefaultTimeZone"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DefaultTimeZone variable
|
||||
|
||||
### DefaultTimeZone variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
DefaultTimeZone: TimeZone
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DefaultTimeZone } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/deprecationwarning.md
Normal file
24
docs/sources/packages_api/data/deprecationwarning.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "deprecationWarning"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## deprecationWarning variable
|
||||
|
||||
### deprecationWarning variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
deprecationWarning: (file: string, oldName: string, newName?: string | undefined) => void
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { deprecationWarning } from '@grafana/data';
|
||||
```
|
||||
44
docs/sources/packages_api/data/dimension.md
Normal file
44
docs/sources/packages_api/data/dimension.md
Normal file
@ -0,0 +1,44 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "Dimension"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## Dimension interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface Dimension<T = any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { Dimension } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [columns](#columns-property) | <code>Array<Field<T>></code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
|
||||
### columns property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
columns: Array<Field<T>>;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
24
docs/sources/packages_api/data/dimensions.md
Normal file
24
docs/sources/packages_api/data/dimensions.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "Dimensions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## Dimensions type
|
||||
|
||||
### Dimensions type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type Dimensions = KeyValue<Dimension>;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { Dimensions } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/displayprocessor.md
Normal file
24
docs/sources/packages_api/data/displayprocessor.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DisplayProcessor"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DisplayProcessor type
|
||||
|
||||
### DisplayProcessor type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DisplayProcessor = (value: any) => DisplayValue;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DisplayProcessor } from '@grafana/data';
|
||||
```
|
||||
62
docs/sources/packages_api/data/displayvalue.md
Normal file
62
docs/sources/packages_api/data/displayvalue.md
Normal file
@ -0,0 +1,62 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DisplayValue"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DisplayValue interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DisplayValue extends FormattedValue
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DisplayValue } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [color](#color-property) | <code>string</code> | |
|
||||
| [numeric](#numeric-property) | <code>number</code> | |
|
||||
| [percent](#percent-property) | <code>number</code> | |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
|
||||
### color property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
color?: string;
|
||||
```
|
||||
|
||||
### numeric property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
numeric: number;
|
||||
```
|
||||
|
||||
### percent property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
percent?: number;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
@ -0,0 +1,37 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DisplayValueAlignmentFactors"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DisplayValueAlignmentFactors interface
|
||||
|
||||
These represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DisplayValueAlignmentFactors extends FormattedValue
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DisplayValueAlignmentFactors } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
|
||||
### title property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title: string;
|
||||
```
|
||||
24
docs/sources/packages_api/data/durationinput.md
Normal file
24
docs/sources/packages_api/data/durationinput.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DurationInput"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DurationInput type
|
||||
|
||||
### DurationInput type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DurationInput = string | number | DateTimeDuration;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DurationInput } from '@grafana/data';
|
||||
```
|
||||
24
docs/sources/packages_api/data/durationunit.md
Normal file
24
docs/sources/packages_api/data/durationunit.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DurationUnit"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DurationUnit type
|
||||
|
||||
### DurationUnit type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DurationUnit = 'year' | 'years' | 'y' | 'month' | 'months' | 'M' | 'week' | 'weeks' | 'w' | 'day' | 'days' | 'd' | 'hour' | 'hours' | 'h' | 'minute' | 'minutes' | 'm' | 'second' | 'seconds' | 's' | 'millisecond' | 'milliseconds' | 'ms' | 'quarter' | 'quarters' | 'Q';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DurationUnit } from '@grafana/data';
|
||||
```
|
||||
53
docs/sources/packages_api/data/dynamicconfigvalue.md
Normal file
53
docs/sources/packages_api/data/dynamicconfigvalue.md
Normal file
@ -0,0 +1,53 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DynamicConfigValue"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DynamicConfigValue interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DynamicConfigValue
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DynamicConfigValue } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [custom](#custom-property) | <code>boolean</code> | |
|
||||
| [prop](#prop-property) | <code>string</code> | |
|
||||
| [value](#value-property) | <code>any</code> | |
|
||||
|
||||
### custom property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
custom?: boolean;
|
||||
```
|
||||
|
||||
### prop property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
prop: string;
|
||||
```
|
||||
|
||||
### value property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
value?: any;
|
||||
```
|
||||
24
docs/sources/packages_api/data/escapestringforregex.md
Normal file
24
docs/sources/packages_api/data/escapestringforregex.md
Normal file
@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "escapeStringForRegex"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## escapeStringForRegex variable
|
||||
|
||||
### escapeStringForRegex variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
escapeStringForRegex: (value: string) => string
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { escapeStringForRegex } from '@grafana/data';
|
||||
```
|
||||
34
docs/sources/packages_api/data/eventfactory.md
Normal file
34
docs/sources/packages_api/data/eventfactory.md
Normal file
@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "eventFactory"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## eventFactory() function
|
||||
|
||||
### eventFactory() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function eventFactory<T = undefined>(name: string): AppEvent<T>;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { eventFactory } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`AppEvent<T>`
|
||||
|
||||
32
docs/sources/packages_api/data/exploremode.md
Normal file
32
docs/sources/packages_api/data/exploremode.md
Normal file
@ -0,0 +1,32 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ExploreMode"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## ExploreMode enum
|
||||
|
||||
### ExploreMode enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum ExploreMode
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ExploreMode } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Logs | <code>"Logs"</code> | |
|
||||
| Metrics | <code>"Metrics"</code> | |
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user