diff --git a/docs/sources/packages_api/_index.md b/docs/sources/packages_api/_index.md index 02be7978480..da4106f924e 100644 --- a/docs/sources/packages_api/_index.md +++ b/docs/sources/packages_api/_index.md @@ -1,21 +1,6 @@ +++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "API Reference" -keywords = ["grafana","documentation","sdk"] -type = "docs" +# ------------------------------------------------------------------------- +# Do not add anything to this folder. The packages reference docs will be +# automatically generated when syncing the rest of the docs to the website. +# ------------------------------------------------------------------------- +++ - -## 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/e2e-selectors](./e2e-selectors/) | A library containing the different design components of the Grafana ecosystem. | -| [@grafana/runtime](./runtime/) | A library containing services, configurations etc. used to interact with the Grafana engine. | -| [@grafana/ui](./ui/) | A library containing the different design components of the Grafana ecosystem. | - diff --git a/docs/sources/packages_api/data/_index.md b/docs/sources/packages_api/data/_index.md deleted file mode 100644 index 12b06a2dd97..00000000000 --- a/docs/sources/packages_api/data/_index.md +++ /dev/null @@ -1,477 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "@grafana/data" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## @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/) | | -| [BinaryOperationVector](./binaryoperationvector/) | | -| [CircularDataFrame](./circulardataframe/) | This dataframe can have values constantly added, and will never exceed the given capacity | -| [CircularVector](./circularvector/) | Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.This supports adding to the 'head' or 'tail' and will grow the buffer to match a configured capacity. | -| [ConstantVector](./constantvector/) | | -| [CSVReader](./csvreader/) | | -| [DataFrameView](./dataframeview/) | (BETA) 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 sourceAlthough 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/) | | -| [FieldConfigEditorBuilder](./fieldconfigeditorbuilder/) | Fluent API for declarative creation of field config option editors | -| [FieldConfigOptionsRegistry](./fieldconfigoptionsregistry/) | | -| [FormattedVector](./formattedvector/) | | -| [GrafanaPlugin](./grafanaplugin/) | | -| [LanguageProvider](./languageprovider/) | | -| [MutableDataFrame](./mutabledataframe/) | | -| [PanelOptionsEditorBuilder](./paneloptionseditorbuilder/) | Fluent API for declarative creation of panel options | -| [PanelPlugin](./panelplugin/) | | -| [Registry](./registry/) | | -| [SortedVector](./sortedvector/) | Values are returned in the order defined by the input parameter | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [BinaryOperationID](./binaryoperationid/) | | -| [ColorScheme](./colorscheme/) | | -| [CoreApp](./coreapp/) | | -| [CSVHeaderStyle](./csvheaderstyle/) | | -| [DataSourceStatus](./datasourcestatus/) | | -| [DataTransformerID](./datatransformerid/) | | -| [ExploreMode](./exploremode/) | | -| [FieldColorMode](./fieldcolormode/) | | -| [FieldConfigProperty](./fieldconfigproperty/) | | -| [FieldMatcherID](./fieldmatcherid/) | | -| [FieldType](./fieldtype/) | | -| [FrameMatcherID](./framematcherid/) | Field name matchers | -| [GrafanaThemeType](./grafanathemetype/) | | -| [InternalTimeZones](./internaltimezones/) | | -| [LoadingState](./loadingstate/) | Represent panel data loading state. | -| [LogLevel](./loglevel/) | Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation. | -| [LogsDedupDescription](./logsdedupdescription/) | | -| [LogsDedupStrategy](./logsdedupstrategy/) | | -| [LogsMetaKind](./logsmetakind/) | | -| [MappingType](./mappingtype/) | | -| [MatcherID](./matcherid/) | | -| [NullValueMode](./nullvaluemode/) | | -| [OrgRole](./orgrole/) | | -| [PluginIncludeType](./pluginincludetype/) | | -| [PluginSignatureStatus](./pluginsignaturestatus/) | | -| [PluginState](./pluginstate/) | | -| [PluginType](./plugintype/) | | -| [ReducerID](./reducerid/) | | -| [ThresholdsMode](./thresholdsmode/) | Display mode | -| [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/) | | -| [doStandardCalcs(field, ignoreNulls, nullAsZero)](./dostandardcalcs/) | | -| [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 labels, but not in commonLabels. | -| [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/) | | -| [getFieldDisplayName(field, frame, allFrames)](./getfielddisplayname/) | | -| [getFieldMatcher(config)](./getfieldmatcher/) | | -| [getFlotPairs({ xField, yField, nullValueMode })](./getflotpairs/) | | -| [getFlotPairsConstant(seriesData, range)](./getflotpairsconstant/) | Returns a constant series based on the first value from the provide series. | -| [getFrameDisplayName(frame, index)](./getframedisplayname/) | Get an appropriate display title | -| [getFrameMatchers(config)](./getframematchers/) | | -| [getLogLevel(line)](./getloglevel/) | Returns the log level of a log line. Parse the line for level words. If no level is found, it returns LogLevel.unknown.Example: getLogLevel('WARN 1999-12-31 this is great') // LogLevel.warn | -| [getLogLevelFromKey(key)](./getloglevelfromkey/) | | -| [getParser(line)](./getparser/) | | -| [getScaleCalculator(field, theme)](./getscalecalculator/) | | -| [getValueFormat(id)](./getvalueformat/) | | -| [getValueFormats()](./getvalueformats/) | | -| [getValueFormatterIndex()](./getvalueformatterindex/) | | -| [grafanaDataFrameToArrowTable(data, keepOriginalNames)](./grafanadataframetoarrowtable/) | | -| [guessFieldTypeForField(field)](./guessfieldtypeforfield/) | Looks at the data to guess the column type. This ignores any existing setting | -| [guessFieldTypeFromNameAndValue(name, v)](./guessfieldtypefromnameandvalue/) | Given a name and value, this will pick a reasonable field type | -| [guessFieldTypeFromValue(v)](./guessfieldtypefromvalue/) | Given a value this will guess the best column typeTODO: better Date/Time support! Look for standard date strings? | -| [hasLinks(field)](./haslinks/) | | -| [locale(value, decimals)](./locale/) | | -| [parseFlags(text)](./parseflags/) | Converts any mode modifiers in the text to the Javascript equivalent flag | -| [parseLabels(labels)](./parselabels/) | Returns a map of label keys to value from an input selector string.Example: parseLabels('{job="foo", instance="bar"}) // {job: "foo", instance: "bar"} | -| [readCSV(csv, options)](./readcsv/) | | -| [reduceField(options)](./reducefield/) | | -| [renderMarkdown(str)](./rendermarkdown/) | | -| [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/) | | -| [toDataFrame(data)](./todataframe/) | Inspect any object and return the results as a DataFrame | -| [toDataFrameDTO(data)](./todataframedto/) | Returns a copy that does not include functions | -| [toFixed(value, decimals)](./tofixed/) | | -| [toFixedScaled(value, decimals, scaledDecimals, additionalDecimals, ext)](./tofixedscaled/) | | -| [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/) | | -| [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) | -| [vectorator(vector)](./vectorator/) | Use functional programming with your vector | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AbsoluteTimeRange](./absolutetimerange/) | | -| [AnnotationEvent](./annotationevent/) | | -| [AnnotationQueryRequest](./annotationqueryrequest/) | Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md | -| [AppEvent](./appevent/) | | -| [ApplyFieldOverrideOptions](./applyfieldoverrideoptions/) | | -| [AppPluginMeta](./apppluginmeta/) | | -| [AppRootProps](./approotprops/) | | -| [ArrowDataFrame](./arrowdataframe/) | | -| [BuildInfo](./buildinfo/) | Describes the build information that will be available via the Grafana configuration. | -| [ColorFieldConfigSettings](./colorfieldconfigsettings/) | | -| [Column](./column/) | | -| [ConfigOverrideRule](./configoverriderule/) | | -| [CreatePlotOverlay](./createplotoverlay/) | | -| [CSVConfig](./csvconfig/) | | -| [CSVOptions](./csvoptions/) | | -| [CSVParseCallbacks](./csvparsecallbacks/) | | -| [DataConfigSource](./dataconfigsource/) | Describes and API for exposing panel specific data configurations. | -| [DataFrame](./dataframe/) | | -| [DataFrameDTO](./dataframedto/) | Like a DataFrame, but fields may be a FieldDTO | -| [DataLink](./datalink/) | Link configuration. The values may contain variables that need to be processed before showing the link to user.TODO: <T extends DataQuery> is not strictly true for internal links as we do not need refId for example but all data source defined queries extend this so this is more for documentation. | -| [DataLinkClickEvent](./datalinkclickevent/) | Callback info for DataLink click events | -| [DataLinksFieldConfigSettings](./datalinksfieldconfigsettings/) | | -| [DataQuery](./dataquery/) | These are the common properties available to all queries in all datasources Specific implementations will extend this interface adding the required properties for the given context | -| [DataQueryError](./dataqueryerror/) | | -| [DataQueryRequest](./dataqueryrequest/) | | -| [DataQueryResponse](./dataqueryresponse/) | | -| [DataQueryTimings](./dataquerytimings/) | | -| [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/) | | -| [DateTimeOptions](./datetimeoptions/) | The type describing date and time options. Used for all the helper functions available to parse or format date and time values. | -| [DateTimeOptionsWhenParsing](./datetimeoptionswhenparsing/) | The type that describes options that can be passed when parsing a date and time value. | -| [DateTimeOptionsWithFormat](./datetimeoptionswithformat/) | The type describing the options that can be passed to the [dateTimeFormat](./data/datetimeformat.md) helper function to control how the date and time value passed to the function is formatted. | -| [DecimalInfo](./decimalinfo/) | | -| [Dimension](./dimension/) | | -| [DisplayValue](./displayvalue/) | | -| [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/) | | -| [FeatureToggles](./featuretoggles/) | Describes available feature toggles in Grafana. These can be configured via the conf/custom.ini to enable features under development or not yet available in stable version. | -| [Field](./field/) | | -| [FieldCalcs](./fieldcalcs/) | | -| [FieldColor](./fieldcolor/) | | -| [FieldConfig](./fieldconfig/) | Every property is optionalPlugins may extend this with additional properties. Something like series overrides | -| [FieldConfigEditorConfig](./fieldconfigeditorconfig/) | | -| [FieldConfigEditorProps](./fieldconfigeditorprops/) | | -| [FieldConfigPropertyItem](./fieldconfigpropertyitem/) | | -| [FieldConfigSource](./fieldconfigsource/) | | -| [FieldDisplay](./fielddisplay/) | | -| [FieldDTO](./fielddto/) | Like a field, but properties are optional and values may be a simple array | -| [FieldMatcherInfo](./fieldmatcherinfo/) | | -| [FieldOverrideContext](./fieldoverridecontext/) | | -| [FieldOverrideEditorProps](./fieldoverrideeditorprops/) | | -| [FieldReducerInfo](./fieldreducerinfo/) | | -| [FieldState](./fieldstate/) | | -| [FieldWithIndex](./fieldwithindex/) | | -| [FlotDataPoint](./flotdatapoint/) | | -| [FormattedValue](./formattedvalue/) | | -| [FrameMatcherInfo](./framematcherinfo/) | | -| [GetFieldDisplayValuesOptions](./getfielddisplayvaluesoptions/) | | -| [GrafanaConfig](./grafanaconfig/) | Describes all the different Grafana configuration values available for an instance. | -| [GrafanaTheme](./grafanatheme/) | | -| [GrafanaThemeCommons](./grafanathemecommons/) | | -| [GraphSeriesXY](./graphseriesxy/) | View model projection of a series | -| [GroupedTimeZones](./groupedtimezones/) | | -| [HistoryItem](./historyitem/) | | -| [IntervalValues](./intervalvalues/) | | -| [Labels](./labels/) | | -| [LicenseInfo](./licenseinfo/) | Describes the license information about the current running instance of Grafana. | -| [LinkModel](./linkmodel/) | Processed Link Model. The values are ready to use | -| [LinkModelSupplier](./linkmodelsupplier/) | Provides a way to produce links on demandTODO: 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/) | Interface used to describe different kinds of page titles and page navigation. Navmodels are usually generated in the backend and stored in Redux. | -| [NavModelBreadcrumb](./navmodelbreadcrumb/) | | -| [NavModelItem](./navmodelitem/) | | -| [NumberFieldConfigSettings](./numberfieldconfigsettings/) | | -| [PanelData](./paneldata/) | | -| [PanelEditorProps](./paneleditorprops/) | | -| [PanelModel](./panelmodel/) | | -| [PanelOptionsEditorConfig](./paneloptionseditorconfig/) | | -| [PanelOptionsEditorItem](./paneloptionseditoritem/) | | -| [PanelOptionsEditorProps](./paneloptionseditorprops/) | | -| [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/) | | -| [QueryResultMetaNotice](./queryresultmetanotice/) | QueryResultMetaNotice is a structure that provides user notices for query result data | -| [QueryResultMetaStat](./queryresultmetastat/) | | -| [RangeMap](./rangemap/) | | -| [RawTimeRange](./rawtimerange/) | | -| [ReadWriteVector](./readwritevector/) | Apache arrow vectors are Read/Write | -| [ReduceDataOptions](./reducedataoptions/) | Options for how to turn DataFrames into an array of display values | -| [RegexpOrNamesMatcherOptions](./regexpornamesmatcheroptions/) | | -| [RegistryItem](./registryitem/) | | -| [RegistryItemWithOptions](./registryitemwithoptions/) | | -| [ScaledValue](./scaledvalue/) | | -| [ScopedVar](./scopedvar/) | | -| [ScopedVars](./scopedvars/) | | -| [ScreenshotInfo](./screenshotinfo/) | | -| [SelectableValue](./selectablevalue/) | Used in select elements | -| [SelectFieldConfigSettings](./selectfieldconfigsettings/) | | -| [StandardEditorContext](./standardeditorcontext/) | | -| [StandardEditorProps](./standardeditorprops/) | | -| [StandardEditorsRegistryItem](./standardeditorsregistryitem/) | | -| [StringFieldConfigSettings](./stringfieldconfigsettings/) | | -| [TableData](./tabledata/) | | -| [TextMatch](./textmatch/) | | -| [Threshold](./threshold/) | | -| [ThresholdsConfig](./thresholdsconfig/) | Config that is passed to the ThresholdsEditor | -| [ThresholdsFieldConfigSettings](./thresholdsfieldconfigsettings/) | | -| [TimeOption](./timeoption/) | | -| [TimeOptions](./timeoptions/) | | -| [TimeRange](./timerange/) | | -| [TimeSeries](./timeseries/) | | -| [TimeZoneCountry](./timezonecountry/) | | -| [TimeZoneInfo](./timezoneinfo/) | | -| [TransformerRegistyItem](./transformerregistyitem/) | | -| [TransformerUIProps](./transformeruiprops/) | | -| [UnitFieldConfigSettings](./unitfieldconfigsettings/) | | -| [UserOrgDTO](./userorgdto/) | | -| [ValueFormat](./valueformat/) | | -| [ValueFormatCategory](./valueformatcategory/) | | -| [ValueLinkConfig](./valuelinkconfig/) | | -| [ValueMap](./valuemap/) | | -| [ValueMappingFieldConfigSettings](./valuemappingfieldconfigsettings/) | | -| [VariableModel](./variablemodel/) | | -| [VariableSuggestion](./variablesuggestion/) | | -| [Vector](./vector/) | | -| [YAxis](./yaxis/) | | - -## Namespaces - -| Namespace | Description | -| --- | --- | -| [AppEvents](./appevents/) | | -| [dateMath](./datemath/) | | -| [PanelEvents](./panelevents/) | | -| [rangeUtil](./rangeutil/) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [binaryOperators](./binaryoperators/) | | -| [booleanOverrideProcessor](./booleanoverrideprocessor/) | | -| [createDimension](./createdimension/) | | -| [DataLinkBuiltInVars](./datalinkbuiltinvars/) | | -| [dataLinksOverrideProcessor](./datalinksoverrideprocessor/) | | -| [dateTime](./datetime/) | | -| [dateTimeAsMoment](./datetimeasmoment/) | | -| [dateTimeFormat](./datetimeformat/) | Helper function to format date and time according to the specified options. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md). | -| [dateTimeFormatISO](./datetimeformatiso/) | Helper function to format date and time according to the standard ISO format e.g. 2013-02-04T22:44:30.652Z. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md). | -| [dateTimeFormatTimeAgo](./datetimeformattimeago/) | Helper function to return elapsed time since passed date. The returned value will be formatted in a human readable format e.g. 4 years ago. If no options are supplied, then default values are used. For more details, see [DateTimeOptions](./data/datetimeoptions.md). | -| [dateTimeFormatWithAbbrevation](./datetimeformatwithabbrevation/) | Helper function to format date and time according to the Grafana default formatting, but it also appends the time zone abbreviation at the end e.g. 2020-05-20 13:37:00 CET. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md). | -| [dateTimeForTimeZone](./datetimefortimezone/) | | -| [dateTimeParse](./datetimeparse/) | Helper function to parse a number, text or Date to a DateTime value. If a timeZone is supplied the incoming value is parsed with that timeZone as a base. The only exception to this is if the passed value is in a UTC-based format. Then it will use UTC as the base. Examples on UTC-based values are Unix epoch and ISO formatted strings.It can also parse the Grafana quick date and time format, e.g. now-6h will be parsed as Date.now() - 6 hours and returned as a valid DateTime value.If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md). | -| [DEFAULT\_DATE\_TIME\_FORMAT](./default_date_time_format/) | | -| [DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT](./default_field_display_values_limit/) | | -| [DefaultTimeRange](./defaulttimerange/) | | -| [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/) | | -| [getTimeZoneInfo](./gettimezoneinfo/) | | -| [getTimeZones](./gettimezones/) | | -| [getValueFromDimension](./getvaluefromdimension/) | | -| [guessFieldTypes](./guessfieldtypes/) | | -| [hasMsResolution](./hasmsresolution/) | Checks if series time field has ms resolution | -| [identityOverrideProcessor](./identityoverrideprocessor/) | | -| [isDataFrame](./isdataframe/) | | -| [isDateTime](./isdatetime/) | | -| [ISO\_8601](./iso_8601/) | | -| [isTableData](./istabledata/) | | -| [locationUtil](./locationutil/) | | -| [LogsParsers](./logsparsers/) | | -| [MISSING\_VALUE](./missing_value/) | | -| [MS\_DATE\_TIME\_FORMAT](./ms_date_time_format/) | | -| [numberOverrideProcessor](./numberoverrideprocessor/) | | -| [objRemoveUndefined](./objremoveundefined/) | | -| [onUpdateDatasourceJsonDataOption](./onupdatedatasourcejsondataoption/) | | -| [onUpdateDatasourceJsonDataOptionChecked](./onupdatedatasourcejsondataoptionchecked/) | | -| [onUpdateDatasourceJsonDataOptionSelect](./onupdatedatasourcejsondataoptionselect/) | | -| [onUpdateDatasourceOption](./onupdatedatasourceoption/) | | -| [onUpdateDatasourceResetOption](./onupdatedatasourceresetoption/) | | -| [onUpdateDatasourceSecureJsonDataOption](./onupdatedatasourcesecurejsondataoption/) | | -| [onUpdateDatasourceSecureJsonDataOptionSelect](./onupdatedatasourcesecurejsondataoptionselect/) | | -| [selectOverrideProcessor](./selectoverrideprocessor/) | | -| [setLocale](./setlocale/) | | -| [standardEditorsRegistry](./standardeditorsregistry/) | | -| [standardFieldConfigEditorRegistry](./standardfieldconfigeditorregistry/) | | -| [standardTransformers](./standardtransformers/) | | -| [standardTransformersRegistry](./standardtransformersregistry/) | Registry of transformation options that can be driven by stored configuration files. | -| [stringOverrideProcessor](./stringoverrideprocessor/) | | -| [textUtil](./textutil/) | | -| [thresholdsOverrideProcessor](./thresholdsoverrideprocessor/) | | -| [TIME\_FORMAT](./time_format/) | | -| [TIME\_SERIES\_TIME\_FIELD\_NAME](./time_series_time_field_name/) | | -| [TIME\_SERIES\_VALUE\_FIELD\_NAME](./time_series_value_field_name/) | | -| [timeZoneAbbrevation](./timezoneabbrevation/) | Helper function to return only the time zone abbreviation for a given date and time value. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md). | -| [timeZoneFormatUserFriendly](./timezoneformatuserfriendly/) | | -| [toDuration](./toduration/) | | -| [toLegacyResponseData](./tolegacyresponsedata/) | | -| [toPascalCase](./topascalcase/) | | -| [toUtc](./toutc/) | | -| [unEscapeStringFromRegex](./unescapestringfromregex/) | | -| [unitOverrideProcessor](./unitoverrideprocessor/) | | -| [updateDatasourcePluginJsonDataOption](./updatedatasourcepluginjsondataoption/) | | -| [updateDatasourcePluginResetOption](./updatedatasourcepluginresetoption/) | | -| [updateDatasourcePluginSecureJsonDataOption](./updatedatasourcepluginsecurejsondataoption/) | | -| [urlUtil](./urlutil/) | | -| [valueMappingsOverrideProcessor](./valuemappingsoverrideprocessor/) | | -| [VAR\_CALC](./var_calc/) | | -| [VAR\_CELL\_PREFIX](./var_cell_prefix/) | | -| [VAR\_FIELD\_LABELS](./var_field_labels/) | | -| [VAR\_FIELD\_NAME](./var_field_name/) | | -| [VAR\_SERIES\_NAME](./var_series_name/) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [BinaryOperation](./binaryoperation/) | | -| [Color](./color/) | | -| [ColorDefinition](./colordefinition/) | | -| [DataQueryResponseData](./dataqueryresponsedata/) | | -| [DataSourceOptionsType](./datasourceoptionstype/) | | -| [DataSourceQueryType](./datasourcequerytype/) | | -| [DataTransformer](./datatransformer/) | Function that transform data frames (AKA transformer) | -| [DateTimeInput](./datetimeinput/) | | -| [DecimalCount](./decimalcount/) | | -| [Dimensions](./dimensions/) | | -| [DisplayProcessor](./displayprocessor/) | | -| [DurationInput](./durationinput/) | | -| [DurationUnit](./durationunit/) | | -| [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\_2](./omit_2/) | | -| [PanelMigrationHandler](./panelmigrationhandler/) | Called when a panel is first loaded with current panel model | -| [PanelOptionEditorsRegistry](./paneloptioneditorsregistry/) | | -| [PanelTypeChangedHandler](./paneltypechangedhandler/) | Called before a panel is initialized. Allows panel inspection for any updates before changing the panel type. | -| [PreferredVisualisationType](./preferredvisualisationtype/) | | -| [ScaleCalculator](./scalecalculator/) | | -| [Subtract](./subtract/) | | -| [TimeFragment](./timefragment/) | | -| [TimeSeriesPoints](./timeseriespoints/) | | -| [TimeSeriesValue](./timeseriesvalue/) | | -| [TimeZone](./timezone/) | | -| [TimeZoneBrowser](./timezonebrowser/) | | -| [TimeZoneResolver](./timezoneresolver/) | The type to describe the time zone resolver function that will be used to access the default time zone of a user. | -| [TimeZoneUtc](./timezoneutc/) | | -| [Trace](./trace/) | | -| [TraceData](./tracedata/) | | -| [TraceKeyValuePair](./tracekeyvaluepair/) | All timestamps are in microseconds | -| [TraceLink](./tracelink/) | | -| [TraceLog](./tracelog/) | | -| [TraceProcess](./traceprocess/) | | -| [TraceSpan](./tracespan/) | | -| [TraceSpanData](./tracespandata/) | | -| [TraceSpanReference](./tracespanreference/) | | -| [UrlQueryMap](./urlquerymap/) | Type to represent the values parsed from the query string. | -| [UrlQueryValue](./urlqueryvalue/) | Type to represent the value of a single query variable. | -| [ValueConverter](./valueconverter/) | | -| [ValueFormatter](./valueformatter/) | | -| [ValueMapping](./valuemapping/) | | -| [VariableType](./variabletype/) | | - diff --git a/docs/sources/packages_api/data/absolutetimerange.md b/docs/sources/packages_api/data/absolutetimerange.md deleted file mode 100644 index c11fbec091c..00000000000 --- a/docs/sources/packages_api/data/absolutetimerange.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AbsoluteTimeRange" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AbsoluteTimeRange interface - -Signature - -```typescript -export interface AbsoluteTimeRange -``` -Import - -```typescript -import { AbsoluteTimeRange } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [from](#from-property) | number | | -| [to](#to-property) | number | | - -### from property - -Signature - -```typescript -from: number; -``` - -### to property - -Signature - -```typescript -to: number; -``` diff --git a/docs/sources/packages_api/data/addlogleveltoseries.md b/docs/sources/packages_api/data/addlogleveltoseries.md deleted file mode 100644 index d1ebc2a845e..00000000000 --- a/docs/sources/packages_api/data/addlogleveltoseries.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "addLogLevelToSeries" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## addLogLevelToSeries() function - -### addLogLevelToSeries() function - -Signature - -```typescript -export declare function addLogLevelToSeries(series: DataFrame, lineIndex: number): DataFrame; -``` -Import - -```typescript -import { addLogLevelToSeries } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| series | DataFrame | | -| lineIndex | number | | - -Returns: - -`DataFrame` - diff --git a/docs/sources/packages_api/data/annotationevent.md b/docs/sources/packages_api/data/annotationevent.md deleted file mode 100644 index 3026d2be0c4..00000000000 --- a/docs/sources/packages_api/data/annotationevent.md +++ /dev/null @@ -1,169 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AnnotationEvent" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AnnotationEvent interface - -Signature - -```typescript -export interface AnnotationEvent -``` -Import - -```typescript -import { AnnotationEvent } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [annotation](#annotation-property) | any | | -| [avatarUrl](#avatarurl-property) | string | | -| [dashboardId](#dashboardid-property) | number | | -| [email](#email-property) | string | | -| [id](#id-property) | string | | -| [isRegion](#isregion-property) | boolean | | -| [login](#login-property) | string | | -| [panelId](#panelid-property) | number | | -| [source](#source-property) | any | | -| [tags](#tags-property) | string[] | | -| [text](#text-property) | string | | -| [time](#time-property) | number | | -| [timeEnd](#timeend-property) | number | | -| [title](#title-property) | string | | -| [type](#type-property) | string | | -| [userId](#userid-property) | number | | - -### annotation property - -Signature - -```typescript -annotation?: any; -``` - -### avatarUrl property - -Signature - -```typescript -avatarUrl?: string; -``` - -### dashboardId property - -Signature - -```typescript -dashboardId?: number; -``` - -### email property - -Signature - -```typescript -email?: string; -``` - -### id property - -Signature - -```typescript -id?: string; -``` - -### isRegion property - -Signature - -```typescript -isRegion?: boolean; -``` - -### login property - -Signature - -```typescript -login?: string; -``` - -### panelId property - -Signature - -```typescript -panelId?: number; -``` - -### source property - -Signature - -```typescript -source?: any; -``` - -### tags property - -Signature - -```typescript -tags?: string[]; -``` - -### text property - -Signature - -```typescript -text?: string; -``` - -### time property - -Signature - -```typescript -time?: number; -``` - -### timeEnd property - -Signature - -```typescript -timeEnd?: number; -``` - -### title property - -Signature - -```typescript -title?: string; -``` - -### type property - -Signature - -```typescript -type?: string; -``` - -### userId property - -Signature - -```typescript -userId?: number; -``` diff --git a/docs/sources/packages_api/data/annotationqueryrequest.md b/docs/sources/packages_api/data/annotationqueryrequest.md deleted file mode 100644 index 48d5e133254..00000000000 --- a/docs/sources/packages_api/data/annotationqueryrequest.md +++ /dev/null @@ -1,67 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AnnotationQueryRequest" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AnnotationQueryRequest interface - -Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md - -Signature - -```typescript -export interface AnnotationQueryRequest -``` -Import - -```typescript -import { AnnotationQueryRequest } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [annotation](#annotation-property) | {
datasource: string;
enable: boolean;
name: string;
} & MoreOptions | | -| [dashboard](#dashboard-property) | any | | -| [range](#range-property) | TimeRange | | -| [rangeRaw](#rangeraw-property) | RawTimeRange | | - -### annotation property - -Signature - -```typescript -annotation: { - datasource: string; - enable: boolean; - name: string; - } & MoreOptions; -``` - -### dashboard property - -Signature - -```typescript -dashboard: any; -``` - -### range property - -Signature - -```typescript -range: TimeRange; -``` - -### rangeRaw property - -Signature - -```typescript -rangeRaw: RawTimeRange; -``` diff --git a/docs/sources/packages_api/data/appendedvectors.md b/docs/sources/packages_api/data/appendedvectors.md deleted file mode 100644 index 4ce2c9b8402..00000000000 --- a/docs/sources/packages_api/data/appendedvectors.md +++ /dev/null @@ -1,152 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppendedVectors" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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 - -Signature - -```typescript -export declare class AppendedVectors implements Vector -``` -Import - -```typescript -import { AppendedVectors } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(startAt)](#constructor-startat) | | Constructs a new instance of the AppendedVectors class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [length](#length-property) | | number | | -| [source](#source-property) | | Array<AppendedVectorInfo<T>> | | - -Methods - -| 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 - -Signature - -```typescript -constructor(startAt?: number); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| startAt | number | | - -### length property - -Signature - -```typescript -length: number; -``` - -### source property - -Signature - -```typescript -source: Array>; -``` - -### append method - -Signature - -```typescript -append(v: Vector): AppendedVectorInfo; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| v | Vector<T> | | - -Returns: - -`AppendedVectorInfo` - -### get method - -Signature - -```typescript -get(index: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`T` - -### setLength method - -Make the vector look like it is this long - -Signature - -```typescript -setLength(length: number): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| length | number | | - -Returns: - -`void` - -### toArray method - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - -### toJSON method - -Signature - -```typescript -toJSON(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/appevent.md b/docs/sources/packages_api/data/appevent.md deleted file mode 100644 index b6e8615587b..00000000000 --- a/docs/sources/packages_api/data/appevent.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppEvent" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvent interface - -Signature - -```typescript -export interface AppEvent -``` -Import - -```typescript -import { AppEvent } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [name](#name-property) | string | | -| [payload](#payload-property) | T | | - -### name property - -Signature - -```typescript -readonly name: string; -``` - -### payload property - -Signature - -```typescript -payload?: T; -``` diff --git a/docs/sources/packages_api/data/appevents.md b/docs/sources/packages_api/data/appevents.md deleted file mode 100644 index 8b2aaa67df7..00000000000 --- a/docs/sources/packages_api/data/appevents.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppEvents" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents namespace - -> 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. -> - -### AppEvents namespace - -Import - -```typescript -import { AppEvents } from '@grafana/data'; -``` - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AppEvent](./appevent/) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [alertError](./alerterror/) | | -| [alertSuccess](./alertsuccess/) | | -| [alertWarning](./alertwarning/) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AlertErrorPayload](./alerterrorpayload/) | | -| [AlertPayload](./alertpayload/) | | - diff --git a/docs/sources/packages_api/data/appevents/alerterror.md b/docs/sources/packages_api/data/appevents/alerterror.md deleted file mode 100644 index 42637f29886..00000000000 --- a/docs/sources/packages_api/data/appevents/alerterror.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "alertError" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents.alertError variable - -### AppEvents.alertError variable - -Signature - -```typescript -alertError: AppEvent -``` -Import - -```typescript -import { AppEvents } from '@grafana/data'; -const { alertError } = AppEvents; -``` diff --git a/docs/sources/packages_api/data/appevents/alerterrorpayload.md b/docs/sources/packages_api/data/appevents/alerterrorpayload.md deleted file mode 100644 index 1f2273218ea..00000000000 --- a/docs/sources/packages_api/data/appevents/alerterrorpayload.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AlertErrorPayload" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents.AlertErrorPayload type - -### AppEvents.AlertErrorPayload type - -Signature - -```typescript -export declare type AlertErrorPayload = [string, (string | Error)?]; -``` -Import - -```typescript -import { AppEvents } from '@grafana/data'; -const { AlertErrorPayload } = AppEvents; -``` diff --git a/docs/sources/packages_api/data/appevents/alertpayload.md b/docs/sources/packages_api/data/appevents/alertpayload.md deleted file mode 100644 index afc06ecdb88..00000000000 --- a/docs/sources/packages_api/data/appevents/alertpayload.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AlertPayload" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents.AlertPayload type - -### AppEvents.AlertPayload type - -Signature - -```typescript -export declare type AlertPayload = [string, string?]; -``` -Import - -```typescript -import { AppEvents } from '@grafana/data'; -const { AlertPayload } = AppEvents; -``` diff --git a/docs/sources/packages_api/data/appevents/alertsuccess.md b/docs/sources/packages_api/data/appevents/alertsuccess.md deleted file mode 100644 index 5da4c213b7e..00000000000 --- a/docs/sources/packages_api/data/appevents/alertsuccess.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "alertSuccess" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents.alertSuccess variable - -### AppEvents.alertSuccess variable - -Signature - -```typescript -alertSuccess: AppEvent -``` -Import - -```typescript -import { AppEvents } from '@grafana/data'; -const { alertSuccess } = AppEvents; -``` diff --git a/docs/sources/packages_api/data/appevents/alertwarning.md b/docs/sources/packages_api/data/appevents/alertwarning.md deleted file mode 100644 index b709b81414b..00000000000 --- a/docs/sources/packages_api/data/appevents/alertwarning.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "alertWarning" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents.alertWarning variable - -### AppEvents.alertWarning variable - -Signature - -```typescript -alertWarning: AppEvent -``` -Import - -```typescript -import { AppEvents } from '@grafana/data'; -const { alertWarning } = AppEvents; -``` diff --git a/docs/sources/packages_api/data/appevents/appevent.md b/docs/sources/packages_api/data/appevents/appevent.md deleted file mode 100644 index 3592497ab59..00000000000 --- a/docs/sources/packages_api/data/appevents/appevent.md +++ /dev/null @@ -1,44 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppEvent" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppEvents.AppEvent interface - -Signature - -```typescript -export interface AppEvent -``` -Import - -```typescript -import { AppEvents } from '@grafana/data'; -const { AppEvent } = AppEvents; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [name](#name-property) | string | | -| [payload](#payload-property) | T | | - -### name property - -Signature - -```typescript -readonly name: string; -``` - -### payload property - -Signature - -```typescript -payload?: T; -``` diff --git a/docs/sources/packages_api/data/applyfieldoverrideoptions.md b/docs/sources/packages_api/data/applyfieldoverrideoptions.md deleted file mode 100644 index b5a92b7b438..00000000000 --- a/docs/sources/packages_api/data/applyfieldoverrideoptions.md +++ /dev/null @@ -1,97 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ApplyFieldOverrideOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ApplyFieldOverrideOptions interface - -Signature - -```typescript -export interface ApplyFieldOverrideOptions -``` -Import - -```typescript -import { ApplyFieldOverrideOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [autoMinMax](#autominmax-property) | boolean | | -| [data](#data-property) | DataFrame[] | | -| [fieldConfig](#fieldconfig-property) | FieldConfigSource | | -| [fieldConfigRegistry](#fieldconfigregistry-property) | FieldConfigOptionsRegistry | | -| [getDataSourceSettingsByUid](#getdatasourcesettingsbyuid-property) | (uid: string) => DataSourceInstanceSettings | undefined | | -| [replaceVariables](#replacevariables-property) | InterpolateFunction | | -| [theme](#theme-property) | GrafanaTheme | | -| [timeZone](#timezone-property) | TimeZone | | - -### autoMinMax property - -Signature - -```typescript -autoMinMax?: boolean; -``` - -### data property - -Signature - -```typescript -data?: DataFrame[]; -``` - -### fieldConfig property - -Signature - -```typescript -fieldConfig: FieldConfigSource; -``` - -### fieldConfigRegistry property - -Signature - -```typescript -fieldConfigRegistry?: FieldConfigOptionsRegistry; -``` - -### getDataSourceSettingsByUid property - -Signature - -```typescript -getDataSourceSettingsByUid: (uid: string) => DataSourceInstanceSettings | undefined; -``` - -### replaceVariables property - -Signature - -```typescript -replaceVariables: InterpolateFunction; -``` - -### theme property - -Signature - -```typescript -theme: GrafanaTheme; -``` - -### timeZone property - -Signature - -```typescript -timeZone?: TimeZone; -``` diff --git a/docs/sources/packages_api/data/applyfieldoverrides.md b/docs/sources/packages_api/data/applyfieldoverrides.md deleted file mode 100644 index a59def8021b..00000000000 --- a/docs/sources/packages_api/data/applyfieldoverrides.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "applyFieldOverrides" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## applyFieldOverrides() function - -### applyFieldOverrides() function - -Return a copy of the DataFrame with all rules applied - -Signature - -```typescript -export declare function applyFieldOverrides(options: ApplyFieldOverrideOptions): DataFrame[]; -``` -Import - -```typescript -import { applyFieldOverrides } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | ApplyFieldOverrideOptions | | - -Returns: - -`DataFrame[]` - diff --git a/docs/sources/packages_api/data/appplugin.md b/docs/sources/packages_api/data/appplugin.md deleted file mode 100644 index 96f5eeb1849..00000000000 --- a/docs/sources/packages_api/data/appplugin.md +++ /dev/null @@ -1,119 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppPlugin" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppPlugin class - -Signature - -```typescript -export declare class AppPlugin extends GrafanaPlugin> -``` -Import - -```typescript -import { AppPlugin } from '@grafana/data'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [angularPages](#angularpages-property) | | {
[component: string]: any;
} | | -| [root](#root-property) | | ComponentClass<AppRootProps<T>> | | -| [rootNav](#rootnav-property) | | NavModel | | - -Methods - -| 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, this.meta will be undefined | -| [setComponentsFromLegacyExports(pluginExports)](#setcomponentsfromlegacyexports-method) | | | -| [setRootPage(root, rootNav)](#setrootpage-method) | | Set the component displayed under: /a/${plugin-id}/\* | - -### angularPages property - -Signature - -```typescript -angularPages?: { - [component: string]: any; - }; -``` - -### root property - -Signature - -```typescript -root?: ComponentClass>; -``` - -### rootNav property - -Signature - -```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 - -Signature - -```typescript -init(meta: AppPluginMeta): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| meta | AppPluginMeta | | - -Returns: - -`void` - -### setComponentsFromLegacyExports method - -Signature - -```typescript -setComponentsFromLegacyExports(pluginExports: any): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pluginExports | any | | - -Returns: - -`void` - -### setRootPage method - -Set the component displayed under: /a/${plugin-id}/\* - -Signature - -```typescript -setRootPage(root: ComponentClass>, rootNav?: NavModel): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| root | ComponentClass<AppRootProps<T>> | | -| rootNav | NavModel | | - -Returns: - -`this` - diff --git a/docs/sources/packages_api/data/apppluginmeta.md b/docs/sources/packages_api/data/apppluginmeta.md deleted file mode 100644 index b2f637bb348..00000000000 --- a/docs/sources/packages_api/data/apppluginmeta.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppPluginMeta" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppPluginMeta interface - -Signature - -```typescript -export interface AppPluginMeta extends PluginMeta -``` -Import - -```typescript -import { AppPluginMeta } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/approotprops.md b/docs/sources/packages_api/data/approotprops.md deleted file mode 100644 index 8cfbe61422e..00000000000 --- a/docs/sources/packages_api/data/approotprops.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AppRootProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## AppRootProps interface - -Signature - -```typescript -export interface AppRootProps -``` -Import - -```typescript -import { AppRootProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [meta](#meta-property) | AppPluginMeta<T> | | -| [onNavChanged](#onnavchanged-property) | (nav: NavModel) => void | Pass the nav model to the container... is there a better way? | -| [path](#path-property) | string | | -| [query](#query-property) | KeyValue | | - -### meta property - -Signature - -```typescript -meta: AppPluginMeta; -``` - -### onNavChanged property - -Pass the nav model to the container... is there a better way? - -Signature - -```typescript -onNavChanged: (nav: NavModel) => void; -``` - -### path property - -Signature - -```typescript -path: string; -``` - -### query property - -Signature - -```typescript -query: KeyValue; -``` diff --git a/docs/sources/packages_api/data/arrayvector.md b/docs/sources/packages_api/data/arrayvector.md deleted file mode 100644 index 7645c83467e..00000000000 --- a/docs/sources/packages_api/data/arrayvector.md +++ /dev/null @@ -1,161 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ArrayVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ArrayVector class - -Signature - -```typescript -export declare class ArrayVector extends FunctionalVector implements MutableVector -``` -Import - -```typescript -import { ArrayVector } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(buffer)](#constructor-buffer) | | Constructs a new instance of the ArrayVector class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [buffer](#buffer-property) | | T[] | | -| [length](#length-property) | | number | | - -Methods - -| 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 - -Signature - -```typescript -constructor(buffer?: T[]); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| buffer | T[] | | - -### buffer property - -Signature - -```typescript -buffer: T[]; -``` - -### length property - -Signature - -```typescript -get length(): number; -``` - -### add method - -Signature - -```typescript -add(value: T): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | T | | - -Returns: - -`void` - -### get method - -Signature - -```typescript -get(index: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`T` - -### reverse method - -Signature - -```typescript -reverse(): void; -``` -Returns: - -`void` - -### set method - -Signature - -```typescript -set(index: number, value: T): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | -| value | T | | - -Returns: - -`void` - -### toArray method - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - -### toJSON method - -Signature - -```typescript -toJSON(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/arrowdataframe.md b/docs/sources/packages_api/data/arrowdataframe.md deleted file mode 100644 index faad1dd7a2f..00000000000 --- a/docs/sources/packages_api/data/arrowdataframe.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ArrowDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ArrowDataFrame interface - -Signature - -```typescript -export interface ArrowDataFrame extends DataFrame -``` -Import - -```typescript -import { ArrowDataFrame } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [table](#table-property) | Table | | - -### table property - -Signature - -```typescript -table: Table; -``` diff --git a/docs/sources/packages_api/data/arrowtabletodataframe.md b/docs/sources/packages_api/data/arrowtabletodataframe.md deleted file mode 100644 index 1faeff109ca..00000000000 --- a/docs/sources/packages_api/data/arrowtabletodataframe.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "arrowTableToDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## arrowTableToDataFrame() function - -### arrowTableToDataFrame() function - -Signature - -```typescript -export declare function arrowTableToDataFrame(table: Table): ArrowDataFrame; -``` -Import - -```typescript -import { arrowTableToDataFrame } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| table | Table | | - -Returns: - -`ArrowDataFrame` - diff --git a/docs/sources/packages_api/data/base64stringtoarrowtable.md b/docs/sources/packages_api/data/base64stringtoarrowtable.md deleted file mode 100644 index 560b6d7685a..00000000000 --- a/docs/sources/packages_api/data/base64stringtoarrowtable.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "base64StringToArrowTable" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## base64StringToArrowTable() function - -### base64StringToArrowTable() function - -Signature - -```typescript -export declare function base64StringToArrowTable(text: string): Table; -``` -Import - -```typescript -import { base64StringToArrowTable } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | | - -Returns: - -`Table` - diff --git a/docs/sources/packages_api/data/binaryoperation.md b/docs/sources/packages_api/data/binaryoperation.md deleted file mode 100644 index ab01ccdc532..00000000000 --- a/docs/sources/packages_api/data/binaryoperation.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BinaryOperation" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## BinaryOperation type - -### BinaryOperation type - -Signature - -```typescript -export declare type BinaryOperation = (left: number, right: number) => number; -``` -Import - -```typescript -import { BinaryOperation } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/binaryoperationid.md b/docs/sources/packages_api/data/binaryoperationid.md deleted file mode 100644 index fac78d17745..00000000000 --- a/docs/sources/packages_api/data/binaryoperationid.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BinaryOperationID" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## BinaryOperationID enum - -### BinaryOperationID enum - -Signature - -```typescript -export declare enum BinaryOperationID -``` -Import - -```typescript -import { BinaryOperationID } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Add | "+" | | -| Divide | "/" | | -| Multiply | "*" | | -| Subtract | "-" | | - diff --git a/docs/sources/packages_api/data/binaryoperationvector.md b/docs/sources/packages_api/data/binaryoperationvector.md deleted file mode 100644 index 03a54f7aabd..00000000000 --- a/docs/sources/packages_api/data/binaryoperationvector.md +++ /dev/null @@ -1,105 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BinaryOperationVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## BinaryOperationVector class - -Signature - -```typescript -export declare class BinaryOperationVector implements Vector -``` -Import - -```typescript -import { BinaryOperationVector } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(left, right, operation)](#constructor-leftrightoperation) | | Constructs a new instance of the BinaryOperationVector class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [length](#length-property) | | number | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(index)](#get-method) | | | -| [toArray()](#toarray-method) | | | -| [toJSON()](#tojson-method) | | | - -### constructor(left, right, operation) - -Constructs a new instance of the `BinaryOperationVector` class - -Signature - -```typescript -constructor(left: Vector, right: Vector, operation: BinaryOperation); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| left | Vector<number> | | -| right | Vector<number> | | -| operation | BinaryOperation | | - -### length property - -Signature - -```typescript -get length(): number; -``` - -### get method - -Signature - -```typescript -get(index: number): number; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`number` - -### toArray method - -Signature - -```typescript -toArray(): number[]; -``` -Returns: - -`number[]` - -### toJSON method - -Signature - -```typescript -toJSON(): number[]; -``` -Returns: - -`number[]` - diff --git a/docs/sources/packages_api/data/binaryoperators.md b/docs/sources/packages_api/data/binaryoperators.md deleted file mode 100644 index d35ee2f9981..00000000000 --- a/docs/sources/packages_api/data/binaryoperators.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "binaryOperators" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## binaryOperators variable - -### binaryOperators variable - -Signature - -```typescript -binaryOperators: Registry -``` -Import - -```typescript -import { binaryOperators } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/booleanoverrideprocessor.md b/docs/sources/packages_api/data/booleanoverrideprocessor.md deleted file mode 100644 index 4aec8813630..00000000000 --- a/docs/sources/packages_api/data/booleanoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "booleanOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## booleanOverrideProcessor variable - -### booleanOverrideProcessor variable - -Signature - -```typescript -booleanOverrideProcessor: (value: boolean, _context: FieldOverrideContext, _settings?: ThresholdsFieldConfigSettings | undefined) => boolean -``` -Import - -```typescript -import { booleanOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/buildinfo.md b/docs/sources/packages_api/data/buildinfo.md deleted file mode 100644 index aadb55b321d..00000000000 --- a/docs/sources/packages_api/data/buildinfo.md +++ /dev/null @@ -1,101 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BuildInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## BuildInfo interface - -Describes the build information that will be available via the Grafana configuration. - -Signature - -```typescript -export interface BuildInfo -``` -Import - -```typescript -import { BuildInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [commit](#commit-property) | string | | -| [edition](#edition-property) | string | | -| [env](#env-property) | string | | -| [hasUpdate](#hasupdate-property) | boolean | | -| [hideVersion](#hideversion-property) | boolean | | -| [isEnterprise](#isenterprise-property) | boolean | Is set to true when running Grafana Enterprise edition. | -| [latestVersion](#latestversion-property) | string | | -| [version](#version-property) | string | | - -### commit property - -Signature - -```typescript -commit: string; -``` - -### edition property - -Signature - -```typescript -edition: string; -``` - -### env property - -Signature - -```typescript -env: string; -``` - -### hasUpdate property - -Signature - -```typescript -hasUpdate: boolean; -``` - -### hideVersion property - -Signature - -```typescript -hideVersion: boolean; -``` - -### isEnterprise property - -Is set to true when running Grafana Enterprise edition. - -Signature - -```typescript -isEnterprise: boolean; -``` - -### latestVersion property - -Signature - -```typescript -latestVersion: string; -``` - -### version property - -Signature - -```typescript -version: string; -``` diff --git a/docs/sources/packages_api/data/calculatefieldstats.md b/docs/sources/packages_api/data/calculatefieldstats.md deleted file mode 100644 index 9fe42be014f..00000000000 --- a/docs/sources/packages_api/data/calculatefieldstats.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "calculateFieldStats" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## calculateFieldStats() function - -### calculateFieldStats() function - -Signature - -```typescript -export declare function calculateFieldStats(rows: LogRowModel[], extractor: RegExp): LogLabelStatsModel[]; -``` -Import - -```typescript -import { calculateFieldStats } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| rows | LogRowModel[] | | -| extractor | RegExp | | - -Returns: - -`LogLabelStatsModel[]` - diff --git a/docs/sources/packages_api/data/calculatelogslabelstats.md b/docs/sources/packages_api/data/calculatelogslabelstats.md deleted file mode 100644 index b4c660f810f..00000000000 --- a/docs/sources/packages_api/data/calculatelogslabelstats.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "calculateLogsLabelStats" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## calculateLogsLabelStats() function - -### calculateLogsLabelStats() function - -Signature - -```typescript -export declare function calculateLogsLabelStats(rows: LogRowModel[], label: string): LogLabelStatsModel[]; -``` -Import - -```typescript -import { calculateLogsLabelStats } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| rows | LogRowModel[] | | -| label | string | | - -Returns: - -`LogLabelStatsModel[]` - diff --git a/docs/sources/packages_api/data/calculatestats.md b/docs/sources/packages_api/data/calculatestats.md deleted file mode 100644 index 8a9931e7474..00000000000 --- a/docs/sources/packages_api/data/calculatestats.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "calculateStats" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## calculateStats() function - -### calculateStats() function - -Signature - -```typescript -export declare function calculateStats(values: any[]): LogLabelStatsModel[]; -``` -Import - -```typescript -import { calculateStats } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| values | any[] | | - -Returns: - -`LogLabelStatsModel[]` - diff --git a/docs/sources/packages_api/data/circulardataframe.md b/docs/sources/packages_api/data/circulardataframe.md deleted file mode 100644 index 5a3138f0e3e..00000000000 --- a/docs/sources/packages_api/data/circulardataframe.md +++ /dev/null @@ -1,44 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CircularDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CircularDataFrame class - -This dataframe can have values constantly added, and will never exceed the given capacity - -Signature - -```typescript -export declare class CircularDataFrame extends MutableDataFrame -``` -Import - -```typescript -import { CircularDataFrame } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(options)](#constructor-options) | | Constructs a new instance of the CircularDataFrame class | - -### constructor(options) - -Constructs a new instance of the `CircularDataFrame` class - -Signature - -```typescript -constructor(options: CircularOptions); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | CircularOptions | | - diff --git a/docs/sources/packages_api/data/circularvector.md b/docs/sources/packages_api/data/circularvector.md deleted file mode 100644 index c6954596c6c..00000000000 --- a/docs/sources/packages_api/data/circularvector.md +++ /dev/null @@ -1,185 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CircularVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CircularVector class - -Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add. - -This supports adding to the 'head' or 'tail' and will grow the buffer to match a configured capacity. - -Signature - -```typescript -export declare class CircularVector extends FunctionalVector implements MutableVector -``` -Import - -```typescript -import { CircularVector } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(options)](#constructor-options) | | Constructs a new instance of the CircularVector class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [add](#add-property) | | (value: T) => void | Add the value to the buffer | -| [length](#length-property) | | number | | - -Methods - -| 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 - -Signature - -```typescript -constructor(options: CircularOptions); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | CircularOptions<T> | | - -### add property - -Add the value to the buffer - -Signature - -```typescript -add: (value: T) => void; -``` - -### length property - -Signature - -```typescript -get length(): number; -``` - -### get method - -Signature - -```typescript -get(index: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`T` - -### reverse method - -Signature - -```typescript -reverse(): void; -``` -Returns: - -`void` - -### set method - -Signature - -```typescript -set(index: number, value: T): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | -| value | T | | - -Returns: - -`void` - -### setAppendMode method - -Signature - -```typescript -setAppendMode(mode: 'head' | 'tail'): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mode | 'head' | 'tail' | | - -Returns: - -`void` - -### setCapacity method - -Signature - -```typescript -setCapacity(v: number): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| v | number | | - -Returns: - -`void` - -### toArray method - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - -### toJSON method - -Signature - -```typescript -toJSON(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/color.md b/docs/sources/packages_api/data/color.md deleted file mode 100644 index 5333897d798..00000000000 --- a/docs/sources/packages_api/data/color.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Color" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Color type - -### Color type - -Signature - -```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'; -``` -Import - -```typescript -import { Color } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/colordefinition.md b/docs/sources/packages_api/data/colordefinition.md deleted file mode 100644 index dbf6833d412..00000000000 --- a/docs/sources/packages_api/data/colordefinition.md +++ /dev/null @@ -1,28 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ColorDefinition" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ColorDefinition type - -### ColorDefinition type - -Signature - -```typescript -export declare type ColorDefinition = { - hue: Hue; - isPrimary?: boolean; - name: Color; - variants: ThemeVariants; -}; -``` -Import - -```typescript -import { ColorDefinition } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/colorfieldconfigsettings.md b/docs/sources/packages_api/data/colorfieldconfigsettings.md deleted file mode 100644 index a64174c8891..00000000000 --- a/docs/sources/packages_api/data/colorfieldconfigsettings.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ColorFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ColorFieldConfigSettings interface - -Signature - -```typescript -export interface ColorFieldConfigSettings -``` -Import - -```typescript -import { ColorFieldConfigSettings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allowUndefined](#allowundefined-property) | boolean | | -| [disableNamedColors](#disablenamedcolors-property) | boolean | | -| [textWhenUndefined](#textwhenundefined-property) | string | | - -### allowUndefined property - -Signature - -```typescript -allowUndefined?: boolean; -``` - -### disableNamedColors property - -Signature - -```typescript -disableNamedColors?: boolean; -``` - -### textWhenUndefined property - -Signature - -```typescript -textWhenUndefined?: string; -``` diff --git a/docs/sources/packages_api/data/colorscheme.md b/docs/sources/packages_api/data/colorscheme.md deleted file mode 100644 index 17c672b2318..00000000000 --- a/docs/sources/packages_api/data/colorscheme.md +++ /dev/null @@ -1,56 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ColorScheme" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ColorScheme enum - -### ColorScheme enum - -Signature - -```typescript -export declare enum ColorScheme -``` -Import - -```typescript -import { ColorScheme } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Blues | "Blues" | | -| BrBG | "BrBG" | | -| BuGn | "BuGn" | | -| BuPu | "BuPu" | | -| GnBu | "GnBu" | | -| Greens | "Greens" | | -| Greys | "Greys" | | -| Oranges | "Oranges" | | -| OrRd | "OrRd" | | -| PiYG | "PiYG" | | -| PRGn | "PRGn" | | -| PuBu | "PuBu" | | -| PuBuGn | "PuBuGn" | | -| PuOr | "PuOr" | | -| PuRd | "PuRd" | | -| Purples | "Purples" | | -| RdBu | "RdBu" | | -| RdGy | "RdGy" | | -| RdPu | "RdPu" | | -| RdYlBu | "RdYlBu" | | -| RdYlGn | "RdYlGn" | | -| Reds | "Reds" | | -| Spectral | "Spectral" | | -| YlGn | "YlGn" | | -| YlGnBu | "YlGnBu" | | -| YlOrBr | "YlOrBr" | | -| YlOrRd | "YlOrRd" | | - diff --git a/docs/sources/packages_api/data/column.md b/docs/sources/packages_api/data/column.md deleted file mode 100644 index d17bc3f2c80..00000000000 --- a/docs/sources/packages_api/data/column.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Column" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Column interface - -Signature - -```typescript -export interface Column -``` -Import - -```typescript -import { Column } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [custom](#custom-property) | Record<string, any> | | -| [filterable](#filterable-property) | boolean | | -| [text](#text-property) | string | | -| [unit](#unit-property) | string | | - -### custom property - -Signature - -```typescript -custom?: Record; -``` - -### filterable property - -Signature - -```typescript -filterable?: boolean; -``` - -### text property - -Signature - -```typescript -text: string; -``` - -### unit property - -Signature - -```typescript -unit?: string; -``` diff --git a/docs/sources/packages_api/data/configoverriderule.md b/docs/sources/packages_api/data/configoverriderule.md deleted file mode 100644 index 7ea5c380ce0..00000000000 --- a/docs/sources/packages_api/data/configoverriderule.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ConfigOverrideRule" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ConfigOverrideRule interface - -Signature - -```typescript -export interface ConfigOverrideRule -``` -Import - -```typescript -import { ConfigOverrideRule } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](#matcher-property) | MatcherConfig | | -| [properties](#properties-property) | DynamicConfigValue[] | | - -### matcher property - -Signature - -```typescript -matcher: MatcherConfig; -``` - -### properties property - -Signature - -```typescript -properties: DynamicConfigValue[]; -``` diff --git a/docs/sources/packages_api/data/constantvector.md b/docs/sources/packages_api/data/constantvector.md deleted file mode 100644 index a41bde73977..00000000000 --- a/docs/sources/packages_api/data/constantvector.md +++ /dev/null @@ -1,104 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ConstantVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ConstantVector class - -Signature - -```typescript -export declare class ConstantVector implements Vector -``` -Import - -```typescript -import { ConstantVector } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(value, len)](#constructor-valuelen) | | Constructs a new instance of the ConstantVector class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [length](#length-property) | | number | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(index)](#get-method) | | | -| [toArray()](#toarray-method) | | | -| [toJSON()](#tojson-method) | | | - -### constructor(value, len) - -Constructs a new instance of the `ConstantVector` class - -Signature - -```typescript -constructor(value: T, len: number); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | T | | -| len | number | | - -### length property - -Signature - -```typescript -get length(): number; -``` - -### get method - -Signature - -```typescript -get(index: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`T` - -### toArray method - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - -### toJSON method - -Signature - -```typescript -toJSON(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/coreapp.md b/docs/sources/packages_api/data/coreapp.md deleted file mode 100644 index e70f582c079..00000000000 --- a/docs/sources/packages_api/data/coreapp.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CoreApp" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CoreApp enum - -### CoreApp enum - -Signature - -```typescript -export declare enum CoreApp -``` -Import - -```typescript -import { CoreApp } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Dashboard | "dashboard" | | -| Explore | "explore" | | - diff --git a/docs/sources/packages_api/data/createdimension.md b/docs/sources/packages_api/data/createdimension.md deleted file mode 100644 index 5b7a6d8cfb9..00000000000 --- a/docs/sources/packages_api/data/createdimension.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "createDimension" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## createDimension variable - -### createDimension variable - -Signature - -```typescript -createDimension: (name: string, columns: Field[]) => Dimension -``` -Import - -```typescript -import { createDimension } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/createplotoverlay.md b/docs/sources/packages_api/data/createplotoverlay.md deleted file mode 100644 index 1dc877dc17c..00000000000 --- a/docs/sources/packages_api/data/createplotoverlay.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CreatePlotOverlay" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CreatePlotOverlay interface - -Signature - -```typescript -export interface CreatePlotOverlay -``` -Import - -```typescript -import { CreatePlotOverlay } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/csvconfig.md b/docs/sources/packages_api/data/csvconfig.md deleted file mode 100644 index 0f43227c9d6..00000000000 --- a/docs/sources/packages_api/data/csvconfig.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CSVConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CSVConfig interface - -Signature - -```typescript -export interface CSVConfig -``` -Import - -```typescript -import { CSVConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [delimiter](#delimiter-property) | string | | -| [encoding](#encoding-property) | string | | -| [headerStyle](#headerstyle-property) | CSVHeaderStyle | | -| [newline](#newline-property) | string | | -| [quoteChar](#quotechar-property) | string | | - -### delimiter property - -Signature - -```typescript -delimiter?: string; -``` - -### encoding property - -Signature - -```typescript -encoding?: string; -``` - -### headerStyle property - -Signature - -```typescript -headerStyle?: CSVHeaderStyle; -``` - -### newline property - -Signature - -```typescript -newline?: string; -``` - -### quoteChar property - -Signature - -```typescript -quoteChar?: string; -``` diff --git a/docs/sources/packages_api/data/csvheaderstyle.md b/docs/sources/packages_api/data/csvheaderstyle.md deleted file mode 100644 index e01833ec012..00000000000 --- a/docs/sources/packages_api/data/csvheaderstyle.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CSVHeaderStyle" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CSVHeaderStyle enum - -### CSVHeaderStyle enum - -Signature - -```typescript -export declare enum CSVHeaderStyle -``` -Import - -```typescript -import { CSVHeaderStyle } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| full | 0 | | -| name | 1 | | -| none | 2 | | - diff --git a/docs/sources/packages_api/data/csvoptions.md b/docs/sources/packages_api/data/csvoptions.md deleted file mode 100644 index e7dc006c1d6..00000000000 --- a/docs/sources/packages_api/data/csvoptions.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CSVOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CSVOptions interface - -Signature - -```typescript -export interface CSVOptions -``` -Import - -```typescript -import { CSVOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [callback](#callback-property) | CSVParseCallbacks | | -| [config](#config-property) | CSVConfig | | - -### callback property - -Signature - -```typescript -callback?: CSVParseCallbacks; -``` - -### config property - -Signature - -```typescript -config?: CSVConfig; -``` diff --git a/docs/sources/packages_api/data/csvparsecallbacks.md b/docs/sources/packages_api/data/csvparsecallbacks.md deleted file mode 100644 index c9bd0bd8335..00000000000 --- a/docs/sources/packages_api/data/csvparsecallbacks.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CSVParseCallbacks" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CSVParseCallbacks interface - -Signature - -```typescript -export interface CSVParseCallbacks -``` -Import - -```typescript -import { CSVParseCallbacks } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [onHeader](#onheader-property) | (fields: Field[]) => void | Get a callback before any rows are processed This can return a modified table to force any Column configurations | -| [onRow](#onrow-property) | (row: any[]) => void | | - -### onHeader property - -Get a callback before any rows are processed This can return a modified table to force any Column configurations - -Signature - -```typescript -onHeader: (fields: Field[]) => void; -``` - -### onRow property - -Signature - -```typescript -onRow: (row: any[]) => void; -``` diff --git a/docs/sources/packages_api/data/csvreader.md b/docs/sources/packages_api/data/csvreader.md deleted file mode 100644 index 392028631c2..00000000000 --- a/docs/sources/packages_api/data/csvreader.md +++ /dev/null @@ -1,115 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CSVReader" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## CSVReader class - -Signature - -```typescript -export declare class CSVReader -``` -Import - -```typescript -import { CSVReader } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(options)](#constructor-options) | | Constructs a new instance of the CSVReader class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [callback](#callback-property) | | CSVParseCallbacks | | -| [config](#config-property) | | CSVConfig | | -| [current](#current-property) | | MutableDataFrame | | -| [data](#data-property) | | MutableDataFrame[] | | -| [state](#state-property) | | ParseState | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [readCSV(text)](#readcsv-method) | | | - -### constructor(options) - -Constructs a new instance of the `CSVReader` class - -Signature - -```typescript -constructor(options?: CSVOptions); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | CSVOptions | | - -### callback property - -Signature - -```typescript -callback?: CSVParseCallbacks; -``` - -### config property - -Signature - -```typescript -config: CSVConfig; -``` - -### current property - -Signature - -```typescript -current: MutableDataFrame; -``` - -### data property - -Signature - -```typescript -data: MutableDataFrame[]; -``` - -### state property - -Signature - -```typescript -state: ParseState; -``` - -### readCSV method - -Signature - -```typescript -readCSV(text: string): MutableDataFrame[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | | - -Returns: - -`MutableDataFrame[]` - diff --git a/docs/sources/packages_api/data/dataconfigsource.md b/docs/sources/packages_api/data/dataconfigsource.md deleted file mode 100644 index 994bbd9bd33..00000000000 --- a/docs/sources/packages_api/data/dataconfigsource.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataConfigSource" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataConfigSource interface - -Describes and API for exposing panel specific data configurations. - -Signature - -```typescript -export interface DataConfigSource -``` -Import - -```typescript -import { DataConfigSource } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getFieldOverrideOptions](#getfieldoverrideoptions-property) | () => ApplyFieldOverrideOptions | undefined | | -| [getTransformations](#gettransformations-property) | () => DataTransformerConfig[] | undefined | | - -### getFieldOverrideOptions property - -Signature - -```typescript -getFieldOverrideOptions: () => ApplyFieldOverrideOptions | undefined; -``` - -### getTransformations property - -Signature - -```typescript -getTransformations: () => DataTransformerConfig[] | undefined; -``` diff --git a/docs/sources/packages_api/data/dataframe.md b/docs/sources/packages_api/data/dataframe.md deleted file mode 100644 index afe0e1158da..00000000000 --- a/docs/sources/packages_api/data/dataframe.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataFrame interface - -Signature - -```typescript -export interface DataFrame extends QueryResultBase -``` -Import - -```typescript -import { DataFrame } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fields](#fields-property) | Field[] | | -| [length](#length-property) | number | | -| [name](#name-property) | string | | - -### fields property - -Signature - -```typescript -fields: Field[]; -``` - -### length property - -Signature - -```typescript -length: number; -``` - -### name property - -Signature - -```typescript -name?: string; -``` diff --git a/docs/sources/packages_api/data/dataframedto.md b/docs/sources/packages_api/data/dataframedto.md deleted file mode 100644 index 4d4c7951868..00000000000 --- a/docs/sources/packages_api/data/dataframedto.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataFrameDTO" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataFrameDTO interface - -Like a DataFrame, but fields may be a FieldDTO - -Signature - -```typescript -export interface DataFrameDTO extends QueryResultBase -``` -Import - -```typescript -import { DataFrameDTO } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fields](#fields-property) | Array<FieldDTO | Field> | | -| [name](#name-property) | string | | - -### fields property - -Signature - -```typescript -fields: Array; -``` - -### name property - -Signature - -```typescript -name?: string; -``` diff --git a/docs/sources/packages_api/data/dataframeview.md b/docs/sources/packages_api/data/dataframeview.md deleted file mode 100644 index 29f1dfe1a13..00000000000 --- a/docs/sources/packages_api/data/dataframeview.md +++ /dev/null @@ -1,164 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataFrameView" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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. - -Signature - -```typescript -export declare class DataFrameView extends FunctionalVector -``` -Import - -```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. - -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(data)](#constructor-data) | | (BETA) Constructs a new instance of the DataFrameView class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [dataFrame](#dataframe-property) | | DataFrame | (BETA) | -| [length](#length-property) | | number | (BETA) | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(idx)](#get-method) | | (BETA) 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) | | (BETA) Helper function to return the [DisplayProcessor](./data/displayprocessor.md) for a given field column. | -| [toArray()](#toarray-method) | | (BETA) | - -> 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 - -Signature - -```typescript -constructor(data: DataFrame); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | 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. -> - -### dataFrame property - -Signature - -```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 - -Signature - -```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. -> - -### 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. - -Signature - -```typescript -get(idx: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| idx | number | The index of the object you currently are inspecting | - -Returns: - -`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. - -Signature - -```typescript -getFieldDisplayProcessor(colIndex: number): DisplayProcessor | null; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| colIndex | number | the field column index for the data frame. | - -Returns: - -`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. -> - -### toArray method - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/datalink.md b/docs/sources/packages_api/data/datalink.md deleted file mode 100644 index f1ce2dac3c8..00000000000 --- a/docs/sources/packages_api/data/datalink.md +++ /dev/null @@ -1,86 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLink" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataLink interface - -Link configuration. The values may contain variables that need to be processed before showing the link to user. - -TODO: <T extends DataQuery> is not strictly true for internal links as we do not need refId for example but all data source defined queries extend this so this is more for documentation. - -Signature - -```typescript -export interface DataLink -``` -Import - -```typescript -import { DataLink } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [internal](#internal-property) | {
query: T;
datasourceUid: string;
} | | -| [onBuildUrl](#onbuildurl-property) | (event: DataLinkClickEvent) => string | | -| [onClick](#onclick-property) | (event: DataLinkClickEvent) => void | | -| [targetBlank](#targetblank-property) | boolean | | -| [title](#title-property) | string | | -| [url](#url-property) | string | | - -### internal property - -Signature - -```typescript -internal?: { - query: T; - datasourceUid: string; - }; -``` - -### onBuildUrl property - -Signature - -```typescript -onBuildUrl?: (event: DataLinkClickEvent) => string; -``` - -### onClick property - -Signature - -```typescript -onClick?: (event: DataLinkClickEvent) => void; -``` - -### targetBlank property - -Signature - -```typescript -targetBlank?: boolean; -``` - -### title property - -Signature - -```typescript -title: string; -``` - -### url property - -Signature - -```typescript -url: string; -``` diff --git a/docs/sources/packages_api/data/datalinkbuiltinvars.md b/docs/sources/packages_api/data/datalinkbuiltinvars.md deleted file mode 100644 index 26122981e23..00000000000 --- a/docs/sources/packages_api/data/datalinkbuiltinvars.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLinkBuiltInVars" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataLinkBuiltInVars variable - -### DataLinkBuiltInVars variable - -Signature - -```typescript -DataLinkBuiltInVars: { - keepTime: string; - timeRangeFrom: string; - timeRangeTo: string; - includeVars: string; - seriesName: string; - fieldName: string; - valueTime: string; - valueNumeric: string; - valueText: string; - valueRaw: string; - valueCalc: string; -} -``` -Import - -```typescript -import { DataLinkBuiltInVars } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datalinkclickevent.md b/docs/sources/packages_api/data/datalinkclickevent.md deleted file mode 100644 index 9ec48064ae6..00000000000 --- a/docs/sources/packages_api/data/datalinkclickevent.md +++ /dev/null @@ -1,54 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLinkClickEvent" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataLinkClickEvent interface - -Callback info for DataLink click events - -Signature - -```typescript -export interface DataLinkClickEvent -``` -Import - -```typescript -import { DataLinkClickEvent } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [e](#e-property) | any | | -| [origin](#origin-property) | T | | -| [scopedVars](#scopedvars-property) | ScopedVars | | - -### e property - -Signature - -```typescript -e?: any; -``` - -### origin property - -Signature - -```typescript -origin: T; -``` - -### scopedVars property - -Signature - -```typescript -scopedVars: ScopedVars; -``` diff --git a/docs/sources/packages_api/data/datalinksfieldconfigsettings.md b/docs/sources/packages_api/data/datalinksfieldconfigsettings.md deleted file mode 100644 index f418f3da709..00000000000 --- a/docs/sources/packages_api/data/datalinksfieldconfigsettings.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLinksFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataLinksFieldConfigSettings interface - -Signature - -```typescript -export interface DataLinksFieldConfigSettings -``` -Import - -```typescript -import { DataLinksFieldConfigSettings } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datalinksoverrideprocessor.md b/docs/sources/packages_api/data/datalinksoverrideprocessor.md deleted file mode 100644 index 933cc69918d..00000000000 --- a/docs/sources/packages_api/data/datalinksoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dataLinksOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dataLinksOverrideProcessor variable - -### dataLinksOverrideProcessor variable - -Signature - -```typescript -dataLinksOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: DataLinksFieldConfigSettings | undefined) => DataLink[] -``` -Import - -```typescript -import { dataLinksOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/dataquery.md b/docs/sources/packages_api/data/dataquery.md deleted file mode 100644 index adc4d4cd079..00000000000 --- a/docs/sources/packages_api/data/dataquery.md +++ /dev/null @@ -1,82 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataQuery" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataQuery interface - -These are the common properties available to all queries in all datasources Specific implementations will extend this interface adding the required properties for the given context - -Signature - -```typescript -export interface DataQuery -``` -Import - -```typescript -import { DataQuery } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [datasource](#datasource-property) | string | null | For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. | -| [hide](#hide-property) | boolean | true if query is disabled (ie should not be returned to the dashboard) | -| [key](#key-property) | string | Unique, guid like, string used in explore mode | -| [queryType](#querytype-property) | string | Specify the query flavor | -| [refId](#refid-property) | string | A - Z | - -### datasource property - -For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. - -Signature - -```typescript -datasource?: string | null; -``` - -### hide property - -true if query is disabled (ie should not be returned to the dashboard) - -Signature - -```typescript -hide?: boolean; -``` - -### key property - -Unique, guid like, string used in explore mode - -Signature - -```typescript -key?: string; -``` - -### queryType property - -Specify the query flavor - -Signature - -```typescript -queryType?: string; -``` - -### refId property - -A - Z - -Signature - -```typescript -refId: string; -``` diff --git a/docs/sources/packages_api/data/dataqueryerror.md b/docs/sources/packages_api/data/dataqueryerror.md deleted file mode 100644 index cc0ee56fa0c..00000000000 --- a/docs/sources/packages_api/data/dataqueryerror.md +++ /dev/null @@ -1,82 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataQueryError" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataQueryError interface - -Signature - -```typescript -export interface DataQueryError -``` -Import - -```typescript -import { DataQueryError } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [cancelled](#cancelled-property) | boolean | | -| [data](#data-property) | {
message?: string;
error?: string;
} | | -| [message](#message-property) | string | | -| [refId](#refid-property) | string | | -| [status](#status-property) | string | | -| [statusText](#statustext-property) | string | | - -### cancelled property - -Signature - -```typescript -cancelled?: boolean; -``` - -### data property - -Signature - -```typescript -data?: { - message?: string; - error?: string; - }; -``` - -### message property - -Signature - -```typescript -message?: string; -``` - -### refId property - -Signature - -```typescript -refId?: string; -``` - -### status property - -Signature - -```typescript -status?: string; -``` - -### statusText property - -Signature - -```typescript -statusText?: string; -``` diff --git a/docs/sources/packages_api/data/dataqueryrequest.md b/docs/sources/packages_api/data/dataqueryrequest.md deleted file mode 100644 index 5b0f93ffc2b..00000000000 --- a/docs/sources/packages_api/data/dataqueryrequest.md +++ /dev/null @@ -1,187 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataQueryRequest" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataQueryRequest interface - -Signature - -```typescript -export interface DataQueryRequest -``` -Import - -```typescript -import { DataQueryRequest } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [app](#app-property) | CoreApp | string | | -| [cacheTimeout](#cachetimeout-property) | string | | -| [dashboardId](#dashboardid-property) | number | | -| [endTime](#endtime-property) | number | | -| [exploreMode](#exploremode-property) | ExploreMode | | -| [interval](#interval-property) | string | | -| [intervalMs](#intervalms-property) | number | | -| [maxDataPoints](#maxdatapoints-property) | number | | -| [panelId](#panelid-property) | number | | -| [range](#range-property) | TimeRange | | -| [rangeRaw](#rangeraw-property) | RawTimeRange | | -| [requestId](#requestid-property) | string | | -| [reverse](#reverse-property) | boolean | | -| [scopedVars](#scopedvars-property) | ScopedVars | | -| [startTime](#starttime-property) | number | | -| [targets](#targets-property) | TQuery[] | | -| [timeInfo](#timeinfo-property) | string | | -| [timezone](#timezone-property) | string | | - -### app property - -Signature - -```typescript -app: CoreApp | string; -``` - -### cacheTimeout property - -Signature - -```typescript -cacheTimeout?: string; -``` - -### dashboardId property - -Signature - -```typescript -dashboardId: number; -``` - -### endTime property - -Signature - -```typescript -endTime?: number; -``` - -### exploreMode property - -Signature - -```typescript -exploreMode?: ExploreMode; -``` - -### interval property - -Signature - -```typescript -interval: string; -``` - -### intervalMs property - -Signature - -```typescript -intervalMs?: number; -``` - -### maxDataPoints property - -Signature - -```typescript -maxDataPoints?: number; -``` - -### panelId property - -Signature - -```typescript -panelId: number; -``` - -### range property - -Signature - -```typescript -range: TimeRange; -``` - -### rangeRaw property - -Signature - -```typescript -rangeRaw?: RawTimeRange; -``` - -### requestId property - -Signature - -```typescript -requestId: string; -``` - -### reverse property - -Signature - -```typescript -reverse?: boolean; -``` - -### scopedVars property - -Signature - -```typescript -scopedVars: ScopedVars; -``` - -### startTime property - -Signature - -```typescript -startTime: number; -``` - -### targets property - -Signature - -```typescript -targets: TQuery[]; -``` - -### timeInfo property - -Signature - -```typescript -timeInfo?: string; -``` - -### timezone property - -Signature - -```typescript -timezone: string; -``` diff --git a/docs/sources/packages_api/data/dataqueryresponse.md b/docs/sources/packages_api/data/dataqueryresponse.md deleted file mode 100644 index 0c0717d6ec6..00000000000 --- a/docs/sources/packages_api/data/dataqueryresponse.md +++ /dev/null @@ -1,69 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataQueryResponse" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataQueryResponse interface - -Signature - -```typescript -export interface DataQueryResponse -``` -Import - -```typescript -import { DataQueryResponse } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | DataQueryResponseData[] | The response data. When streaming, this may be empty or a partial result set | -| [error](#error-property) | DataQueryError | Optionally include error info along with the response data | -| [key](#key-property) | string | 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) | LoadingState | 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 - -Signature - -```typescript -data: DataQueryResponseData[]; -``` - -### error property - -Optionally include error info along with the response data - -Signature - -```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) - -Signature - -```typescript -key?: string; -``` - -### state property - -Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined - -Signature - -```typescript -state?: LoadingState; -``` diff --git a/docs/sources/packages_api/data/dataqueryresponsedata.md b/docs/sources/packages_api/data/dataqueryresponsedata.md deleted file mode 100644 index 7d1949726e9..00000000000 --- a/docs/sources/packages_api/data/dataqueryresponsedata.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataQueryResponseData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataQueryResponseData type - -### DataQueryResponseData type - -Signature - -```typescript -export declare type DataQueryResponseData = DataFrame | DataFrameDTO | LegacyResponseData; -``` -Import - -```typescript -import { DataQueryResponseData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/dataquerytimings.md b/docs/sources/packages_api/data/dataquerytimings.md deleted file mode 100644 index 9e2034b2a65..00000000000 --- a/docs/sources/packages_api/data/dataquerytimings.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataQueryTimings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataQueryTimings interface - -Signature - -```typescript -export interface DataQueryTimings -``` -Import - -```typescript -import { DataQueryTimings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataProcessingTime](#dataprocessingtime-property) | number | | - -### dataProcessingTime property - -Signature - -```typescript -dataProcessingTime: number; -``` diff --git a/docs/sources/packages_api/data/datasourceapi.md b/docs/sources/packages_api/data/datasourceapi.md deleted file mode 100644 index 807e06c43b2..00000000000 --- a/docs/sources/packages_api/data/datasourceapi.md +++ /dev/null @@ -1,438 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceApi" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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. - -Signature - -```typescript -export declare abstract class DataSourceApi -``` -Import - -```typescript -import { DataSourceApi } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(instanceSettings)](#constructor-instancesettings) | | Constructs a new instance of the DataSourceApi class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [components](#components-property) | | DataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions> | 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) | | <TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse> | Retrieve context for a given log row | -| [id](#id-property) | | number | Set in constructor | -| [init](#init-property) | | () => void | Initializes a datasource after instantiation | -| [interval](#interval-property) | | string | min interval range | -| [languageProvider](#languageprovider-property) | | any | Used in explore | -| [meta](#meta-property) | | DataSourcePluginMeta | static information about the datasource | -| [name](#name-property) | | string | Set in constructor | - -Methods - -| 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 annotations 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 | -| [showContextToggle(row)](#showcontexttoggle-method) | | | -| [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 - -Signature - -```typescript -constructor(instanceSettings: DataSourceInstanceSettings); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| instanceSettings | DataSourceInstanceSettings<TOptions> | | - -### 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 - -Signature - -```typescript -components?: DataSourcePluginComponents, TQuery, TOptions>; -``` - -### getLogRowContext property - -Retrieve context for a given log row - -Signature - -```typescript -getLogRowContext?: (row: LogRowModel, options?: TContextQueryOptions) => Promise; -``` - -### id property - -Set in constructor - -Signature - -```typescript -readonly id: number; -``` - -### init property - -Initializes a datasource after instantiation - -Signature - -```typescript -init?: () => void; -``` - -### interval property - -min interval range - -Signature - -```typescript -interval?: string; -``` - -### languageProvider property - -Used in explore - -Signature - -```typescript -languageProvider?: any; -``` - -### meta property - -static information about the datasource - -Signature - -```typescript -meta: DataSourcePluginMeta; -``` - -### name property - -Set in constructor - -Signature - -```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. - -Signature - -```typescript -annotationQuery?(options: AnnotationQueryRequest): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | AnnotationQueryRequest<TQuery> | | - -Returns: - -`Promise` - -### getHighlighterExpression method - -Used in explore - -Signature - -```typescript -getHighlighterExpression?(query: TQuery): string[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | TQuery | | - -Returns: - -`string[]` - -### getQueryDisplayText method - -Convert a query to a simple text string - -Signature - -```typescript -getQueryDisplayText?(query: TQuery): string; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | TQuery | | - -Returns: - -`string` - -### getQueryHints method - -Get hints for query improvements - -Signature - -```typescript -getQueryHints?(query: TQuery, results: any[], ...rest: any): QueryHint[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | TQuery | | -| results | any[] | | -| rest | any | | - -Returns: - -`QueryHint[]` - -### getTagKeys method - -Get tag keys for adhoc filters - -Signature - -```typescript -getTagKeys?(options?: any): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | any | | - -Returns: - -`Promise` - -### getTagValues method - -Get tag values for adhoc filters - -Signature - -```typescript -getTagValues?(options: any): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | any | | - -Returns: - -`Promise` - -### getVersion method - -Signature - -```typescript -getVersion?(optionalOptions?: any): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| optionalOptions | any | | - -Returns: - -`Promise` - -### importQueries method - -Imports queries from a different datasource - -Signature - -```typescript -importQueries?(queries: TQuery[], originMeta: PluginMeta): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| queries | TQuery[] | | -| originMeta | PluginMeta | | - -Returns: - -`Promise` - -### interpolateVariablesInQueries method - -Signature - -```typescript -interpolateVariablesInQueries?(queries: TQuery[], scopedVars: ScopedVars | {}): TQuery[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| queries | TQuery[] | | -| scopedVars | ScopedVars | {} | | - -Returns: - -`TQuery[]` - -### metricFindQuery method - -Variable query action. - -Signature - -```typescript -metricFindQuery?(query: any, options?: any): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | any | | -| options | any | | - -Returns: - -`Promise` - -### modifyQuery method - -Used in explore - -Signature - -```typescript -modifyQuery?(query: TQuery, action: QueryFixAction): TQuery; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | TQuery | | -| action | QueryFixAction | | - -Returns: - -`TQuery` - -### query method - -Query for data, and optionally stream results - -Signature - -```typescript -abstract query(request: DataQueryRequest): Promise | Observable; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | DataQueryRequest<TQuery> | | - -Returns: - -`Promise | Observable` - -### showContextToggle method - -Signature - -```typescript -showContextToggle?(row?: LogRowModel): boolean; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| row | LogRowModel | | - -Returns: - -`boolean` - -### targetContainsTemplate method - -Used by alerting to check if query contains template variables - -Signature - -```typescript -targetContainsTemplate?(query: TQuery): boolean; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | TQuery | | - -Returns: - -`boolean` - -### testDatasource method - -Test & verify datasource settings & connection details - -Signature - -```typescript -abstract testDatasource(): Promise; -``` -Returns: - -`Promise` - diff --git a/docs/sources/packages_api/data/datasourceconstructor.md b/docs/sources/packages_api/data/datasourceconstructor.md deleted file mode 100644 index df4a895dd7c..00000000000 --- a/docs/sources/packages_api/data/datasourceconstructor.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceConstructor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceConstructor interface - -Signature - -```typescript -export interface DataSourceConstructor, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> -``` -Import - -```typescript -import { DataSourceConstructor } from '@grafana/data'; -``` -Methods - -| Method | Description | -| --- | --- | -| [new(instanceSettings, args)](#new-instancesettingsargs) | | - -### new(instanceSettings, args) - -Signature - -```typescript -new (instanceSettings: DataSourceInstanceSettings, ...args: any[]): DSType; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| instanceSettings | DataSourceInstanceSettings<TOptions> | | -| args | any[] | | - -Returns: - -`DSType` - diff --git a/docs/sources/packages_api/data/datasourceinstancesettings.md b/docs/sources/packages_api/data/datasourceinstancesettings.md deleted file mode 100644 index 7fc2951f0d1..00000000000 --- a/docs/sources/packages_api/data/datasourceinstancesettings.md +++ /dev/null @@ -1,137 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceInstanceSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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 - -Signature - -```typescript -export interface DataSourceInstanceSettings -``` -Import - -```typescript -import { DataSourceInstanceSettings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [basicAuth](#basicauth-property) | string | This is the full Authorization header if basic auth is enabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposed to browser/Frontend so this will be empty then. | -| [database](#database-property) | string | | -| [id](#id-property) | number | | -| [jsonData](#jsondata-property) | T | | -| [meta](#meta-property) | DataSourcePluginMeta | | -| [name](#name-property) | string | | -| [password](#password-property) | string | | -| [type](#type-property) | string | | -| [uid](#uid-property) | string | | -| [url](#url-property) | string | | -| [username](#username-property) | string | | -| [withCredentials](#withcredentials-property) | boolean | | - -### basicAuth property - -This is the full Authorization header if basic auth is enabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposed to browser/Frontend so this will be empty then. - -Signature - -```typescript -basicAuth?: string; -``` - -### database property - -Signature - -```typescript -database?: string; -``` - -### id property - -Signature - -```typescript -id: number; -``` - -### jsonData property - -Signature - -```typescript -jsonData: T; -``` - -### meta property - -Signature - -```typescript -meta: DataSourcePluginMeta; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### password property - -Signature - -```typescript -password?: string; -``` - -### type property - -Signature - -```typescript -type: string; -``` - -### uid property - -Signature - -```typescript -uid: string; -``` - -### url property - -Signature - -```typescript -url?: string; -``` - -### username property - -Signature - -```typescript -username?: string; -``` - -### withCredentials property - -Signature - -```typescript -withCredentials?: boolean; -``` diff --git a/docs/sources/packages_api/data/datasourcejsondata.md b/docs/sources/packages_api/data/datasourcejsondata.md deleted file mode 100644 index 16ac990324e..00000000000 --- a/docs/sources/packages_api/data/datasourcejsondata.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceJsonData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceJsonData interface - -Signature - -```typescript -export interface DataSourceJsonData -``` -Import - -```typescript -import { DataSourceJsonData } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authType](#authtype-property) | string | | -| [defaultRegion](#defaultregion-property) | string | | - -### authType property - -Signature - -```typescript -authType?: string; -``` - -### defaultRegion property - -Signature - -```typescript -defaultRegion?: string; -``` diff --git a/docs/sources/packages_api/data/datasourceoptionstype.md b/docs/sources/packages_api/data/datasourceoptionstype.md deleted file mode 100644 index d82b22582e5..00000000000 --- a/docs/sources/packages_api/data/datasourceoptionstype.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceOptionsType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceOptionsType type - -### DataSourceOptionsType type - -Signature - -```typescript -export declare type DataSourceOptionsType> = DSType extends DataSourceApi ? TOptions : never; -``` -Import - -```typescript -import { DataSourceOptionsType } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datasourceplugin.md b/docs/sources/packages_api/data/datasourceplugin.md deleted file mode 100644 index efcd5df4477..00000000000 --- a/docs/sources/packages_api/data/datasourceplugin.md +++ /dev/null @@ -1,286 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourcePlugin" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourcePlugin class - -Signature - -```typescript -export declare class DataSourcePlugin, TQuery extends DataQuery = DataSourceQueryType, TOptions extends DataSourceJsonData = DataSourceOptionsType, TSecureOptions = {}> extends GrafanaPlugin> -``` -Import - -```typescript -import { DataSourcePlugin } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(DataSourceClass)](#constructor-datasourceclass) | | Constructs a new instance of the DataSourcePlugin class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [components](#components-property) | | DataSourcePluginComponents<DSType, TQuery, TOptions, TSecureOptions> | | -| [DataSourceClass](#datasourceclass-property) | | DataSourceConstructor<DSType, TQuery, TOptions> | | - -Methods - -| 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 - -Signature - -```typescript -constructor(DataSourceClass: DataSourceConstructor); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| DataSourceClass | DataSourceConstructor<DSType, TQuery, TOptions> | | - -### components property - -Signature - -```typescript -components: DataSourcePluginComponents; -``` - -### DataSourceClass property - -Signature - -```typescript -DataSourceClass: DataSourceConstructor; -``` - -### setAnnotationQueryCtrl method - -Signature - -```typescript -setAnnotationQueryCtrl(AnnotationsQueryCtrl: any): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| AnnotationsQueryCtrl | any | | - -Returns: - -`this` - -### setComponentsFromLegacyExports method - -Signature - -```typescript -setComponentsFromLegacyExports(pluginExports: any): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pluginExports | any | | - -Returns: - -`void` - -### setConfigCtrl method - -Signature - -```typescript -setConfigCtrl(ConfigCtrl: any): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ConfigCtrl | any | | - -Returns: - -`this` - -### setConfigEditor method - -Signature - -```typescript -setConfigEditor(editor: ComponentType>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| editor | ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>> | | - -Returns: - -`this` - -### setExploreLogsQueryField method - -Signature - -```typescript -setExploreLogsQueryField(ExploreQueryField: ComponentType>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ExploreQueryField | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> | | - -Returns: - -`this` - -### setExploreMetricsQueryField method - -Signature - -```typescript -setExploreMetricsQueryField(ExploreQueryField: ComponentType>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ExploreQueryField | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> | | - -Returns: - -`this` - -### setExploreQueryField method - -Signature - -```typescript -setExploreQueryField(ExploreQueryField: ComponentType>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ExploreQueryField | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> | | - -Returns: - -`this` - -### setExploreStartPage method - -Signature - -```typescript -setExploreStartPage(ExploreStartPage: ComponentType): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ExploreStartPage | ComponentType<ExploreStartPageProps> | | - -Returns: - -`this` - -### setMetadataInspector method - -Signature - -```typescript -setMetadataInspector(MetadataInspector: ComponentType>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| MetadataInspector | ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>> | | - -Returns: - -`this` - -### setQueryCtrl method - -Signature - -```typescript -setQueryCtrl(QueryCtrl: any): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| QueryCtrl | any | | - -Returns: - -`this` - -### setQueryEditor method - -Signature - -```typescript -setQueryEditor(QueryEditor: ComponentType>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| QueryEditor | ComponentType<QueryEditorProps<DSType, TQuery, TOptions>> | | - -Returns: - -`this` - -### setVariableQueryEditor method - -Signature - -```typescript -setVariableQueryEditor(VariableQueryEditor: any): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| VariableQueryEditor | any | | - -Returns: - -`this` - diff --git a/docs/sources/packages_api/data/datasourceplugincomponents.md b/docs/sources/packages_api/data/datasourceplugincomponents.md deleted file mode 100644 index f7eb75b7960..00000000000 --- a/docs/sources/packages_api/data/datasourceplugincomponents.md +++ /dev/null @@ -1,115 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourcePluginComponents" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourcePluginComponents interface - -Signature - -```typescript -export interface DataSourcePluginComponents, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData, TSecureOptions = {}> -``` -Import - -```typescript -import { DataSourcePluginComponents } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [AnnotationsQueryCtrl](#annotationsqueryctrl-property) | any | | -| [ConfigEditor](#configeditor-property) | ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>> | | -| [ExploreLogsQueryField](#explorelogsqueryfield-property) | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> | | -| [ExploreMetricsQueryField](#exploremetricsqueryfield-property) | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> | | -| [ExploreQueryField](#explorequeryfield-property) | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> | | -| [ExploreStartPage](#explorestartpage-property) | ComponentType<ExploreStartPageProps> | | -| [MetadataInspector](#metadatainspector-property) | ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>> | | -| [QueryCtrl](#queryctrl-property) | any | | -| [QueryEditor](#queryeditor-property) | ComponentType<QueryEditorProps<DSType, TQuery, TOptions>> | | -| [VariableQueryEditor](#variablequeryeditor-property) | any | | - -### AnnotationsQueryCtrl property - -Signature - -```typescript -AnnotationsQueryCtrl?: any; -``` - -### ConfigEditor property - -Signature - -```typescript -ConfigEditor?: ComponentType>; -``` - -### ExploreLogsQueryField property - -Signature - -```typescript -ExploreLogsQueryField?: ComponentType>; -``` - -### ExploreMetricsQueryField property - -Signature - -```typescript -ExploreMetricsQueryField?: ComponentType>; -``` - -### ExploreQueryField property - -Signature - -```typescript -ExploreQueryField?: ComponentType>; -``` - -### ExploreStartPage property - -Signature - -```typescript -ExploreStartPage?: ComponentType; -``` - -### MetadataInspector property - -Signature - -```typescript -MetadataInspector?: ComponentType>; -``` - -### QueryCtrl property - -Signature - -```typescript -QueryCtrl?: any; -``` - -### QueryEditor property - -Signature - -```typescript -QueryEditor?: ComponentType>; -``` - -### VariableQueryEditor property - -Signature - -```typescript -VariableQueryEditor?: any; -``` diff --git a/docs/sources/packages_api/data/datasourcepluginmeta.md b/docs/sources/packages_api/data/datasourcepluginmeta.md deleted file mode 100644 index a4e227b57ae..00000000000 --- a/docs/sources/packages_api/data/datasourcepluginmeta.md +++ /dev/null @@ -1,133 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourcePluginMeta" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourcePluginMeta interface - -Signature - -```typescript -export interface DataSourcePluginMeta extends PluginMeta -``` -Import - -```typescript -import { DataSourcePluginMeta } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alerting](#alerting-property) | boolean | | -| [annotations](#annotations-property) | boolean | | -| [builtIn](#builtin-property) | boolean | | -| [category](#category-property) | string | | -| [hasQueryHelp](#hasqueryhelp-property) | boolean | | -| [logs](#logs-property) | boolean | | -| [metrics](#metrics-property) | boolean | | -| [mixed](#mixed-property) | boolean | | -| [queryOptions](#queryoptions-property) | PluginMetaQueryOptions | | -| [sort](#sort-property) | number | | -| [streaming](#streaming-property) | boolean | | -| [tracing](#tracing-property) | boolean | | - -### alerting property - -Signature - -```typescript -alerting?: boolean; -``` - -### annotations property - -Signature - -```typescript -annotations?: boolean; -``` - -### builtIn property - -Signature - -```typescript -builtIn?: boolean; -``` - -### category property - -Signature - -```typescript -category?: string; -``` - -### hasQueryHelp property - -Signature - -```typescript -hasQueryHelp?: boolean; -``` - -### logs property - -Signature - -```typescript -logs?: boolean; -``` - -### metrics property - -Signature - -```typescript -metrics?: boolean; -``` - -### mixed property - -Signature - -```typescript -mixed?: boolean; -``` - -### queryOptions property - -Signature - -```typescript -queryOptions?: PluginMetaQueryOptions; -``` - -### sort property - -Signature - -```typescript -sort?: number; -``` - -### streaming property - -Signature - -```typescript -streaming?: boolean; -``` - -### tracing property - -Signature - -```typescript -tracing?: boolean; -``` diff --git a/docs/sources/packages_api/data/datasourcepluginoptionseditorprops.md b/docs/sources/packages_api/data/datasourcepluginoptionseditorprops.md deleted file mode 100644 index 4399f0c23bd..00000000000 --- a/docs/sources/packages_api/data/datasourcepluginoptionseditorprops.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourcePluginOptionsEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourcePluginOptionsEditorProps interface - -Signature - -```typescript -export interface DataSourcePluginOptionsEditorProps -``` -Import - -```typescript -import { DataSourcePluginOptionsEditorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [onOptionsChange](#onoptionschange-property) | (options: DataSourceSettings<JSONData, SecureJSONData>) => void | | -| [options](#options-property) | DataSourceSettings<JSONData, SecureJSONData> | | - -### onOptionsChange property - -Signature - -```typescript -onOptionsChange: (options: DataSourceSettings) => void; -``` - -### options property - -Signature - -```typescript -options: DataSourceSettings; -``` diff --git a/docs/sources/packages_api/data/datasourcequerytype.md b/docs/sources/packages_api/data/datasourcequerytype.md deleted file mode 100644 index 7b34f57865d..00000000000 --- a/docs/sources/packages_api/data/datasourcequerytype.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceQueryType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceQueryType type - -### DataSourceQueryType type - -Signature - -```typescript -export declare type DataSourceQueryType> = DSType extends DataSourceApi ? TQuery : never; -``` -Import - -```typescript -import { DataSourceQueryType } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datasourceselectitem.md b/docs/sources/packages_api/data/datasourceselectitem.md deleted file mode 100644 index 897d2636659..00000000000 --- a/docs/sources/packages_api/data/datasourceselectitem.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceSelectItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceSelectItem interface - -Signature - -```typescript -export interface DataSourceSelectItem -``` -Import - -```typescript -import { DataSourceSelectItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [meta](#meta-property) | DataSourcePluginMeta | | -| [name](#name-property) | string | | -| [sort](#sort-property) | string | | -| [value](#value-property) | string | null | | - -### meta property - -Signature - -```typescript -meta: DataSourcePluginMeta; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### sort property - -Signature - -```typescript -sort: string; -``` - -### value property - -Signature - -```typescript -value: string | null; -``` diff --git a/docs/sources/packages_api/data/datasourcesettings.md b/docs/sources/packages_api/data/datasourcesettings.md deleted file mode 100644 index 99d2e005bd7..00000000000 --- a/docs/sources/packages_api/data/datasourcesettings.md +++ /dev/null @@ -1,207 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceSettings interface - -Data Source instance edit model. This is returned from: /api/datasources - -Signature - -```typescript -export interface DataSourceSettings -``` -Import - -```typescript -import { DataSourceSettings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [access](#access-property) | string | | -| [basicAuth](#basicauth-property) | boolean | | -| [basicAuthPassword](#basicauthpassword-property) | string | | -| [basicAuthUser](#basicauthuser-property) | string | | -| [database](#database-property) | string | | -| [id](#id-property) | number | | -| [isDefault](#isdefault-property) | boolean | | -| [jsonData](#jsondata-property) | T | | -| [name](#name-property) | string | | -| [orgId](#orgid-property) | number | | -| [password](#password-property) | string | | -| [readOnly](#readonly-property) | boolean | | -| [secureJsonData](#securejsondata-property) | S | | -| [secureJsonFields](#securejsonfields-property) | KeyValue<boolean> | | -| [type](#type-property) | string | | -| [typeLogoUrl](#typelogourl-property) | string | | -| [url](#url-property) | string | | -| [user](#user-property) | string | | -| [version](#version-property) | number | | -| [withCredentials](#withcredentials-property) | boolean | | - -### access property - -Signature - -```typescript -access: string; -``` - -### basicAuth property - -Signature - -```typescript -basicAuth: boolean; -``` - -### basicAuthPassword property - -Signature - -```typescript -basicAuthPassword: string; -``` - -### basicAuthUser property - -Signature - -```typescript -basicAuthUser: string; -``` - -### database property - -Signature - -```typescript -database: string; -``` - -### id property - -Signature - -```typescript -id: number; -``` - -### isDefault property - -Signature - -```typescript -isDefault: boolean; -``` - -### jsonData property - -Signature - -```typescript -jsonData: T; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### orgId property - -Signature - -```typescript -orgId: number; -``` - -### password property - -Signature - -```typescript -password: string; -``` - -### readOnly property - -Signature - -```typescript -readOnly: boolean; -``` - -### secureJsonData property - -Signature - -```typescript -secureJsonData?: S; -``` - -### secureJsonFields property - -Signature - -```typescript -secureJsonFields?: KeyValue; -``` - -### type property - -Signature - -```typescript -type: string; -``` - -### typeLogoUrl property - -Signature - -```typescript -typeLogoUrl: string; -``` - -### url property - -Signature - -```typescript -url: string; -``` - -### user property - -Signature - -```typescript -user: string; -``` - -### version property - -Signature - -```typescript -version?: number; -``` - -### withCredentials property - -Signature - -```typescript -withCredentials: boolean; -``` diff --git a/docs/sources/packages_api/data/datasourcestatus.md b/docs/sources/packages_api/data/datasourcestatus.md deleted file mode 100644 index cdb7263e4a4..00000000000 --- a/docs/sources/packages_api/data/datasourcestatus.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceStatus" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataSourceStatus enum - -### DataSourceStatus enum - -Signature - -```typescript -export declare enum DataSourceStatus -``` -Import - -```typescript -import { DataSourceStatus } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Connected | 0 | | -| Disconnected | 1 | | - diff --git a/docs/sources/packages_api/data/datatransformer.md b/docs/sources/packages_api/data/datatransformer.md deleted file mode 100644 index a349c0a835b..00000000000 --- a/docs/sources/packages_api/data/datatransformer.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataTransformer" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataTransformer type - -### DataTransformer type - -Function that transform data frames (AKA transformer) - -Signature - -```typescript -export declare type DataTransformer = (data: DataFrame[]) => DataFrame[]; -``` -Import - -```typescript -import { DataTransformer } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datatransformerconfig.md b/docs/sources/packages_api/data/datatransformerconfig.md deleted file mode 100644 index 8c8a93b4219..00000000000 --- a/docs/sources/packages_api/data/datatransformerconfig.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataTransformerConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataTransformerConfig interface - -Signature - -```typescript -export interface DataTransformerConfig -``` -Import - -```typescript -import { DataTransformerConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](#id-property) | string | Unique identifier of transformer | -| [options](#options-property) | TOptions | Options to be passed to the transformer | - -### id property - -Unique identifier of transformer - -Signature - -```typescript -id: string; -``` - -### options property - -Options to be passed to the transformer - -Signature - -```typescript -options: TOptions; -``` diff --git a/docs/sources/packages_api/data/datatransformerid.md b/docs/sources/packages_api/data/datatransformerid.md deleted file mode 100644 index d56527babb1..00000000000 --- a/docs/sources/packages_api/data/datatransformerid.md +++ /dev/null @@ -1,44 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataTransformerID" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataTransformerID enum - -### DataTransformerID enum - -Signature - -```typescript -export declare enum DataTransformerID -``` -Import - -```typescript -import { DataTransformerID } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| append | "append" | | -| calculateField | "calculateField" | | -| ensureColumns | "ensureColumns" | | -| filterByRefId | "filterByRefId" | | -| filterFields | "filterFields" | | -| filterFieldsByName | "filterFieldsByName" | | -| filterFrames | "filterFrames" | | -| labelsToFields | "labelsToFields" | | -| merge | "merge" | | -| noop | "noop" | | -| order | "order" | | -| organize | "organize" | | -| reduce | "reduce" | | -| rename | "rename" | | -| seriesToColumns | "seriesToColumns" | | - diff --git a/docs/sources/packages_api/data/datatransformerinfo.md b/docs/sources/packages_api/data/datatransformerinfo.md deleted file mode 100644 index 60384d8f267..00000000000 --- a/docs/sources/packages_api/data/datatransformerinfo.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataTransformerInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DataTransformerInfo interface - -Signature - -```typescript -export interface DataTransformerInfo extends RegistryItemWithOptions -``` -Import - -```typescript -import { DataTransformerInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [transformer](#transformer-property) | (options: TOptions) => DataTransformer | Function that configures transformation and returns a transformer | - -### transformer property - -Function that configures transformation and returns a transformer - -Signature - -```typescript -transformer: (options: TOptions) => DataTransformer; -``` diff --git a/docs/sources/packages_api/data/datemath.md b/docs/sources/packages_api/data/datemath.md deleted file mode 100644 index 264d83df518..00000000000 --- a/docs/sources/packages_api/data/datemath.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateMath" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateMath namespace - -> 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. -> - -### dateMath namespace - -Import - -```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. | - diff --git a/docs/sources/packages_api/data/datemath/ismathstring.md b/docs/sources/packages_api/data/datemath/ismathstring.md deleted file mode 100644 index ed4444c81ea..00000000000 --- a/docs/sources/packages_api/data/datemath/ismathstring.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "isMathString" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateMath.isMathString() function - -### dateMath.isMathString() function - -Signature - -```typescript -export declare function isMathString(text: string | DateTime | Date): boolean; -``` -Import - -```typescript -import { dateMath } from '@grafana/data'; -const { isMathString } = dateMath; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | DateTime | Date | | - -Returns: - -`boolean` - diff --git a/docs/sources/packages_api/data/datemath/isvalid.md b/docs/sources/packages_api/data/datemath/isvalid.md deleted file mode 100644 index 421099a64e1..00000000000 --- a/docs/sources/packages_api/data/datemath/isvalid.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "isValid" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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. - -Signature - -```typescript -export declare function isValid(text: string | DateTime): boolean; -``` -Import - -```typescript -import { dateMath } from '@grafana/data'; -const { isValid } = dateMath; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | DateTime | | - -Returns: - -`boolean` - diff --git a/docs/sources/packages_api/data/datemath/parse.md b/docs/sources/packages_api/data/datemath/parse.md deleted file mode 100644 index 176ff4c8c3a..00000000000 --- a/docs/sources/packages_api/data/datemath/parse.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "parse" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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. - -Signature - -```typescript -export declare function parse(text?: string | DateTime | Date | null, roundUp?: boolean, timezone?: TimeZone): DateTime | undefined; -``` -Import - -```typescript -import { dateMath } from '@grafana/data'; -const { parse } = dateMath; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | DateTime | Date | null | | -| roundUp | boolean | See parseDateMath function. | -| timezone | TimeZone | Only string 'utc' is acceptable here, for anything else, local timezone is used. | - -Returns: - -`DateTime | undefined` - diff --git a/docs/sources/packages_api/data/datemath/parsedatemath.md b/docs/sources/packages_api/data/datemath/parsedatemath.md deleted file mode 100644 index bdac1fe60ad..00000000000 --- a/docs/sources/packages_api/data/datemath/parsedatemath.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "parseDateMath" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## 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. - -Signature - -```typescript -export declare function parseDateMath(mathString: string, time: any, roundUp?: boolean): DateTime | undefined; -``` -Import - -```typescript -import { dateMath } from '@grafana/data'; -const { parseDateMath } = dateMath; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mathString | string | | -| time | any | | -| roundUp | boolean | If true it will round the time to endOf time unit, otherwise to startOf time unit. | - -Returns: - -`DateTime | undefined` - diff --git a/docs/sources/packages_api/data/datetime.md b/docs/sources/packages_api/data/datetime.md deleted file mode 100644 index 60902c28d0d..00000000000 --- a/docs/sources/packages_api/data/datetime.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTime" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTime variable - -### dateTime variable - -Signature - -```typescript -dateTime: (input?: string | number | DateTime | Date | (string | number)[] | undefined, formatInput?: FormatInput) => DateTime -``` -Import - -```typescript -import { dateTime } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimeasmoment.md b/docs/sources/packages_api/data/datetimeasmoment.md deleted file mode 100644 index 89d3e01e012..00000000000 --- a/docs/sources/packages_api/data/datetimeasmoment.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeAsMoment" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeAsMoment variable - -### dateTimeAsMoment variable - -Signature - -```typescript -dateTimeAsMoment: (input?: string | number | DateTime | Date | (string | number)[] | undefined) => moment.Moment -``` -Import - -```typescript -import { dateTimeAsMoment } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimebuiltinformat.md b/docs/sources/packages_api/data/datetimebuiltinformat.md deleted file mode 100644 index f9ea17358a3..00000000000 --- a/docs/sources/packages_api/data/datetimebuiltinformat.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeBuiltinFormat" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeBuiltinFormat interface - -Signature - -```typescript -export interface DateTimeBuiltinFormat -``` -Import - -```typescript -import { DateTimeBuiltinFormat } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_\_momentBuiltinFormatBrand](#__momentbuiltinformatbrand-property) | any | | - -### \_\_momentBuiltinFormatBrand property - -Signature - -```typescript -__momentBuiltinFormatBrand: any; -``` diff --git a/docs/sources/packages_api/data/datetimeduration.md b/docs/sources/packages_api/data/datetimeduration.md deleted file mode 100644 index 4b45d3a2353..00000000000 --- a/docs/sources/packages_api/data/datetimeduration.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeDuration" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeDuration interface - -Signature - -```typescript -export interface DateTimeDuration -``` -Import - -```typescript -import { DateTimeDuration } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asHours](#ashours-property) | () => number | | -| [asSeconds](#asseconds-property) | () => number | | -| [hours](#hours-property) | () => number | | -| [minutes](#minutes-property) | () => number | | -| [seconds](#seconds-property) | () => number | | - -### asHours property - -Signature - -```typescript -asHours: () => number; -``` - -### asSeconds property - -Signature - -```typescript -asSeconds: () => number; -``` - -### hours property - -Signature - -```typescript -hours: () => number; -``` - -### minutes property - -Signature - -```typescript -minutes: () => number; -``` - -### seconds property - -Signature - -```typescript -seconds: () => number; -``` diff --git a/docs/sources/packages_api/data/datetimeformat.md b/docs/sources/packages_api/data/datetimeformat.md deleted file mode 100644 index e1a5285aec9..00000000000 --- a/docs/sources/packages_api/data/datetimeformat.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeFormat" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeFormat variable - -### dateTimeFormat variable - -Helper function to format date and time according to the specified options. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md). - -Signature - -```typescript -dateTimeFormat: DateTimeFormatter -``` -Import - -```typescript -import { dateTimeFormat } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimeformatiso.md b/docs/sources/packages_api/data/datetimeformatiso.md deleted file mode 100644 index 249bb14850d..00000000000 --- a/docs/sources/packages_api/data/datetimeformatiso.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeFormatISO" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeFormatISO variable - -### dateTimeFormatISO variable - -Helper function to format date and time according to the standard ISO format e.g. 2013-02-04T22:44:30.652Z. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md). - -Signature - -```typescript -dateTimeFormatISO: DateTimeFormatter -``` -Import - -```typescript -import { dateTimeFormatISO } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimeformattimeago.md b/docs/sources/packages_api/data/datetimeformattimeago.md deleted file mode 100644 index 04c2d09e55e..00000000000 --- a/docs/sources/packages_api/data/datetimeformattimeago.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeFormatTimeAgo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeFormatTimeAgo variable - -### dateTimeFormatTimeAgo variable - -Helper function to return elapsed time since passed date. The returned value will be formatted in a human readable format e.g. 4 years ago. If no options are supplied, then default values are used. For more details, see [DateTimeOptions](./data/datetimeoptions.md). - -Signature - -```typescript -dateTimeFormatTimeAgo: DateTimeFormatter -``` -Import - -```typescript -import { dateTimeFormatTimeAgo } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimeformatwithabbrevation.md b/docs/sources/packages_api/data/datetimeformatwithabbrevation.md deleted file mode 100644 index 12a6820417c..00000000000 --- a/docs/sources/packages_api/data/datetimeformatwithabbrevation.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeFormatWithAbbrevation" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeFormatWithAbbrevation variable - -### dateTimeFormatWithAbbrevation variable - -Helper function to format date and time according to the Grafana default formatting, but it also appends the time zone abbreviation at the end e.g. 2020-05-20 13:37:00 CET. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md). - -Signature - -```typescript -dateTimeFormatWithAbbrevation: DateTimeFormatter -``` -Import - -```typescript -import { dateTimeFormatWithAbbrevation } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimefortimezone.md b/docs/sources/packages_api/data/datetimefortimezone.md deleted file mode 100644 index eb143ae6a0f..00000000000 --- a/docs/sources/packages_api/data/datetimefortimezone.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeForTimeZone" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeForTimeZone variable - -### dateTimeForTimeZone variable - -Signature - -```typescript -dateTimeForTimeZone: (timezone?: string | undefined, input?: string | number | DateTime | Date | (string | number)[] | undefined, formatInput?: FormatInput) => DateTime -``` -Import - -```typescript -import { dateTimeForTimeZone } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimeinput.md b/docs/sources/packages_api/data/datetimeinput.md deleted file mode 100644 index d73b6739ce4..00000000000 --- a/docs/sources/packages_api/data/datetimeinput.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeInput" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeInput type - -### DateTimeInput type - -Signature - -```typescript -export declare type DateTimeInput = Date | string | number | Array | DateTime; -``` -Import - -```typescript -import { DateTimeInput } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/datetimelocale.md b/docs/sources/packages_api/data/datetimelocale.md deleted file mode 100644 index b0a1677e1f6..00000000000 --- a/docs/sources/packages_api/data/datetimelocale.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeLocale" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeLocale interface - -Signature - -```typescript -export interface DateTimeLocale -``` -Import - -```typescript -import { DateTimeLocale } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [firstDayOfWeek](#firstdayofweek-property) | () => number | | - -### firstDayOfWeek property - -Signature - -```typescript -firstDayOfWeek: () => number; -``` diff --git a/docs/sources/packages_api/data/datetimeoptions.md b/docs/sources/packages_api/data/datetimeoptions.md deleted file mode 100644 index bed7108050c..00000000000 --- a/docs/sources/packages_api/data/datetimeoptions.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeOptions interface - -The type describing date and time options. Used for all the helper functions available to parse or format date and time values. - -Signature - -```typescript -export interface DateTimeOptions -``` -Import - -```typescript -import { DateTimeOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [timeZone](#timezone-property) | TimeZone | Specify this if you want to override the timeZone used when parsing or formatting a date and time value. If no timeZone is set, the default timeZone for the current user is used. | - -### timeZone property - -Specify this if you want to override the timeZone used when parsing or formatting a date and time value. If no timeZone is set, the default timeZone for the current user is used. - -Signature - -```typescript -timeZone?: TimeZone; -``` diff --git a/docs/sources/packages_api/data/datetimeoptionswhenparsing.md b/docs/sources/packages_api/data/datetimeoptionswhenparsing.md deleted file mode 100644 index 065f5d6d7ad..00000000000 --- a/docs/sources/packages_api/data/datetimeoptionswhenparsing.md +++ /dev/null @@ -1,40 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeOptionsWhenParsing" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeOptionsWhenParsing interface - -The type that describes options that can be passed when parsing a date and time value. - -Signature - -```typescript -export interface DateTimeOptionsWhenParsing extends DateTimeOptions -``` -Import - -```typescript -import { DateTimeOptionsWhenParsing } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [roundUp](#roundup-property) | boolean | If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00. | - -### roundUp property - -If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded. - -Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00. - -Signature - -```typescript -roundUp?: boolean; -``` diff --git a/docs/sources/packages_api/data/datetimeoptionswithformat.md b/docs/sources/packages_api/data/datetimeoptionswithformat.md deleted file mode 100644 index 853990899a9..00000000000 --- a/docs/sources/packages_api/data/datetimeoptionswithformat.md +++ /dev/null @@ -1,49 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DateTimeOptionsWithFormat" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DateTimeOptionsWithFormat interface - -The type describing the options that can be passed to the [dateTimeFormat](./data/datetimeformat.md) helper function to control how the date and time value passed to the function is formatted. - -Signature - -```typescript -export interface DateTimeOptionsWithFormat extends DateTimeOptions -``` -Import - -```typescript -import { DateTimeOptionsWithFormat } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultWithMS](#defaultwithms-property) | boolean | Set this value to true if you want to include milliseconds when formatting date and time values in the default [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) format. | -| [format](#format-property) | string | Specify a [momentjs](https://momentjs.com/docs/#/displaying/format) format to use a custom formatting pattern of the date and time value. If no format is set, then [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) is used. | - -### defaultWithMS property - -Set this value to `true` if you want to include milliseconds when formatting date and time values in the default [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) format. - -Signature - -```typescript -defaultWithMS?: boolean; -``` - -### format property - -Specify a [momentjs](https://momentjs.com/docs/#/displaying/format) format to use a custom formatting pattern of the date and time value. If no format is set, then [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) is used. - -Signature - -```typescript -format?: string; -``` diff --git a/docs/sources/packages_api/data/datetimeparse.md b/docs/sources/packages_api/data/datetimeparse.md deleted file mode 100644 index fc428ac6ddf..00000000000 --- a/docs/sources/packages_api/data/datetimeparse.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dateTimeParse" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## dateTimeParse variable - -### dateTimeParse variable - -Helper function to parse a number, text or Date to a DateTime value. If a timeZone is supplied the incoming value is parsed with that timeZone as a base. The only exception to this is if the passed value is in a UTC-based format. Then it will use UTC as the base. Examples on UTC-based values are Unix epoch and ISO formatted strings. - -It can also parse the Grafana quick date and time format, e.g. now-6h will be parsed as Date.now() - 6 hours and returned as a valid DateTime value. - -If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md). - -Signature - -```typescript -dateTimeParse: DateTimeParser -``` -Import - -```typescript -import { dateTimeParse } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/decimalcount.md b/docs/sources/packages_api/data/decimalcount.md deleted file mode 100644 index 2531ff7aa51..00000000000 --- a/docs/sources/packages_api/data/decimalcount.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DecimalCount" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DecimalCount type - -### DecimalCount type - -Signature - -```typescript -export declare type DecimalCount = number | null | undefined; -``` -Import - -```typescript -import { DecimalCount } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/decimalinfo.md b/docs/sources/packages_api/data/decimalinfo.md deleted file mode 100644 index 94499c87f82..00000000000 --- a/docs/sources/packages_api/data/decimalinfo.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DecimalInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DecimalInfo interface - -Signature - -```typescript -export interface DecimalInfo -``` -Import - -```typescript -import { DecimalInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [decimals](#decimals-property) | DecimalCount | | -| [scaledDecimals](#scaleddecimals-property) | DecimalCount | | - -### decimals property - -Signature - -```typescript -decimals: DecimalCount; -``` - -### scaledDecimals property - -Signature - -```typescript -scaledDecimals: DecimalCount; -``` diff --git a/docs/sources/packages_api/data/default_date_time_format.md b/docs/sources/packages_api/data/default_date_time_format.md deleted file mode 100644 index 46a8035310b..00000000000 --- a/docs/sources/packages_api/data/default_date_time_format.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# 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" -+++ - -## DEFAULT\_DATE\_TIME\_FORMAT variable - -### DEFAULT\_DATE\_TIME\_FORMAT variable - -Signature - -```typescript -DEFAULT_DATE_TIME_FORMAT = "YYYY-MM-DD HH:mm:ss" -``` -Import - -```typescript -import { DEFAULT_DATE_TIME_FORMAT } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/default_field_display_values_limit.md b/docs/sources/packages_api/data/default_field_display_values_limit.md deleted file mode 100644 index 2d892d4f7b4..00000000000 --- a/docs/sources/packages_api/data/default_field_display_values_limit.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# 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" -+++ - -## DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT variable - -### DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT variable - -Signature - -```typescript -DEFAULT_FIELD_DISPLAY_VALUES_LIMIT = 25 -``` -Import - -```typescript -import { DEFAULT_FIELD_DISPLAY_VALUES_LIMIT } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/defaulttimerange.md b/docs/sources/packages_api/data/defaulttimerange.md deleted file mode 100644 index ba147805011..00000000000 --- a/docs/sources/packages_api/data/defaulttimerange.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DefaultTimeRange" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DefaultTimeRange variable - -### DefaultTimeRange variable - -Signature - -```typescript -DefaultTimeRange: TimeRange -``` -Import - -```typescript -import { DefaultTimeRange } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/defaulttimezone.md b/docs/sources/packages_api/data/defaulttimezone.md deleted file mode 100644 index 1d47c800e9c..00000000000 --- a/docs/sources/packages_api/data/defaulttimezone.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DefaultTimeZone" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DefaultTimeZone variable - -### DefaultTimeZone variable - -Signature - -```typescript -DefaultTimeZone: TimeZone -``` -Import - -```typescript -import { DefaultTimeZone } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/deprecationwarning.md b/docs/sources/packages_api/data/deprecationwarning.md deleted file mode 100644 index cd5cfbf2b78..00000000000 --- a/docs/sources/packages_api/data/deprecationwarning.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "deprecationWarning" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## deprecationWarning variable - -### deprecationWarning variable - -Signature - -```typescript -deprecationWarning: (file: string, oldName: string, newName?: string | undefined) => void -``` -Import - -```typescript -import { deprecationWarning } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/dimension.md b/docs/sources/packages_api/data/dimension.md deleted file mode 100644 index 5015b2459f6..00000000000 --- a/docs/sources/packages_api/data/dimension.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Dimension" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Dimension interface - -Signature - -```typescript -export interface Dimension -``` -Import - -```typescript -import { Dimension } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [columns](#columns-property) | Array<Field<T>> | | -| [name](#name-property) | string | | - -### columns property - -Signature - -```typescript -columns: Array>; -``` - -### name property - -Signature - -```typescript -name: string; -``` diff --git a/docs/sources/packages_api/data/dimensions.md b/docs/sources/packages_api/data/dimensions.md deleted file mode 100644 index e2f05871e58..00000000000 --- a/docs/sources/packages_api/data/dimensions.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Dimensions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Dimensions type - -### Dimensions type - -Signature - -```typescript -export declare type Dimensions = KeyValue; -``` -Import - -```typescript -import { Dimensions } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/displayprocessor.md b/docs/sources/packages_api/data/displayprocessor.md deleted file mode 100644 index 3ec41e8a8d7..00000000000 --- a/docs/sources/packages_api/data/displayprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DisplayProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DisplayProcessor type - -### DisplayProcessor type - -Signature - -```typescript -export declare type DisplayProcessor = (value: any) => DisplayValue; -``` -Import - -```typescript -import { DisplayProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/displayvalue.md b/docs/sources/packages_api/data/displayvalue.md deleted file mode 100644 index 68aefee49d9..00000000000 --- a/docs/sources/packages_api/data/displayvalue.md +++ /dev/null @@ -1,67 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DisplayValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DisplayValue interface - -Signature - -```typescript -export interface DisplayValue extends FormattedValue -``` -Import - -```typescript -import { DisplayValue } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | string | Color based on configs or Threshold | -| [numeric](#numeric-property) | number | Use isNaN to check if it is a real number | -| [percent](#percent-property) | number | 0-1 between min & max | -| [title](#title-property) | string | | - -### color property - -Color based on configs or Threshold - -Signature - -```typescript -color?: string; -``` - -### numeric property - -Use isNaN to check if it is a real number - -Signature - -```typescript -numeric: number; -``` - -### percent property - -0-1 between min & max - -Signature - -```typescript -percent?: number; -``` - -### title property - -Signature - -```typescript -title?: string; -``` diff --git a/docs/sources/packages_api/data/displayvaluealignmentfactors.md b/docs/sources/packages_api/data/displayvaluealignmentfactors.md deleted file mode 100644 index 9ba728f4281..00000000000 --- a/docs/sources/packages_api/data/displayvaluealignmentfactors.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DisplayValueAlignmentFactors" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DisplayValueAlignmentFactors interface - -These represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues - -Signature - -```typescript -export interface DisplayValueAlignmentFactors extends FormattedValue -``` -Import - -```typescript -import { DisplayValueAlignmentFactors } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [title](#title-property) | string | | - -### title property - -Signature - -```typescript -title: string; -``` diff --git a/docs/sources/packages_api/data/dostandardcalcs.md b/docs/sources/packages_api/data/dostandardcalcs.md deleted file mode 100644 index 434d59b4927..00000000000 --- a/docs/sources/packages_api/data/dostandardcalcs.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "doStandardCalcs" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## doStandardCalcs() function - -### doStandardCalcs() function - -Signature - -```typescript -export declare function doStandardCalcs(field: Field, ignoreNulls: boolean, nullAsZero: boolean): FieldCalcs; -``` -Import - -```typescript -import { doStandardCalcs } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| field | Field | | -| ignoreNulls | boolean | | -| nullAsZero | boolean | | - -Returns: - -`FieldCalcs` - diff --git a/docs/sources/packages_api/data/durationinput.md b/docs/sources/packages_api/data/durationinput.md deleted file mode 100644 index b38cb9b038e..00000000000 --- a/docs/sources/packages_api/data/durationinput.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DurationInput" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DurationInput type - -### DurationInput type - -Signature - -```typescript -export declare type DurationInput = string | number | DateTimeDuration; -``` -Import - -```typescript -import { DurationInput } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/durationunit.md b/docs/sources/packages_api/data/durationunit.md deleted file mode 100644 index f880a9afa6a..00000000000 --- a/docs/sources/packages_api/data/durationunit.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DurationUnit" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DurationUnit type - -### DurationUnit type - -Signature - -```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'; -``` -Import - -```typescript -import { DurationUnit } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/dynamicconfigvalue.md b/docs/sources/packages_api/data/dynamicconfigvalue.md deleted file mode 100644 index 4991389a95a..00000000000 --- a/docs/sources/packages_api/data/dynamicconfigvalue.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DynamicConfigValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## DynamicConfigValue interface - -Signature - -```typescript -export interface DynamicConfigValue -``` -Import - -```typescript -import { DynamicConfigValue } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](#id-property) | string | | -| [value](#value-property) | any | | - -### id property - -Signature - -```typescript -id: string; -``` - -### value property - -Signature - -```typescript -value?: any; -``` diff --git a/docs/sources/packages_api/data/escapestringforregex.md b/docs/sources/packages_api/data/escapestringforregex.md deleted file mode 100644 index bb2fb702a25..00000000000 --- a/docs/sources/packages_api/data/escapestringforregex.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "escapeStringForRegex" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## escapeStringForRegex variable - -### escapeStringForRegex variable - -Signature - -```typescript -escapeStringForRegex: (value: string) => string -``` -Import - -```typescript -import { escapeStringForRegex } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/eventfactory.md b/docs/sources/packages_api/data/eventfactory.md deleted file mode 100644 index 1a85d4ddf18..00000000000 --- a/docs/sources/packages_api/data/eventfactory.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "eventFactory" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## eventFactory() function - -### eventFactory() function - -Signature - -```typescript -export declare function eventFactory(name: string): AppEvent; -``` -Import - -```typescript -import { eventFactory } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -`AppEvent` - diff --git a/docs/sources/packages_api/data/exploremode.md b/docs/sources/packages_api/data/exploremode.md deleted file mode 100644 index ee184fbc3c3..00000000000 --- a/docs/sources/packages_api/data/exploremode.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ExploreMode" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ExploreMode enum - -### ExploreMode enum - -Signature - -```typescript -export declare enum ExploreMode -``` -Import - -```typescript -import { ExploreMode } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Logs | "Logs" | | -| Metrics | "Metrics" | | -| Tracing | "Tracing" | | - diff --git a/docs/sources/packages_api/data/explorequeryfieldprops.md b/docs/sources/packages_api/data/explorequeryfieldprops.md deleted file mode 100644 index a2ea4465a5f..00000000000 --- a/docs/sources/packages_api/data/explorequeryfieldprops.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ExploreQueryFieldProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ExploreQueryFieldProps interface - -Signature - -```typescript -export interface ExploreQueryFieldProps, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> extends QueryEditorProps -``` -Import - -```typescript -import { ExploreQueryFieldProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [absoluteRange](#absoluterange-property) | AbsoluteTimeRange | | -| [exploreId](#exploreid-property) | any | | -| [exploreMode](#exploremode-property) | ExploreMode | | -| [history](#history-property) | any[] | | -| [onBlur](#onblur-property) | () => void | | - -### absoluteRange property - -Signature - -```typescript -absoluteRange?: AbsoluteTimeRange; -``` - -### exploreId property - -Signature - -```typescript -exploreId?: any; -``` - -### exploreMode property - -Signature - -```typescript -exploreMode?: ExploreMode; -``` - -### history property - -Signature - -```typescript -history: any[]; -``` - -### onBlur property - -Signature - -```typescript -onBlur?: () => void; -``` diff --git a/docs/sources/packages_api/data/explorestartpageprops.md b/docs/sources/packages_api/data/explorestartpageprops.md deleted file mode 100644 index 44e07e26a15..00000000000 --- a/docs/sources/packages_api/data/explorestartpageprops.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ExploreStartPageProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ExploreStartPageProps interface - -Signature - -```typescript -export interface ExploreStartPageProps -``` -Import - -```typescript -import { ExploreStartPageProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [datasource](#datasource-property) | DataSourceApi | | -| [exploreId](#exploreid-property) | any | | -| [exploreMode](#exploremode-property) | ExploreMode | | -| [onClickExample](#onclickexample-property) | (query: DataQuery) => void | | - -### datasource property - -Signature - -```typescript -datasource?: DataSourceApi; -``` - -### exploreId property - -Signature - -```typescript -exploreId?: any; -``` - -### exploreMode property - -Signature - -```typescript -exploreMode: ExploreMode; -``` - -### onClickExample property - -Signature - -```typescript -onClickExample: (query: DataQuery) => void; -``` diff --git a/docs/sources/packages_api/data/featuretoggles.md b/docs/sources/packages_api/data/featuretoggles.md deleted file mode 100644 index f3885f734fb..00000000000 --- a/docs/sources/packages_api/data/featuretoggles.md +++ /dev/null @@ -1,85 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FeatureToggles" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FeatureToggles interface - -Describes available feature toggles in Grafana. These can be configured via the `conf/custom.ini` to enable features under development or not yet available in stable version. - -Signature - -```typescript -export interface FeatureToggles -``` -Import - -```typescript -import { FeatureToggles } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [datasourceInsights](#datasourceinsights-property) | boolean | | -| [expressions](#expressions-property) | boolean | | -| [meta](#meta-property) | boolean | | -| [newEdit](#newedit-property) | boolean | | -| [reportGrid](#reportgrid-property) | boolean | | -| [transformations](#transformations-property) | boolean | | - -### datasourceInsights property - -Signature - -```typescript -datasourceInsights: boolean; -``` - -### expressions property - -Signature - -```typescript -expressions: boolean; -``` - -### meta property - -Signature - -```typescript -meta: boolean; -``` - -## Remarks - -Available only in Grafana Enterprise - -### newEdit property - -Signature - -```typescript -newEdit: boolean; -``` - -### reportGrid property - -Signature - -```typescript -reportGrid: boolean; -``` - -### transformations property - -Signature - -```typescript -transformations: boolean; -``` diff --git a/docs/sources/packages_api/data/field.md b/docs/sources/packages_api/data/field.md deleted file mode 100644 index 3724b944a7e..00000000000 --- a/docs/sources/packages_api/data/field.md +++ /dev/null @@ -1,120 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Field" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Field interface - -Signature - -```typescript -export interface Field> -``` -Import - -```typescript -import { Field } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](#config-property) | FieldConfig | Meta info about how field and how to display it | -| [display](#display-property) | DisplayProcessor | Convert a value for display | -| [getLinks](#getlinks-property) | (config: ValueLinkConfig) => Array<LinkModel<Field>> | Get value data links with variables interpolated | -| [labels](#labels-property) | Labels | | -| [name](#name-property) | string | Name of the field (column) | -| [parse](#parse-property) | (value: any) => T | Convert text to the field value | -| [state](#state-property) | FieldState | null | Cached values with appropriate display and id values | -| [type](#type-property) | FieldType | Field value type (string, number, etc) | -| [values](#values-property) | V | | - -### config property - -Meta info about how field and how to display it - -Signature - -```typescript -config: FieldConfig; -``` - -### display property - -Convert a value for display - -Signature - -```typescript -display?: DisplayProcessor; -``` - -### getLinks property - -Get value data links with variables interpolated - -Signature - -```typescript -getLinks?: (config: ValueLinkConfig) => Array>; -``` - -### labels property - -Signature - -```typescript -labels?: Labels; -``` - -### name property - -Name of the field (column) - -Signature - -```typescript -name: string; -``` - -### parse property - -Convert text to the field value - -Signature - -```typescript -parse?: (value: any) => T; -``` - -### state property - -Cached values with appropriate display and id values - -Signature - -```typescript -state?: FieldState | null; -``` - -### type property - -Field value type (string, number, etc) - -Signature - -```typescript -type: FieldType; -``` - -### values property - -Signature - -```typescript -values: V; -``` diff --git a/docs/sources/packages_api/data/fieldcache.md b/docs/sources/packages_api/data/fieldcache.md deleted file mode 100644 index 71139d3f489..00000000000 --- a/docs/sources/packages_api/data/fieldcache.md +++ /dev/null @@ -1,173 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldCache" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldCache class - -Signature - -```typescript -export declare class FieldCache -``` -Import - -```typescript -import { FieldCache } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(data)](#constructor-data) | | Constructs a new instance of the FieldCache class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [fields](#fields-property) | | FieldWithIndex[] | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [getFieldByName(name)](#getfieldbyname-method) | | Returns the first field with the given name. | -| [getFields(type)](#getfields-method) | | | -| [getFirstFieldOfType(type, includeHidden)](#getfirstfieldoftype-method) | | | -| [hasFieldNamed(name)](#hasfieldnamed-method) | | | -| [hasFieldOfType(type)](#hasfieldoftype-method) | | | -| [hasFieldWithNameAndType(name, type)](#hasfieldwithnameandtype-method) | | | - -### constructor(data) - -Constructs a new instance of the `FieldCache` class - -Signature - -```typescript -constructor(data: DataFrame); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame | | - -### fields property - -Signature - -```typescript -fields: FieldWithIndex[]; -``` - -### getFieldByName method - -Returns the first field with the given name. - -Signature - -```typescript -getFieldByName(name: string): FieldWithIndex | undefined; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -`FieldWithIndex | undefined` - -### getFields method - -Signature - -```typescript -getFields(type?: FieldType): FieldWithIndex[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | FieldType | | - -Returns: - -`FieldWithIndex[]` - -### getFirstFieldOfType method - -Signature - -```typescript -getFirstFieldOfType(type: FieldType, includeHidden?: boolean): FieldWithIndex | undefined; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | FieldType | | -| includeHidden | boolean | | - -Returns: - -`FieldWithIndex | undefined` - -### hasFieldNamed method - -Signature - -```typescript -hasFieldNamed(name: string): boolean; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -`boolean` - -### hasFieldOfType method - -Signature - -```typescript -hasFieldOfType(type: FieldType): boolean; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | FieldType | | - -Returns: - -`boolean` - -### hasFieldWithNameAndType method - -Signature - -```typescript -hasFieldWithNameAndType(name: string, type: FieldType): boolean; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| type | FieldType | | - -Returns: - -`boolean` - diff --git a/docs/sources/packages_api/data/fieldcalcs.md b/docs/sources/packages_api/data/fieldcalcs.md deleted file mode 100644 index 7b0ee527201..00000000000 --- a/docs/sources/packages_api/data/fieldcalcs.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldCalcs" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldCalcs interface - -Signature - -```typescript -export interface FieldCalcs extends Record -``` -Import - -```typescript -import { FieldCalcs } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/fieldcolor.md b/docs/sources/packages_api/data/fieldcolor.md deleted file mode 100644 index 6dc4adf83fc..00000000000 --- a/docs/sources/packages_api/data/fieldcolor.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldColor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldColor interface - -Signature - -```typescript -export interface FieldColor -``` -Import - -```typescript -import { FieldColor } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fixedColor](#fixedcolor-property) | string | | -| [mode](#mode-property) | FieldColorMode | | -| [schemeName](#schemename-property) | ColorScheme | | - -### fixedColor property - -Signature - -```typescript -fixedColor?: string; -``` - -### mode property - -Signature - -```typescript -mode: FieldColorMode; -``` - -### schemeName property - -Signature - -```typescript -schemeName?: ColorScheme; -``` diff --git a/docs/sources/packages_api/data/fieldcolormode.md b/docs/sources/packages_api/data/fieldcolormode.md deleted file mode 100644 index 32da95b1261..00000000000 --- a/docs/sources/packages_api/data/fieldcolormode.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldColorMode" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldColorMode enum - -### FieldColorMode enum - -Signature - -```typescript -export declare enum FieldColorMode -``` -Import - -```typescript -import { FieldColorMode } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Fixed | "fixed" | | -| Scheme | "scheme" | | -| Thresholds | "thresholds" | | - diff --git a/docs/sources/packages_api/data/fieldconfig.md b/docs/sources/packages_api/data/fieldconfig.md deleted file mode 100644 index 64f17b3a5ad..00000000000 --- a/docs/sources/packages_api/data/fieldconfig.md +++ /dev/null @@ -1,146 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfig interface - -Every property is optional - -Plugins may extend this with additional properties. Something like series overrides - -Signature - -```typescript -export interface FieldConfig -``` -Import - -```typescript -import { FieldConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | FieldColor | | -| [custom](#custom-property) | TOptions | | -| [decimals](#decimals-property) | number | null | | -| [displayName](#displayname-property) | string | | -| [filterable](#filterable-property) | boolean | | -| [links](#links-property) | DataLink[] | | -| [mappings](#mappings-property) | ValueMapping[] | | -| [max](#max-property) | number | null | | -| [min](#min-property) | number | null | | -| [noValue](#novalue-property) | string | | -| [nullValueMode](#nullvaluemode-property) | NullValueMode | | -| [thresholds](#thresholds-property) | ThresholdsConfig | | -| [unit](#unit-property) | string | | - -### color property - -Signature - -```typescript -color?: FieldColor; -``` - -### custom property - -Signature - -```typescript -custom?: TOptions; -``` - -### decimals property - -Signature - -```typescript -decimals?: number | null; -``` - -### displayName property - -Signature - -```typescript -displayName?: string; -``` - -### filterable property - -Signature - -```typescript -filterable?: boolean; -``` - -### links property - -Signature - -```typescript -links?: DataLink[]; -``` - -### mappings property - -Signature - -```typescript -mappings?: ValueMapping[]; -``` - -### max property - -Signature - -```typescript -max?: number | null; -``` - -### min property - -Signature - -```typescript -min?: number | null; -``` - -### noValue property - -Signature - -```typescript -noValue?: string; -``` - -### nullValueMode property - -Signature - -```typescript -nullValueMode?: NullValueMode; -``` - -### thresholds property - -Signature - -```typescript -thresholds?: ThresholdsConfig; -``` - -### unit property - -Signature - -```typescript -unit?: string; -``` diff --git a/docs/sources/packages_api/data/fieldconfigeditorbuilder.md b/docs/sources/packages_api/data/fieldconfigeditorbuilder.md deleted file mode 100644 index 499640c22b6..00000000000 --- a/docs/sources/packages_api/data/fieldconfigeditorbuilder.md +++ /dev/null @@ -1,154 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigEditorBuilder" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigEditorBuilder class - -Fluent API for declarative creation of field config option editors - -Signature - -```typescript -export declare class FieldConfigEditorBuilder extends OptionsUIRegistryBuilder, FieldConfigPropertyItem> -``` -Import - -```typescript -import { FieldConfigEditorBuilder } from '@grafana/data'; -``` -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addBooleanSwitch(config)](#addbooleanswitch-method) | | | -| [addColorPicker(config)](#addcolorpicker-method) | | | -| [addNumberInput(config)](#addnumberinput-method) | | | -| [addRadio(config)](#addradio-method) | | | -| [addSelect(config)](#addselect-method) | | | -| [addTextInput(config)](#addtextinput-method) | | | -| [addUnitPicker(config)](#addunitpicker-method) | | | - -### addBooleanSwitch method - -Signature - -```typescript -addBooleanSwitch(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings, boolean> | | - -Returns: - -`this` - -### addColorPicker method - -Signature - -```typescript -addColorPicker(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string> | | - -Returns: - -`this` - -### addNumberInput method - -Signature - -```typescript -addNumberInput(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number> | | - -Returns: - -`this` - -### addRadio method - -Signature - -```typescript -addRadio(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings, TOption> | | - -Returns: - -`this` - -### addSelect method - -Signature - -```typescript -addSelect>(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings, TOption> | | - -Returns: - -`this` - -### addTextInput method - -Signature - -```typescript -addTextInput(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string> | | - -Returns: - -`this` - -### addUnitPicker method - -Signature - -```typescript -addUnitPicker(config: FieldConfigEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfigEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string> | | - -Returns: - -`this` - diff --git a/docs/sources/packages_api/data/fieldconfigeditorconfig.md b/docs/sources/packages_api/data/fieldconfigeditorconfig.md deleted file mode 100644 index 242c82aded4..00000000000 --- a/docs/sources/packages_api/data/fieldconfigeditorconfig.md +++ /dev/null @@ -1,125 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigEditorConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigEditorConfig interface - -Signature - -```typescript -export interface FieldConfigEditorConfig -``` -Import - -```typescript -import { FieldConfigEditorConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category](#category-property) | string[] | Array of strings representing category of the field config property. First element in the array will make option render as collapsible section. | -| [defaultValue](#defaultvalue-property) | TValue | | -| [description](#description-property) | string | Description of the field config property. Will be displayed in the UI as form element description. | -| [name](#name-property) | string | Name of the field config property. Will be displayed in the UI as form element label. | -| [path](#path-property) | (keyof TOptions & string) | string | Path of the field config property to control. | -| [settings](#settings-property) | TSettings | Custom settings of the editor. | -| [shouldApply](#shouldapply-property) | (field: Field) => boolean | Function that allows specifying whether or not this field config should apply to a given field. | -| [showIf](#showif-property) | (currentConfig: TOptions) => boolean | Function that enables configuration of when field config property editor should be shown based on current panel field config. | - -### category property - -Array of strings representing category of the field config property. First element in the array will make option render as collapsible section. - -Signature - -```typescript -category?: string[]; -``` - -### defaultValue property - -Signature - -```typescript -defaultValue?: TValue; -``` - -### description property - -Description of the field config property. Will be displayed in the UI as form element description. - -Signature - -```typescript -description?: string; -``` - -### name property - -Name of the field config property. Will be displayed in the UI as form element label. - -Signature - -```typescript -name: string; -``` - -### path property - -Path of the field config property to control. - -Signature - -```typescript -path: (keyof TOptions & string) | string; -``` - -## Example - -Given field config object of a type: - -```ts -interface CustomFieldConfig { - a: { - b: string; - } -} - -``` -path can be either 'a' or 'a.b'. - -### settings property - -Custom settings of the editor. - -Signature - -```typescript -settings?: TSettings; -``` - -### shouldApply property - -Function that allows specifying whether or not this field config should apply to a given field. - -Signature - -```typescript -shouldApply?: (field: Field) => boolean; -``` - -### showIf property - -Function that enables configuration of when field config property editor should be shown based on current panel field config. - -Signature - -```typescript -showIf?: (currentConfig: TOptions) => boolean; -``` diff --git a/docs/sources/packages_api/data/fieldconfigeditorprops.md b/docs/sources/packages_api/data/fieldconfigeditorprops.md deleted file mode 100644 index 442f725cbac..00000000000 --- a/docs/sources/packages_api/data/fieldconfigeditorprops.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigEditorProps interface - -Signature - -```typescript -export interface FieldConfigEditorProps extends Omit, 'item'> -``` -Import - -```typescript -import { FieldConfigEditorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](#context-property) | FieldOverrideContext | | -| [item](#item-property) | FieldConfigPropertyItem<TValue, TSettings> | | -| [onChange](#onchange-property) | (value?: TValue) => void | | -| [value](#value-property) | TValue | | - -### context property - -Signature - -```typescript -context: FieldOverrideContext; -``` - -### item property - -Signature - -```typescript -item: FieldConfigPropertyItem; -``` - -### onChange property - -Signature - -```typescript -onChange: (value?: TValue) => void; -``` - -### value property - -Signature - -```typescript -value: TValue; -``` diff --git a/docs/sources/packages_api/data/fieldconfigoptionsregistry.md b/docs/sources/packages_api/data/fieldconfigoptionsregistry.md deleted file mode 100644 index e6c5c71baa4..00000000000 --- a/docs/sources/packages_api/data/fieldconfigoptionsregistry.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigOptionsRegistry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigOptionsRegistry class - -Signature - -```typescript -export declare class FieldConfigOptionsRegistry extends Registry -``` -Import - -```typescript -import { FieldConfigOptionsRegistry } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/fieldconfigproperty.md b/docs/sources/packages_api/data/fieldconfigproperty.md deleted file mode 100644 index 2277aabbda7..00000000000 --- a/docs/sources/packages_api/data/fieldconfigproperty.md +++ /dev/null @@ -1,39 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigProperty" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigProperty enum - -### FieldConfigProperty enum - -Signature - -```typescript -export declare enum FieldConfigProperty -``` -Import - -```typescript -import { FieldConfigProperty } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Color | "color" | | -| Decimals | "decimals" | | -| Links | "links" | | -| Mappings | "mappings" | | -| Max | "max" | | -| Min | "min" | | -| NoValue | "noValue" | | -| Thresholds | "thresholds" | | -| Title | "title" | | -| Unit | "unit" | | - diff --git a/docs/sources/packages_api/data/fieldconfigpropertyitem.md b/docs/sources/packages_api/data/fieldconfigpropertyitem.md deleted file mode 100644 index 26b75b21ebb..00000000000 --- a/docs/sources/packages_api/data/fieldconfigpropertyitem.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigPropertyItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigPropertyItem interface - -Signature - -```typescript -export interface FieldConfigPropertyItem extends OptionsEditorItem, TValue> -``` -Import - -```typescript -import { FieldConfigPropertyItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isCustom](#iscustom-property) | boolean | true for plugin field config properties | -| [override](#override-property) | ComponentType<FieldOverrideEditorProps<TValue, TSettings>> | | -| [process](#process-property) | (value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null | | -| [shouldApply](#shouldapply-property) | (field: Field) => boolean | | - -### isCustom property - -true for plugin field config properties - -Signature - -```typescript -isCustom?: boolean; -``` - -### override property - -Signature - -```typescript -override: ComponentType>; -``` - -### process property - -Signature - -```typescript -process: (value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null; -``` - -### shouldApply property - -Signature - -```typescript -shouldApply: (field: Field) => boolean; -``` diff --git a/docs/sources/packages_api/data/fieldconfigsource.md b/docs/sources/packages_api/data/fieldconfigsource.md deleted file mode 100644 index bea2f3e9144..00000000000 --- a/docs/sources/packages_api/data/fieldconfigsource.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigSource" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldConfigSource interface - -Signature - -```typescript -export interface FieldConfigSource -``` -Import - -```typescript -import { FieldConfigSource } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaults](#defaults-property) | FieldConfig<TOptions> | | -| [overrides](#overrides-property) | ConfigOverrideRule[] | | - -### defaults property - -Signature - -```typescript -defaults: FieldConfig; -``` - -### overrides property - -Signature - -```typescript -overrides: ConfigOverrideRule[]; -``` diff --git a/docs/sources/packages_api/data/fielddisplay.md b/docs/sources/packages_api/data/fielddisplay.md deleted file mode 100644 index 6fa6addb3d7..00000000000 --- a/docs/sources/packages_api/data/fielddisplay.md +++ /dev/null @@ -1,106 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldDisplay" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldDisplay interface - -Signature - -```typescript -export interface FieldDisplay -``` -Import - -```typescript -import { FieldDisplay } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [colIndex](#colindex-property) | number | | -| [display](#display-property) | DisplayValue | | -| [field](#field-property) | FieldConfig | | -| [getLinks](#getlinks-property) | () => LinkModel[] | | -| [hasLinks](#haslinks-property) | boolean | | -| [name](#name-property) | string | | -| [rowIndex](#rowindex-property) | number | | -| [sparkline](#sparkline-property) | GraphSeriesValue[][] | | -| [view](#view-property) | DataFrameView | | - -### colIndex property - -Signature - -```typescript -colIndex?: number; -``` - -### display property - -Signature - -```typescript -display: DisplayValue; -``` - -### field property - -Signature - -```typescript -field: FieldConfig; -``` - -### getLinks property - -Signature - -```typescript -getLinks?: () => LinkModel[]; -``` - -### hasLinks property - -Signature - -```typescript -hasLinks: boolean; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### rowIndex property - -Signature - -```typescript -rowIndex?: number; -``` - -### sparkline property - -Signature - -```typescript -sparkline?: GraphSeriesValue[][]; -``` - -### view property - -Signature - -```typescript -view?: DataFrameView; -``` diff --git a/docs/sources/packages_api/data/fielddto.md b/docs/sources/packages_api/data/fielddto.md deleted file mode 100644 index f88abb359d4..00000000000 --- a/docs/sources/packages_api/data/fielddto.md +++ /dev/null @@ -1,72 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldDTO" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldDTO interface - -Like a field, but properties are optional and values may be a simple array - -Signature - -```typescript -export interface FieldDTO -``` -Import - -```typescript -import { FieldDTO } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](#config-property) | FieldConfig | | -| [labels](#labels-property) | Labels | | -| [name](#name-property) | string | | -| [type](#type-property) | FieldType | | -| [values](#values-property) | Vector<T> | T[] | | - -### config property - -Signature - -```typescript -config?: FieldConfig; -``` - -### labels property - -Signature - -```typescript -labels?: Labels; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### type property - -Signature - -```typescript -type?: FieldType; -``` - -### values property - -Signature - -```typescript -values?: Vector | T[]; -``` diff --git a/docs/sources/packages_api/data/fieldmatcher.md b/docs/sources/packages_api/data/fieldmatcher.md deleted file mode 100644 index 79c60405852..00000000000 --- a/docs/sources/packages_api/data/fieldmatcher.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldMatcher" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldMatcher type - -### FieldMatcher type - -Signature - -```typescript -export declare type FieldMatcher = (field: Field, frame: DataFrame, allFrames: DataFrame[]) => boolean; -``` -Import - -```typescript -import { FieldMatcher } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/fieldmatcherid.md b/docs/sources/packages_api/data/fieldmatcherid.md deleted file mode 100644 index 88ca01af8e4..00000000000 --- a/docs/sources/packages_api/data/fieldmatcherid.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldMatcherID" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldMatcherID enum - -### FieldMatcherID enum - -Signature - -```typescript -export declare enum FieldMatcherID -``` -Import - -```typescript -import { FieldMatcherID } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| byName | "byName" | | -| byNames | "byNames" | | -| byRegexp | "byRegexp" | | -| byRegexpOrNames | "byRegexpOrNames" | | -| byType | "byType" | | -| numeric | "numeric" | | -| time | "time" | | - diff --git a/docs/sources/packages_api/data/fieldmatcherinfo.md b/docs/sources/packages_api/data/fieldmatcherinfo.md deleted file mode 100644 index 0fa1cd68831..00000000000 --- a/docs/sources/packages_api/data/fieldmatcherinfo.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldMatcherInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldMatcherInfo interface - -Signature - -```typescript -export interface FieldMatcherInfo extends RegistryItemWithOptions -``` -Import - -```typescript -import { FieldMatcherInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](#get-property) | (options: TOptions) => FieldMatcher | | - -### get property - -Signature - -```typescript -get: (options: TOptions) => FieldMatcher; -``` diff --git a/docs/sources/packages_api/data/fieldmatchers.md b/docs/sources/packages_api/data/fieldmatchers.md deleted file mode 100644 index 0ba2dd896e6..00000000000 --- a/docs/sources/packages_api/data/fieldmatchers.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "fieldMatchers" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## fieldMatchers variable - -### fieldMatchers variable - -Signature - -```typescript -fieldMatchers: Registry> -``` -Import - -```typescript -import { fieldMatchers } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/fieldoverridecontext.md b/docs/sources/packages_api/data/fieldoverridecontext.md deleted file mode 100644 index 79be218d7ad..00000000000 --- a/docs/sources/packages_api/data/fieldoverridecontext.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldOverrideContext" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldOverrideContext interface - -Signature - -```typescript -export interface FieldOverrideContext extends StandardEditorContext -``` -Import - -```typescript -import { FieldOverrideContext } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | DataFrame[] | | -| [dataFrameIndex](#dataframeindex-property) | number | | -| [field](#field-property) | Field | | - -### data property - -Signature - -```typescript -data: DataFrame[]; -``` - -### dataFrameIndex property - -Signature - -```typescript -dataFrameIndex?: number; -``` - -### field property - -Signature - -```typescript -field?: Field; -``` diff --git a/docs/sources/packages_api/data/fieldoverrideeditorprops.md b/docs/sources/packages_api/data/fieldoverrideeditorprops.md deleted file mode 100644 index fa3e127c74c..00000000000 --- a/docs/sources/packages_api/data/fieldoverrideeditorprops.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldOverrideEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldOverrideEditorProps interface - -Signature - -```typescript -export interface FieldOverrideEditorProps extends Omit, 'item'> -``` -Import - -```typescript -import { FieldOverrideEditorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](#context-property) | FieldOverrideContext | | -| [item](#item-property) | FieldConfigPropertyItem<TValue, TSettings> | | - -### context property - -Signature - -```typescript -context: FieldOverrideContext; -``` - -### item property - -Signature - -```typescript -item: FieldConfigPropertyItem; -``` diff --git a/docs/sources/packages_api/data/fieldreducerinfo.md b/docs/sources/packages_api/data/fieldreducerinfo.md deleted file mode 100644 index 68d1fe6f426..00000000000 --- a/docs/sources/packages_api/data/fieldreducerinfo.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldReducerInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldReducerInfo interface - -Signature - -```typescript -export interface FieldReducerInfo extends RegistryItem -``` -Import - -```typescript -import { FieldReducerInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [emptyInputResult](#emptyinputresult-property) | any | | -| [reduce](#reduce-property) | FieldReducer | | -| [standard](#standard-property) | boolean | | - -### emptyInputResult property - -Signature - -```typescript -emptyInputResult?: any; -``` - -### reduce property - -Signature - -```typescript -reduce?: FieldReducer; -``` - -### standard property - -Signature - -```typescript -standard: boolean; -``` diff --git a/docs/sources/packages_api/data/fieldreducers.md b/docs/sources/packages_api/data/fieldreducers.md deleted file mode 100644 index cd8fd53d8f4..00000000000 --- a/docs/sources/packages_api/data/fieldreducers.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "fieldReducers" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## fieldReducers variable - -### fieldReducers variable - -Signature - -```typescript -fieldReducers: Registry -``` -Import - -```typescript -import { fieldReducers } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/fieldstate.md b/docs/sources/packages_api/data/fieldstate.md deleted file mode 100644 index 22077163411..00000000000 --- a/docs/sources/packages_api/data/fieldstate.md +++ /dev/null @@ -1,58 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldState" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldState interface - -Signature - -```typescript -export interface FieldState -``` -Import - -```typescript -import { FieldState } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [calcs](#calcs-property) | FieldCalcs | Cache of reduced values | -| [displayName](#displayname-property) | string | null | An appropriate name for the field (does not include frame info) | -| [scopedVars](#scopedvars-property) | ScopedVars | Appropriate values for templating | - -### calcs property - -Cache of reduced values - -Signature - -```typescript -calcs?: FieldCalcs; -``` - -### displayName property - -An appropriate name for the field (does not include frame info) - -Signature - -```typescript -displayName?: string | null; -``` - -### scopedVars property - -Appropriate values for templating - -Signature - -```typescript -scopedVars?: ScopedVars; -``` diff --git a/docs/sources/packages_api/data/fieldtype.md b/docs/sources/packages_api/data/fieldtype.md deleted file mode 100644 index 1216d95d5dd..00000000000 --- a/docs/sources/packages_api/data/fieldtype.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldType enum - -### FieldType enum - -Signature - -```typescript -export declare enum FieldType -``` -Import - -```typescript -import { FieldType } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| boolean | "boolean" | | -| number | "number" | | -| other | "other" | | -| string | "string" | | -| time | "time" | | -| trace | "trace" | | - diff --git a/docs/sources/packages_api/data/fieldwithindex.md b/docs/sources/packages_api/data/fieldwithindex.md deleted file mode 100644 index 37804c54c39..00000000000 --- a/docs/sources/packages_api/data/fieldwithindex.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldWithIndex" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FieldWithIndex interface - -Signature - -```typescript -export interface FieldWithIndex extends Field -``` -Import - -```typescript -import { FieldWithIndex } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [index](#index-property) | number | | - -### index property - -Signature - -```typescript -index: number; -``` diff --git a/docs/sources/packages_api/data/findcommonlabels.md b/docs/sources/packages_api/data/findcommonlabels.md deleted file mode 100644 index e1d2eff8890..00000000000 --- a/docs/sources/packages_api/data/findcommonlabels.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "findCommonLabels" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## findCommonLabels() function - -### findCommonLabels() function - -Returns a map labels that are common to the given label sets. - -Signature - -```typescript -export declare function findCommonLabels(labelsSets: Labels[]): Labels; -``` -Import - -```typescript -import { findCommonLabels } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| labelsSets | Labels[] | | - -Returns: - -`Labels` - diff --git a/docs/sources/packages_api/data/findhighlightchunksintext.md b/docs/sources/packages_api/data/findhighlightchunksintext.md deleted file mode 100644 index 7c54606b604..00000000000 --- a/docs/sources/packages_api/data/findhighlightchunksintext.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "findHighlightChunksInText" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## findHighlightChunksInText() function - -### findHighlightChunksInText() function - -Adapt findMatchesInText for react-highlight-words findChunks handler. See https://github.com/bvaughn/react-highlight-words\#props - -Signature - -```typescript -export declare function findHighlightChunksInText({ searchWords, textToHighlight, }: { - searchWords: string[]; - textToHighlight: string; -}): any[]; -``` -Import - -```typescript -import { findHighlightChunksInText } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { searchWords, textToHighlight, } | {
searchWords: string[];
textToHighlight: string;
} | | - -Returns: - -`any[]` - diff --git a/docs/sources/packages_api/data/findmatchesintext.md b/docs/sources/packages_api/data/findmatchesintext.md deleted file mode 100644 index 767407cc015..00000000000 --- a/docs/sources/packages_api/data/findmatchesintext.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "findMatchesInText" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## findMatchesInText() function - -### findMatchesInText() function - -Returns a list of substring regexp matches. - -Signature - -```typescript -export declare function findMatchesInText(haystack: string, needle: string): TextMatch[]; -``` -Import - -```typescript -import { findMatchesInText } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| haystack | string | | -| needle | string | | - -Returns: - -`TextMatch[]` - diff --git a/docs/sources/packages_api/data/finduniquelabels.md b/docs/sources/packages_api/data/finduniquelabels.md deleted file mode 100644 index 4b424d733d4..00000000000 --- a/docs/sources/packages_api/data/finduniquelabels.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "findUniqueLabels" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## findUniqueLabels() function - -### findUniqueLabels() function - -Returns a map of labels that are in `labels`, but not in `commonLabels`. - -Signature - -```typescript -export declare function findUniqueLabels(labels: Labels | undefined, commonLabels: Labels): Labels; -``` -Import - -```typescript -import { findUniqueLabels } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| labels | Labels | undefined | | -| commonLabels | Labels | | - -Returns: - -`Labels` - diff --git a/docs/sources/packages_api/data/flotdatapoint.md b/docs/sources/packages_api/data/flotdatapoint.md deleted file mode 100644 index 1f7d7988474..00000000000 --- a/docs/sources/packages_api/data/flotdatapoint.md +++ /dev/null @@ -1,79 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FlotDataPoint" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FlotDataPoint interface - -Signature - -```typescript -export interface FlotDataPoint -``` -Import - -```typescript -import { FlotDataPoint } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataIndex](#dataindex-property) | number | | -| [datapoint](#datapoint-property) | number[] | | -| [pageX](#pagex-property) | number | | -| [pageY](#pagey-property) | number | | -| [series](#series-property) | any | | -| [seriesIndex](#seriesindex-property) | number | | - -### dataIndex property - -Signature - -```typescript -dataIndex: number; -``` - -### datapoint property - -Signature - -```typescript -datapoint: number[]; -``` - -### pageX property - -Signature - -```typescript -pageX: number; -``` - -### pageY property - -Signature - -```typescript -pageY: number; -``` - -### series property - -Signature - -```typescript -series: any; -``` - -### seriesIndex property - -Signature - -```typescript -seriesIndex: number; -``` diff --git a/docs/sources/packages_api/data/formatinput.md b/docs/sources/packages_api/data/formatinput.md deleted file mode 100644 index 776459c3880..00000000000 --- a/docs/sources/packages_api/data/formatinput.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FormatInput" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FormatInput type - -### FormatInput type - -Signature - -```typescript -export declare type FormatInput = string | DateTimeBuiltinFormat | undefined; -``` -Import - -```typescript -import { FormatInput } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/formatlabels.md b/docs/sources/packages_api/data/formatlabels.md deleted file mode 100644 index db843914aa1..00000000000 --- a/docs/sources/packages_api/data/formatlabels.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "formatLabels" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## formatLabels() function - -### formatLabels() function - -Serializes the given labels to a string. - -Signature - -```typescript -export declare function formatLabels(labels: Labels, defaultValue?: string): string; -``` -Import - -```typescript -import { formatLabels } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| labels | Labels | | -| defaultValue | string | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/formattedvalue.md b/docs/sources/packages_api/data/formattedvalue.md deleted file mode 100644 index 8d390086a2e..00000000000 --- a/docs/sources/packages_api/data/formattedvalue.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FormattedValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FormattedValue interface - -Signature - -```typescript -export interface FormattedValue -``` -Import - -```typescript -import { FormattedValue } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [prefix](#prefix-property) | string | | -| [suffix](#suffix-property) | string | | -| [text](#text-property) | string | | - -### prefix property - -Signature - -```typescript -prefix?: string; -``` - -### suffix property - -Signature - -```typescript -suffix?: string; -``` - -### text property - -Signature - -```typescript -text: string; -``` diff --git a/docs/sources/packages_api/data/formattedvaluetostring.md b/docs/sources/packages_api/data/formattedvaluetostring.md deleted file mode 100644 index e8a24120201..00000000000 --- a/docs/sources/packages_api/data/formattedvaluetostring.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "formattedValueToString" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## formattedValueToString() function - -### formattedValueToString() function - -Signature - -```typescript -export declare function formattedValueToString(val: FormattedValue): string; -``` -Import - -```typescript -import { formattedValueToString } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| val | FormattedValue | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/formattedvector.md b/docs/sources/packages_api/data/formattedvector.md deleted file mode 100644 index 02e676c3978..00000000000 --- a/docs/sources/packages_api/data/formattedvector.md +++ /dev/null @@ -1,104 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FormattedVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FormattedVector class - -Signature - -```typescript -export declare class FormattedVector implements Vector -``` -Import - -```typescript -import { FormattedVector } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(source, formatter)](#constructor-sourceformatter) | | Constructs a new instance of the FormattedVector class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [length](#length-property) | | number | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(index)](#get-method) | | | -| [toArray()](#toarray-method) | | | -| [toJSON()](#tojson-method) | | | - -### constructor(source, formatter) - -Constructs a new instance of the `FormattedVector` class - -Signature - -```typescript -constructor(source: Vector, formatter: DisplayProcessor); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| source | Vector<T> | | -| formatter | DisplayProcessor | | - -### length property - -Signature - -```typescript -get length(): number; -``` - -### get method - -Signature - -```typescript -get(index: number): string; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`string` - -### toArray method - -Signature - -```typescript -toArray(): string[]; -``` -Returns: - -`string[]` - -### toJSON method - -Signature - -```typescript -toJSON(): string[]; -``` -Returns: - -`string[]` - diff --git a/docs/sources/packages_api/data/framematcher.md b/docs/sources/packages_api/data/framematcher.md deleted file mode 100644 index 0596bba8608..00000000000 --- a/docs/sources/packages_api/data/framematcher.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FrameMatcher" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FrameMatcher type - -### FrameMatcher type - -Signature - -```typescript -export declare type FrameMatcher = (frame: DataFrame) => boolean; -``` -Import - -```typescript -import { FrameMatcher } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/framematcherid.md b/docs/sources/packages_api/data/framematcherid.md deleted file mode 100644 index 7227a639f78..00000000000 --- a/docs/sources/packages_api/data/framematcherid.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FrameMatcherID" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FrameMatcherID enum - -### FrameMatcherID enum - -Field name matchers - -Signature - -```typescript -export declare enum FrameMatcherID -``` -Import - -```typescript -import { FrameMatcherID } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| byIndex | "byIndex" | | -| byLabel | "byLabel" | | -| byName | "byName" | | -| byRefId | "byRefId" | | - diff --git a/docs/sources/packages_api/data/framematcherinfo.md b/docs/sources/packages_api/data/framematcherinfo.md deleted file mode 100644 index 1505a9e7f4f..00000000000 --- a/docs/sources/packages_api/data/framematcherinfo.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FrameMatcherInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## FrameMatcherInfo interface - -Signature - -```typescript -export interface FrameMatcherInfo extends RegistryItemWithOptions -``` -Import - -```typescript -import { FrameMatcherInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](#get-property) | (options: TOptions) => FrameMatcher | | - -### get property - -Signature - -```typescript -get: (options: TOptions) => FrameMatcher; -``` diff --git a/docs/sources/packages_api/data/framematchers.md b/docs/sources/packages_api/data/framematchers.md deleted file mode 100644 index 5d536391fa5..00000000000 --- a/docs/sources/packages_api/data/framematchers.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "frameMatchers" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## frameMatchers variable - -### frameMatchers variable - -Signature - -```typescript -frameMatchers: Registry> -``` -Import - -```typescript -import { frameMatchers } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getactivethreshold.md b/docs/sources/packages_api/data/getactivethreshold.md deleted file mode 100644 index 84d21dbb9ee..00000000000 --- a/docs/sources/packages_api/data/getactivethreshold.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getActiveThreshold" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getActiveThreshold() function - -### getActiveThreshold() function - -Signature - -```typescript -export declare function getActiveThreshold(value: number, thresholds: Threshold[]): Threshold; -``` -Import - -```typescript -import { getActiveThreshold } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | -| thresholds | Threshold[] | | - -Returns: - -`Threshold` - diff --git a/docs/sources/packages_api/data/getallvaluesfromdimension.md b/docs/sources/packages_api/data/getallvaluesfromdimension.md deleted file mode 100644 index 49188e71765..00000000000 --- a/docs/sources/packages_api/data/getallvaluesfromdimension.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getAllValuesFromDimension" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getAllValuesFromDimension variable - -### getAllValuesFromDimension variable - -Signature - -```typescript -getAllValuesFromDimension: (dimension: Dimension, column: number, row: number) => any[] -``` -Import - -```typescript -import { getAllValuesFromDimension } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolorbyname.md b/docs/sources/packages_api/data/getcolorbyname.md deleted file mode 100644 index e88cc20d776..00000000000 --- a/docs/sources/packages_api/data/getcolorbyname.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColorByName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColorByName variable - -### getColorByName variable - -Signature - -```typescript -getColorByName: (colorName: string) => ColorDefinition | undefined -``` -Import - -```typescript -import { getColorByName } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolordefinition.md b/docs/sources/packages_api/data/getcolordefinition.md deleted file mode 100644 index 26416802507..00000000000 --- a/docs/sources/packages_api/data/getcolordefinition.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColorDefinition" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColorDefinition variable - -### getColorDefinition variable - -Signature - -```typescript -getColorDefinition: (hex: string, theme: GrafanaThemeType) => ColorDefinition | undefined -``` -Import - -```typescript -import { getColorDefinition } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolordefinitionbyname.md b/docs/sources/packages_api/data/getcolordefinitionbyname.md deleted file mode 100644 index ecea2e0a386..00000000000 --- a/docs/sources/packages_api/data/getcolordefinitionbyname.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColorDefinitionByName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColorDefinitionByName variable - -### getColorDefinitionByName variable - -Signature - -```typescript -getColorDefinitionByName: (name: Color) => ColorDefinition -``` -Import - -```typescript -import { getColorDefinitionByName } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolorfortheme.md b/docs/sources/packages_api/data/getcolorfortheme.md deleted file mode 100644 index ea8abdf06ef..00000000000 --- a/docs/sources/packages_api/data/getcolorfortheme.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColorForTheme" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColorForTheme variable - -### getColorForTheme variable - -Signature - -```typescript -getColorForTheme: (color: ColorDefinition, theme?: GrafanaThemeType | undefined) => string -``` -Import - -```typescript -import { getColorForTheme } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolorfromhexrgborname.md b/docs/sources/packages_api/data/getcolorfromhexrgborname.md deleted file mode 100644 index ffde9c383b9..00000000000 --- a/docs/sources/packages_api/data/getcolorfromhexrgborname.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColorFromHexRgbOrName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColorFromHexRgbOrName variable - -### getColorFromHexRgbOrName variable - -Signature - -```typescript -getColorFromHexRgbOrName: (color: string, theme?: GrafanaThemeType | undefined) => string -``` -Import - -```typescript -import { getColorFromHexRgbOrName } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolorname.md b/docs/sources/packages_api/data/getcolorname.md deleted file mode 100644 index 81376e104ee..00000000000 --- a/docs/sources/packages_api/data/getcolorname.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColorName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColorName variable - -### getColorName variable - -Signature - -```typescript -getColorName: (color?: string | undefined, theme?: GrafanaThemeType | undefined) => Color | undefined -``` -Import - -```typescript -import { getColorName } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolumnfromdimension.md b/docs/sources/packages_api/data/getcolumnfromdimension.md deleted file mode 100644 index 2a7c4f6c8f9..00000000000 --- a/docs/sources/packages_api/data/getcolumnfromdimension.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColumnFromDimension" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColumnFromDimension variable - -### getColumnFromDimension variable - -Signature - -```typescript -getColumnFromDimension: (dimension: Dimension, column: number) => Field> -``` -Import - -```typescript -import { getColumnFromDimension } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getcolumnsfromdimension.md b/docs/sources/packages_api/data/getcolumnsfromdimension.md deleted file mode 100644 index 7ce62d1893c..00000000000 --- a/docs/sources/packages_api/data/getcolumnsfromdimension.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getColumnsFromDimension" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getColumnsFromDimension variable - -### getColumnsFromDimension variable - -Signature - -```typescript -getColumnsFromDimension: (dimension: Dimension) => Field>[] -``` -Import - -```typescript -import { getColumnsFromDimension } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getdataframerow.md b/docs/sources/packages_api/data/getdataframerow.md deleted file mode 100644 index 2f8919cd155..00000000000 --- a/docs/sources/packages_api/data/getdataframerow.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getDataFrameRow" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getDataFrameRow() function - -### getDataFrameRow() function - -Wrapper to get an array from each field value - -Signature - -```typescript -export declare function getDataFrameRow(data: DataFrame, row: number): any[]; -``` -Import - -```typescript -import { getDataFrameRow } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame | | -| row | number | | - -Returns: - -`any[]` - diff --git a/docs/sources/packages_api/data/getdecimalsforvalue.md b/docs/sources/packages_api/data/getdecimalsforvalue.md deleted file mode 100644 index fb90ffd5648..00000000000 --- a/docs/sources/packages_api/data/getdecimalsforvalue.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getDecimalsForValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getDecimalsForValue() function - -### getDecimalsForValue() function - -Signature - -```typescript -export declare function getDecimalsForValue(value: number, decimalOverride?: DecimalCount): DecimalInfo; -``` -Import - -```typescript -import { getDecimalsForValue } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | -| decimalOverride | DecimalCount | | - -Returns: - -`DecimalInfo` - diff --git a/docs/sources/packages_api/data/getdimensionbyname.md b/docs/sources/packages_api/data/getdimensionbyname.md deleted file mode 100644 index 42b4d3e565d..00000000000 --- a/docs/sources/packages_api/data/getdimensionbyname.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getDimensionByName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getDimensionByName variable - -### getDimensionByName variable - -Signature - -```typescript -getDimensionByName: (dimensions: Dimensions, name: string) => Dimension -``` -Import - -```typescript -import { getDimensionByName } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getdisplayprocessor.md b/docs/sources/packages_api/data/getdisplayprocessor.md deleted file mode 100644 index 59bfa4be998..00000000000 --- a/docs/sources/packages_api/data/getdisplayprocessor.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getDisplayProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getDisplayProcessor() function - -### getDisplayProcessor() function - -Signature - -```typescript -export declare function getDisplayProcessor(options?: DisplayProcessorOptions): DisplayProcessor; -``` -Import - -```typescript -import { getDisplayProcessor } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | DisplayProcessorOptions | | - -Returns: - -`DisplayProcessor` - diff --git a/docs/sources/packages_api/data/getdisplayvaluealignmentfactors.md b/docs/sources/packages_api/data/getdisplayvaluealignmentfactors.md deleted file mode 100644 index 8cd950908bb..00000000000 --- a/docs/sources/packages_api/data/getdisplayvaluealignmentfactors.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getDisplayValueAlignmentFactors" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getDisplayValueAlignmentFactors() function - -### getDisplayValueAlignmentFactors() function - -Signature - -```typescript -export declare function getDisplayValueAlignmentFactors(values: FieldDisplay[]): DisplayValueAlignmentFactors; -``` -Import - -```typescript -import { getDisplayValueAlignmentFactors } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| values | FieldDisplay[] | | - -Returns: - -`DisplayValueAlignmentFactors` - diff --git a/docs/sources/packages_api/data/getfielddisplayname.md b/docs/sources/packages_api/data/getfielddisplayname.md deleted file mode 100644 index 96638a113ee..00000000000 --- a/docs/sources/packages_api/data/getfielddisplayname.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFieldDisplayName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFieldDisplayName() function - -### getFieldDisplayName() function - -Signature - -```typescript -export declare function getFieldDisplayName(field: Field, frame?: DataFrame, allFrames?: DataFrame[]): string; -``` -Import - -```typescript -import { getFieldDisplayName } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| field | Field | | -| frame | DataFrame | | -| allFrames | DataFrame[] | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/getfielddisplayvalues.md b/docs/sources/packages_api/data/getfielddisplayvalues.md deleted file mode 100644 index 3c2c88f5487..00000000000 --- a/docs/sources/packages_api/data/getfielddisplayvalues.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFieldDisplayValues" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFieldDisplayValues variable - -### getFieldDisplayValues variable - -Signature - -```typescript -getFieldDisplayValues: (options: GetFieldDisplayValuesOptions) => FieldDisplay[] -``` -Import - -```typescript -import { getFieldDisplayValues } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getfielddisplayvaluesoptions.md b/docs/sources/packages_api/data/getfielddisplayvaluesoptions.md deleted file mode 100644 index 578b97abc43..00000000000 --- a/docs/sources/packages_api/data/getfielddisplayvaluesoptions.md +++ /dev/null @@ -1,97 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GetFieldDisplayValuesOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GetFieldDisplayValuesOptions interface - -Signature - -```typescript -export interface GetFieldDisplayValuesOptions -``` -Import - -```typescript -import { GetFieldDisplayValuesOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [autoMinMax](#autominmax-property) | boolean | | -| [data](#data-property) | DataFrame[] | | -| [fieldConfig](#fieldconfig-property) | FieldConfigSource | | -| [reduceOptions](#reduceoptions-property) | ReduceDataOptions | | -| [replaceVariables](#replacevariables-property) | InterpolateFunction | | -| [sparkline](#sparkline-property) | boolean | | -| [theme](#theme-property) | GrafanaTheme | | -| [timeZone](#timezone-property) | TimeZone | | - -### autoMinMax property - -Signature - -```typescript -autoMinMax?: boolean; -``` - -### data property - -Signature - -```typescript -data?: DataFrame[]; -``` - -### fieldConfig property - -Signature - -```typescript -fieldConfig: FieldConfigSource; -``` - -### reduceOptions property - -Signature - -```typescript -reduceOptions: ReduceDataOptions; -``` - -### replaceVariables property - -Signature - -```typescript -replaceVariables: InterpolateFunction; -``` - -### sparkline property - -Signature - -```typescript -sparkline?: boolean; -``` - -### theme property - -Signature - -```typescript -theme: GrafanaTheme; -``` - -### timeZone property - -Signature - -```typescript -timeZone?: TimeZone; -``` diff --git a/docs/sources/packages_api/data/getfieldmatcher.md b/docs/sources/packages_api/data/getfieldmatcher.md deleted file mode 100644 index f6c5f04c1fc..00000000000 --- a/docs/sources/packages_api/data/getfieldmatcher.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFieldMatcher" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFieldMatcher() function - -### getFieldMatcher() function - -Signature - -```typescript -export declare function getFieldMatcher(config: MatcherConfig): FieldMatcher; -``` -Import - -```typescript -import { getFieldMatcher } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | MatcherConfig | | - -Returns: - -`FieldMatcher` - diff --git a/docs/sources/packages_api/data/getflotpairs.md b/docs/sources/packages_api/data/getflotpairs.md deleted file mode 100644 index 9bce27348c0..00000000000 --- a/docs/sources/packages_api/data/getflotpairs.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFlotPairs" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFlotPairs() function - -### getFlotPairs() function - -Signature - -```typescript -export declare function getFlotPairs({ xField, yField, nullValueMode }: FlotPairsOptions): GraphSeriesValue[][]; -``` -Import - -```typescript -import { getFlotPairs } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { xField, yField, nullValueMode } | FlotPairsOptions | | - -Returns: - -`GraphSeriesValue[][]` - diff --git a/docs/sources/packages_api/data/getflotpairsconstant.md b/docs/sources/packages_api/data/getflotpairsconstant.md deleted file mode 100644 index e1c7b421257..00000000000 --- a/docs/sources/packages_api/data/getflotpairsconstant.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFlotPairsConstant" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFlotPairsConstant() function - -### getFlotPairsConstant() function - -Returns a constant series based on the first value from the provide series. - -Signature - -```typescript -export declare function getFlotPairsConstant(seriesData: GraphSeriesValue[][], range: TimeRange): GraphSeriesValue[][]; -``` -Import - -```typescript -import { getFlotPairsConstant } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| seriesData | GraphSeriesValue[][] | Series | -| range | TimeRange | Start and end time for the constant series | - -Returns: - -`GraphSeriesValue[][]` - diff --git a/docs/sources/packages_api/data/getframedisplayname.md b/docs/sources/packages_api/data/getframedisplayname.md deleted file mode 100644 index 714d950a03b..00000000000 --- a/docs/sources/packages_api/data/getframedisplayname.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFrameDisplayName" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFrameDisplayName() function - -### getFrameDisplayName() function - -Get an appropriate display title - -Signature - -```typescript -export declare function getFrameDisplayName(frame: DataFrame, index?: number): string; -``` -Import - -```typescript -import { getFrameDisplayName } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| frame | DataFrame | | -| index | number | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/getframematchers.md b/docs/sources/packages_api/data/getframematchers.md deleted file mode 100644 index 43d98f8268c..00000000000 --- a/docs/sources/packages_api/data/getframematchers.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFrameMatchers" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getFrameMatchers() function - -### getFrameMatchers() function - -Signature - -```typescript -export declare function getFrameMatchers(config: MatcherConfig): FrameMatcher; -``` -Import - -```typescript -import { getFrameMatchers } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | MatcherConfig | | - -Returns: - -`FrameMatcher` - diff --git a/docs/sources/packages_api/data/getlocaledata.md b/docs/sources/packages_api/data/getlocaledata.md deleted file mode 100644 index 7e38caa038e..00000000000 --- a/docs/sources/packages_api/data/getlocaledata.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getLocaleData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getLocaleData variable - -### getLocaleData variable - -Signature - -```typescript -getLocaleData: () => DateTimeLocale -``` -Import - -```typescript -import { getLocaleData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getloglevel.md b/docs/sources/packages_api/data/getloglevel.md deleted file mode 100644 index ec01c7c524c..00000000000 --- a/docs/sources/packages_api/data/getloglevel.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getLogLevel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getLogLevel() function - -### getLogLevel() function - -Returns the log level of a log line. Parse the line for level words. If no level is found, it returns `LogLevel.unknown`. - -Example: `getLogLevel('WARN 1999-12-31 this is great') // LogLevel.warn` - -Signature - -```typescript -export declare function getLogLevel(line: string): LogLevel; -``` -Import - -```typescript -import { getLogLevel } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| line | string | | - -Returns: - -`LogLevel` - diff --git a/docs/sources/packages_api/data/getloglevelfromkey.md b/docs/sources/packages_api/data/getloglevelfromkey.md deleted file mode 100644 index 1bf64579b36..00000000000 --- a/docs/sources/packages_api/data/getloglevelfromkey.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getLogLevelFromKey" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getLogLevelFromKey() function - -### getLogLevelFromKey() function - -Signature - -```typescript -export declare function getLogLevelFromKey(key: string | number): LogLevel; -``` -Import - -```typescript -import { getLogLevelFromKey } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | number | | - -Returns: - -`LogLevel` - diff --git a/docs/sources/packages_api/data/getmappedvalue.md b/docs/sources/packages_api/data/getmappedvalue.md deleted file mode 100644 index f0c76484419..00000000000 --- a/docs/sources/packages_api/data/getmappedvalue.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getMappedValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getMappedValue variable - -### getMappedValue variable - -Signature - -```typescript -getMappedValue: (valueMappings: ValueMapping[], value: TimeSeriesValue) => ValueMapping -``` -Import - -```typescript -import { getMappedValue } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getnamedcolorpalette.md b/docs/sources/packages_api/data/getnamedcolorpalette.md deleted file mode 100644 index 34c055df456..00000000000 --- a/docs/sources/packages_api/data/getnamedcolorpalette.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getNamedColorPalette" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getNamedColorPalette variable - -### getNamedColorPalette variable - -Signature - -```typescript -getNamedColorPalette: () => Map -``` -Import - -```typescript -import { getNamedColorPalette } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getparser.md b/docs/sources/packages_api/data/getparser.md deleted file mode 100644 index 4a4ce5c414c..00000000000 --- a/docs/sources/packages_api/data/getparser.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getParser" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getParser() function - -### getParser() function - -Signature - -```typescript -export declare function getParser(line: string): LogsParser | undefined; -``` -Import - -```typescript -import { getParser } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| line | string | | - -Returns: - -`LogsParser | undefined` - diff --git a/docs/sources/packages_api/data/getscalecalculator.md b/docs/sources/packages_api/data/getscalecalculator.md deleted file mode 100644 index 0233f75653e..00000000000 --- a/docs/sources/packages_api/data/getscalecalculator.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getScaleCalculator" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getScaleCalculator() function - -### getScaleCalculator() function - -Signature - -```typescript -export declare function getScaleCalculator(field: Field, theme?: GrafanaTheme): ScaleCalculator; -``` -Import - -```typescript -import { getScaleCalculator } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| field | Field | | -| theme | GrafanaTheme | | - -Returns: - -`ScaleCalculator` - diff --git a/docs/sources/packages_api/data/getseriestimestep.md b/docs/sources/packages_api/data/getseriestimestep.md deleted file mode 100644 index ed59bb87733..00000000000 --- a/docs/sources/packages_api/data/getseriestimestep.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getSeriesTimeStep" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getSeriesTimeStep variable - -### getSeriesTimeStep variable - -Returns minimal time step from series time field - -Signature - -```typescript -getSeriesTimeStep: (timeField: Field) => number -``` -Import - -```typescript -import { getSeriesTimeStep } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/gettimefield.md b/docs/sources/packages_api/data/gettimefield.md deleted file mode 100644 index e13e41b8b2c..00000000000 --- a/docs/sources/packages_api/data/gettimefield.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTimeField" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getTimeField variable - -### getTimeField variable - -Signature - -```typescript -getTimeField: (series: DataFrame) => { - timeField?: Field; - timeIndex?: number; -} -``` -Import - -```typescript -import { getTimeField } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/gettimezonegroups.md b/docs/sources/packages_api/data/gettimezonegroups.md deleted file mode 100644 index fc6bca2c5ba..00000000000 --- a/docs/sources/packages_api/data/gettimezonegroups.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTimeZoneGroups" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getTimeZoneGroups variable - -### getTimeZoneGroups variable - -Signature - -```typescript -getTimeZoneGroups: ((includeInternal?: any) => GroupedTimeZones[]) & import("lodash").MemoizedFunction -``` -Import - -```typescript -import { getTimeZoneGroups } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/gettimezoneinfo.md b/docs/sources/packages_api/data/gettimezoneinfo.md deleted file mode 100644 index ef11199d61b..00000000000 --- a/docs/sources/packages_api/data/gettimezoneinfo.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTimeZoneInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getTimeZoneInfo variable - -### getTimeZoneInfo variable - -Signature - -```typescript -getTimeZoneInfo: (zone: string, timestamp: number) => TimeZoneInfo | undefined -``` -Import - -```typescript -import { getTimeZoneInfo } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/gettimezones.md b/docs/sources/packages_api/data/gettimezones.md deleted file mode 100644 index 245064d9df3..00000000000 --- a/docs/sources/packages_api/data/gettimezones.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTimeZones" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getTimeZones variable - -### getTimeZones variable - -Signature - -```typescript -getTimeZones: ((includeInternal?: any) => TimeZone[]) & import("lodash").MemoizedFunction -``` -Import - -```typescript -import { getTimeZones } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/getvalueformat.md b/docs/sources/packages_api/data/getvalueformat.md deleted file mode 100644 index 5c708ce9bd7..00000000000 --- a/docs/sources/packages_api/data/getvalueformat.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getValueFormat" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getValueFormat() function - -### getValueFormat() function - -Signature - -```typescript -export declare function getValueFormat(id?: string | null): ValueFormatter; -``` -Import - -```typescript -import { getValueFormat } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | null | | - -Returns: - -`ValueFormatter` - diff --git a/docs/sources/packages_api/data/getvalueformats.md b/docs/sources/packages_api/data/getvalueformats.md deleted file mode 100644 index 0ea7388079b..00000000000 --- a/docs/sources/packages_api/data/getvalueformats.md +++ /dev/null @@ -1,39 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getValueFormats" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getValueFormats() function - -### getValueFormats() function - -Signature - -```typescript -export declare function getValueFormats(): { - text: string; - submenu: { - text: string; - value: string; - }[]; -}[]; -``` -Import - -```typescript -import { getValueFormats } from '@grafana/data'; -``` -Returns: - -`{ - text: string; - submenu: { - text: string; - value: string; - }[]; -}[]` - diff --git a/docs/sources/packages_api/data/getvalueformatterindex.md b/docs/sources/packages_api/data/getvalueformatterindex.md deleted file mode 100644 index 97c8d99a079..00000000000 --- a/docs/sources/packages_api/data/getvalueformatterindex.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getValueFormatterIndex" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getValueFormatterIndex() function - -### getValueFormatterIndex() function - -Signature - -```typescript -export declare function getValueFormatterIndex(): ValueFormatterIndex; -``` -Import - -```typescript -import { getValueFormatterIndex } from '@grafana/data'; -``` -Returns: - -`ValueFormatterIndex` - diff --git a/docs/sources/packages_api/data/getvaluefromdimension.md b/docs/sources/packages_api/data/getvaluefromdimension.md deleted file mode 100644 index 21086486272..00000000000 --- a/docs/sources/packages_api/data/getvaluefromdimension.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getValueFromDimension" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## getValueFromDimension variable - -### getValueFromDimension variable - -Signature - -```typescript -getValueFromDimension: (dimension: Dimension, column: number, row: number) => any -``` -Import - -```typescript -import { getValueFromDimension } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/grafanaconfig.md b/docs/sources/packages_api/data/grafanaconfig.md deleted file mode 100644 index 7de02c90784..00000000000 --- a/docs/sources/packages_api/data/grafanaconfig.md +++ /dev/null @@ -1,364 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GrafanaConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GrafanaConfig interface - -Describes all the different Grafana configuration values available for an instance. - -Signature - -```typescript -export interface GrafanaConfig -``` -Import - -```typescript -import { GrafanaConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alertingEnabled](#alertingenabled-property) | boolean | | -| [alertingErrorOrTimeout](#alertingerrorortimeout-property) | string | | -| [alertingMinInterval](#alertingmininterval-property) | number | | -| [alertingNoDataOrNullValues](#alertingnodataornullvalues-property) | string | | -| [allowOrgCreate](#alloworgcreate-property) | boolean | | -| [appSubUrl](#appsuburl-property) | string | | -| [authProxyEnabled](#authproxyenabled-property) | boolean | | -| [autoAssignOrg](#autoassignorg-property) | boolean | | -| [bootData](#bootdata-property) | any | | -| [buildInfo](#buildinfo-property) | BuildInfo | | -| [datasources](#datasources-property) | {
[str: string]: DataSourceInstanceSettings;
} | | -| [defaultDatasource](#defaultdatasource-property) | string | | -| [disableLoginForm](#disableloginform-property) | boolean | | -| [disableSanitizeHtml](#disablesanitizehtml-property) | boolean | | -| [disableUserSignUp](#disableusersignup-property) | boolean | | -| [editorsCanAdmin](#editorscanadmin-property) | boolean | | -| [exploreEnabled](#exploreenabled-property) | boolean | | -| [externalUserMngInfo](#externalusermnginfo-property) | string | | -| [externalUserMngLinkName](#externalusermnglinkname-property) | string | | -| [externalUserMngLinkUrl](#externalusermnglinkurl-property) | string | | -| [featureToggles](#featuretoggles-property) | FeatureToggles | | -| [ldapEnabled](#ldapenabled-property) | boolean | | -| [licenseInfo](#licenseinfo-property) | LicenseInfo | | -| [loginError](#loginerror-property) | any | | -| [loginHint](#loginhint-property) | any | | -| [minRefreshInterval](#minrefreshinterval-property) | string | | -| [navTree](#navtree-property) | any | | -| [newPanelTitle](#newpaneltitle-property) | string | | -| [oauth](#oauth-property) | any | | -| [panels](#panels-property) | {
[key: string]: PanelPluginMeta;
} | | -| [passwordHint](#passwordhint-property) | any | | -| [pluginsToPreload](#pluginstopreload-property) | string[] | | -| [samlEnabled](#samlenabled-property) | boolean | | -| [theme](#theme-property) | GrafanaTheme | | -| [verifyEmailEnabled](#verifyemailenabled-property) | boolean | | -| [viewersCanEdit](#viewerscanedit-property) | boolean | | -| [windowTitlePrefix](#windowtitleprefix-property) | string | | - -### alertingEnabled property - -Signature - -```typescript -alertingEnabled: boolean; -``` - -### alertingErrorOrTimeout property - -Signature - -```typescript -alertingErrorOrTimeout: string; -``` - -### alertingMinInterval property - -Signature - -```typescript -alertingMinInterval: number; -``` - -### alertingNoDataOrNullValues property - -Signature - -```typescript -alertingNoDataOrNullValues: string; -``` - -### allowOrgCreate property - -Signature - -```typescript -allowOrgCreate: boolean; -``` - -### appSubUrl property - -Signature - -```typescript -appSubUrl: string; -``` - -### authProxyEnabled property - -Signature - -```typescript -authProxyEnabled: boolean; -``` - -### autoAssignOrg property - -Signature - -```typescript -autoAssignOrg: boolean; -``` - -### bootData property - -Signature - -```typescript -bootData: any; -``` - -### buildInfo property - -Signature - -```typescript -buildInfo: BuildInfo; -``` - -### datasources property - -Signature - -```typescript -datasources: { - [str: string]: DataSourceInstanceSettings; - }; -``` - -### defaultDatasource property - -Signature - -```typescript -defaultDatasource: string; -``` - -### disableLoginForm property - -Signature - -```typescript -disableLoginForm: boolean; -``` - -### disableSanitizeHtml property - -Signature - -```typescript -disableSanitizeHtml: boolean; -``` - -### disableUserSignUp property - -Signature - -```typescript -disableUserSignUp: boolean; -``` - -### editorsCanAdmin property - -Signature - -```typescript -editorsCanAdmin: boolean; -``` - -### exploreEnabled property - -Signature - -```typescript -exploreEnabled: boolean; -``` - -### externalUserMngInfo property - -Signature - -```typescript -externalUserMngInfo: string; -``` - -### externalUserMngLinkName property - -Signature - -```typescript -externalUserMngLinkName: string; -``` - -### externalUserMngLinkUrl property - -Signature - -```typescript -externalUserMngLinkUrl: string; -``` - -### featureToggles property - -Signature - -```typescript -featureToggles: FeatureToggles; -``` - -### ldapEnabled property - -Signature - -```typescript -ldapEnabled: boolean; -``` - -### licenseInfo property - -Signature - -```typescript -licenseInfo: LicenseInfo; -``` - -### loginError property - -Signature - -```typescript -loginError: any; -``` - -### loginHint property - -Signature - -```typescript -loginHint: any; -``` - -### minRefreshInterval property - -Signature - -```typescript -minRefreshInterval: string; -``` - -### navTree property - -Signature - -```typescript -navTree: any; -``` - -### newPanelTitle property - -Signature - -```typescript -newPanelTitle: string; -``` - -### oauth property - -Signature - -```typescript -oauth: any; -``` - -### panels property - -Signature - -```typescript -panels: { - [key: string]: PanelPluginMeta; - }; -``` - -### passwordHint property - -Signature - -```typescript -passwordHint: any; -``` - -### pluginsToPreload property - -Signature - -```typescript -pluginsToPreload: string[]; -``` - -### samlEnabled property - -Signature - -```typescript -samlEnabled: boolean; -``` - -### theme property - -Signature - -```typescript -theme: GrafanaTheme; -``` - -### verifyEmailEnabled property - -Signature - -```typescript -verifyEmailEnabled: boolean; -``` - -### viewersCanEdit property - -Signature - -```typescript -viewersCanEdit: boolean; -``` - -### windowTitlePrefix property - -Signature - -```typescript -windowTitlePrefix: string; -``` diff --git a/docs/sources/packages_api/data/grafanadataframetoarrowtable.md b/docs/sources/packages_api/data/grafanadataframetoarrowtable.md deleted file mode 100644 index 26bbbf1e494..00000000000 --- a/docs/sources/packages_api/data/grafanadataframetoarrowtable.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "grafanaDataFrameToArrowTable" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## grafanaDataFrameToArrowTable() function - -### grafanaDataFrameToArrowTable() function - -Signature - -```typescript -export declare function grafanaDataFrameToArrowTable(data: DataFrame, keepOriginalNames?: boolean): Table; -``` -Import - -```typescript -import { grafanaDataFrameToArrowTable } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame | | -| keepOriginalNames | boolean | by default, the exported Table will get names that match the display within grafana. This typically includes any labels defined in the metadata.When using this function to round-trip data, be sure to set keepOriginalNames=true | - -Returns: - -`Table` - diff --git a/docs/sources/packages_api/data/grafanaplugin.md b/docs/sources/packages_api/data/grafanaplugin.md deleted file mode 100644 index b25b6858eb8..00000000000 --- a/docs/sources/packages_api/data/grafanaplugin.md +++ /dev/null @@ -1,101 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GrafanaPlugin" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GrafanaPlugin class - -Signature - -```typescript -export declare class GrafanaPlugin -``` -Import - -```typescript -import { GrafanaPlugin } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor()](#constructor-) | | Constructs a new instance of the GrafanaPlugin class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [angularConfigCtrl](#angularconfigctrl-property) | | any | | -| [configPages](#configpages-property) | | Array<PluginConfigPage<T>> | | -| [loadError](#loaderror-property) | | boolean | | -| [meta](#meta-property) | | T | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addConfigPage(tab)](#addconfigpage-method) | | | - -### constructor() - -Constructs a new instance of the `GrafanaPlugin` class - -Signature - -```typescript -constructor(); -``` - -### angularConfigCtrl property - -Signature - -```typescript -angularConfigCtrl?: any; -``` - -### configPages property - -Signature - -```typescript -configPages?: Array>; -``` - -### loadError property - -Signature - -```typescript -loadError?: boolean; -``` - -### meta property - -Signature - -```typescript -meta: T; -``` - -### addConfigPage method - -Signature - -```typescript -addConfigPage(tab: PluginConfigPage): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| tab | PluginConfigPage<T> | | - -Returns: - -`this` - diff --git a/docs/sources/packages_api/data/grafanatheme.md b/docs/sources/packages_api/data/grafanatheme.md deleted file mode 100644 index 4f581e50fbf..00000000000 --- a/docs/sources/packages_api/data/grafanatheme.md +++ /dev/null @@ -1,188 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GrafanaTheme" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GrafanaTheme interface - -Signature - -```typescript -export interface GrafanaTheme extends GrafanaThemeCommons -``` -Import - -```typescript -import { GrafanaTheme } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [colors](#colors-property) | {
bg1: string;
bg2: string;
bg3: string;
border1: string;
border2: string;
border3: string;
bgBlue1: string;
bgBlue2: string;
dashboardBg: string;
bodyBg: string;
panelBg: string;
panelBorder: string;
pageHeaderBg: string;
pageHeaderBorder: string;
dropdownBg: string;
dropdownShadow: string;
dropdownOptionHoverBg: string;
link: string;
linkDisabled: string;
linkHover: string;
linkExternal: string;
textStrong: string;
textHeading: string;
text: string;
textSemiWeak: string;
textWeak: string;
textFaint: string;
textBlue: string;
formLabel: string;
formDescription: string;
formInputBg: string;
formInputBgDisabled: string;
formInputBorder: string;
formInputBorderHover: string;
formInputBorderActive: string;
formInputBorderInvalid: string;
formFocusOutline: string;
formInputText: string;
formInputDisabledText: string;
formInputPlaceholderText: string;
formValidationMessageText: string;
formValidationMessageBg: string;
formSwitchBg: string;
formSwitchBgActive: string;
formSwitchBgActiveHover: string;
formSwitchBgHover: string;
formSwitchBgDisabled: string;
formSwitchDot: string;
formCheckboxBgChecked: string;
formCheckboxBgCheckedHover: string;
formCheckboxCheckmark: string;
} | | -| [isDark](#isdark-property) | boolean | | -| [isLight](#islight-property) | boolean | | -| [palette](#palette-property) | {
black: string;
white: string;
dark1: string;
dark2: string;
dark3: string;
dark4: string;
dark5: string;
dark6: string;
dark7: string;
dark8: string;
dark9: string;
dark10: string;
gray1: string;
gray2: string;
gray3: string;
gray4: string;
gray5: string;
gray6: string;
gray7: string;
gray98: string;
gray95: string;
gray85: string;
gray70: string;
gray60: string;
gray33: string;
gray25: string;
gray15: string;
gray10: string;
gray05: string;
blue95: string;
blue85: string;
blue80: string;
blue77: string;
red88: string;
redBase: string;
redShade: string;
greenBase: string;
greenShade: string;
red: string;
yellow: string;
purple: string;
orange: string;
orangeDark: string;
queryRed: string;
queryGreen: string;
queryPurple: string;
queryOrange: string;
brandPrimary: string;
brandSuccess: string;
brandWarning: string;
brandDanger: string;
online: string;
warn: string;
critical: string;
} | | -| [shadows](#shadows-property) | {
listItem: string;
} | | -| [type](#type-property) | GrafanaThemeType | | - -### colors property - -Signature - -```typescript -colors: { - bg1: string; - bg2: string; - bg3: string; - border1: string; - border2: string; - border3: string; - bgBlue1: string; - bgBlue2: string; - dashboardBg: string; - bodyBg: string; - panelBg: string; - panelBorder: string; - pageHeaderBg: string; - pageHeaderBorder: string; - dropdownBg: string; - dropdownShadow: string; - dropdownOptionHoverBg: string; - link: string; - linkDisabled: string; - linkHover: string; - linkExternal: string; - textStrong: string; - textHeading: string; - text: string; - textSemiWeak: string; - textWeak: string; - textFaint: string; - textBlue: string; - formLabel: string; - formDescription: string; - formInputBg: string; - formInputBgDisabled: string; - formInputBorder: string; - formInputBorderHover: string; - formInputBorderActive: string; - formInputBorderInvalid: string; - formFocusOutline: string; - formInputText: string; - formInputDisabledText: string; - formInputPlaceholderText: string; - formValidationMessageText: string; - formValidationMessageBg: string; - formSwitchBg: string; - formSwitchBgActive: string; - formSwitchBgActiveHover: string; - formSwitchBgHover: string; - formSwitchBgDisabled: string; - formSwitchDot: string; - formCheckboxBgChecked: string; - formCheckboxBgCheckedHover: string; - formCheckboxCheckmark: string; - }; -``` - -### isDark property - -Signature - -```typescript -isDark: boolean; -``` - -### isLight property - -Signature - -```typescript -isLight: boolean; -``` - -### palette property - -Signature - -```typescript -palette: { - black: string; - white: string; - dark1: string; - dark2: string; - dark3: string; - dark4: string; - dark5: string; - dark6: string; - dark7: string; - dark8: string; - dark9: string; - dark10: string; - gray1: string; - gray2: string; - gray3: string; - gray4: string; - gray5: string; - gray6: string; - gray7: string; - gray98: string; - gray95: string; - gray85: string; - gray70: string; - gray60: string; - gray33: string; - gray25: string; - gray15: string; - gray10: string; - gray05: string; - blue95: string; - blue85: string; - blue80: string; - blue77: string; - red88: string; - redBase: string; - redShade: string; - greenBase: string; - greenShade: string; - red: string; - yellow: string; - purple: string; - orange: string; - orangeDark: string; - queryRed: string; - queryGreen: string; - queryPurple: string; - queryOrange: string; - brandPrimary: string; - brandSuccess: string; - brandWarning: string; - brandDanger: string; - online: string; - warn: string; - critical: string; - }; -``` - -### shadows property - -Signature - -```typescript -shadows: { - listItem: string; - }; -``` - -### type property - -Signature - -```typescript -type: GrafanaThemeType; -``` diff --git a/docs/sources/packages_api/data/grafanathemecommons.md b/docs/sources/packages_api/data/grafanathemecommons.md deleted file mode 100644 index e6b4748c010..00000000000 --- a/docs/sources/packages_api/data/grafanathemecommons.md +++ /dev/null @@ -1,193 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GrafanaThemeCommons" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GrafanaThemeCommons interface - -Signature - -```typescript -export interface GrafanaThemeCommons -``` -Import - -```typescript -import { GrafanaThemeCommons } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [border](#border-property) | {
radius: {
sm: string;
md: string;
lg: string;
};
width: {
sm: string;
};
} | | -| [breakpoints](#breakpoints-property) | {
xs: string;
sm: string;
md: string;
lg: string;
xl: string;
xxl: string;
} | | -| [height](#height-property) | {
sm: number;
md: number;
lg: number;
} | | -| [name](#name-property) | string | | -| [panelHeaderHeight](#panelheaderheight-property) | number | | -| [panelPadding](#panelpadding-property) | number | | -| [spacing](#spacing-property) | {
insetSquishMd: string;
d: string;
xxs: string;
xs: string;
sm: string;
md: string;
lg: string;
xl: string;
gutter: string;
formSpacingBase: number;
formMargin: string;
formFieldsetMargin: string;
formInputHeight: number;
formButtonHeight: number;
formInputPaddingHorizontal: string;
formInputAffixPaddingHorizontal: string;
formInputMargin: string;
formLabelPadding: string;
formLabelMargin: string;
formValidationMessagePadding: string;
formValidationMessageMargin: string;
inlineFormMargin: string;
} | | -| [typography](#typography-property) | {
fontFamily: {
sansSerif: string;
monospace: string;
};
size: {
base: string;
xs: string;
sm: string;
md: string;
lg: string;
};
weight: {
light: number;
regular: number;
semibold: number;
bold: number;
};
lineHeight: {
xs: number;
sm: number;
md: number;
lg: number;
};
heading: {
h1: string;
h2: string;
h3: string;
h4: string;
h5: string;
h6: string;
};
link: {
decoration: string;
hoverDecoration: string;
};
} | | -| [zIndex](#zindex-property) | {
dropdown: number;
navbarFixed: number;
sidemenu: number;
tooltip: number;
modalBackdrop: number;
modal: number;
typeahead: number;
} | | - -### border property - -Signature - -```typescript -border: { - radius: { - sm: string; - md: string; - lg: string; - }; - width: { - sm: string; - }; - }; -``` - -### breakpoints property - -Signature - -```typescript -breakpoints: { - xs: string; - sm: string; - md: string; - lg: string; - xl: string; - xxl: string; - }; -``` - -### height property - -Signature - -```typescript -height: { - sm: number; - md: number; - lg: number; - }; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### panelHeaderHeight property - -Signature - -```typescript -panelHeaderHeight: number; -``` - -### panelPadding property - -Signature - -```typescript -panelPadding: number; -``` - -### spacing property - -Signature - -```typescript -spacing: { - insetSquishMd: string; - d: string; - xxs: string; - xs: string; - sm: string; - md: string; - lg: string; - xl: string; - gutter: string; - formSpacingBase: number; - formMargin: string; - formFieldsetMargin: string; - formInputHeight: number; - formButtonHeight: number; - formInputPaddingHorizontal: string; - formInputAffixPaddingHorizontal: string; - formInputMargin: string; - formLabelPadding: string; - formLabelMargin: string; - formValidationMessagePadding: string; - formValidationMessageMargin: string; - inlineFormMargin: string; - }; -``` - -### typography property - -Signature - -```typescript -typography: { - fontFamily: { - sansSerif: string; - monospace: string; - }; - size: { - base: string; - xs: string; - sm: string; - md: string; - lg: string; - }; - weight: { - light: number; - regular: number; - semibold: number; - bold: number; - }; - lineHeight: { - xs: number; - sm: number; - md: number; - lg: number; - }; - heading: { - h1: string; - h2: string; - h3: string; - h4: string; - h5: string; - h6: string; - }; - link: { - decoration: string; - hoverDecoration: string; - }; - }; -``` - -### zIndex property - -Signature - -```typescript -zIndex: { - dropdown: number; - navbarFixed: number; - sidemenu: number; - tooltip: number; - modalBackdrop: number; - modal: number; - typeahead: number; - }; -``` diff --git a/docs/sources/packages_api/data/grafanathemetype.md b/docs/sources/packages_api/data/grafanathemetype.md deleted file mode 100644 index e9b57b84b50..00000000000 --- a/docs/sources/packages_api/data/grafanathemetype.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GrafanaThemeType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GrafanaThemeType enum - -### GrafanaThemeType enum - -Signature - -```typescript -export declare enum GrafanaThemeType -``` -Import - -```typescript -import { GrafanaThemeType } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Dark | "dark" | | -| Light | "light" | | - diff --git a/docs/sources/packages_api/data/graphseriesvalue.md b/docs/sources/packages_api/data/graphseriesvalue.md deleted file mode 100644 index 68c3472278a..00000000000 --- a/docs/sources/packages_api/data/graphseriesvalue.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphSeriesValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GraphSeriesValue type - -### GraphSeriesValue type - -Signature - -```typescript -export declare type GraphSeriesValue = number | null; -``` -Import - -```typescript -import { GraphSeriesValue } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/graphseriesxy.md b/docs/sources/packages_api/data/graphseriesxy.md deleted file mode 100644 index 75259f0f6a1..00000000000 --- a/docs/sources/packages_api/data/graphseriesxy.md +++ /dev/null @@ -1,117 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphSeriesXY" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GraphSeriesXY interface - -View model projection of a series - -Signature - -```typescript -export interface GraphSeriesXY -``` -Import - -```typescript -import { GraphSeriesXY } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | string | | -| [data](#data-property) | GraphSeriesValue[][] | | -| [info](#info-property) | DisplayValue[] | | -| [isVisible](#isvisible-property) | boolean | | -| [label](#label-property) | string | | -| [seriesIndex](#seriesindex-property) | number | | -| [timeField](#timefield-property) | Field | | -| [timeStep](#timestep-property) | number | | -| [valueField](#valuefield-property) | Field | | -| [yAxis](#yaxis-property) | YAxis | | - -### color property - -Signature - -```typescript -color?: string; -``` - -### data property - -Signature - -```typescript -data: GraphSeriesValue[][]; -``` - -### info property - -Signature - -```typescript -info?: DisplayValue[]; -``` - -### isVisible property - -Signature - -```typescript -isVisible: boolean; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### seriesIndex property - -Signature - -```typescript -seriesIndex: number; -``` - -### timeField property - -Signature - -```typescript -timeField: Field; -``` - -### timeStep property - -Signature - -```typescript -timeStep: number; -``` - -### valueField property - -Signature - -```typescript -valueField: Field; -``` - -### yAxis property - -Signature - -```typescript -yAxis: YAxis; -``` diff --git a/docs/sources/packages_api/data/groupedtimezones.md b/docs/sources/packages_api/data/groupedtimezones.md deleted file mode 100644 index 12d7c266c94..00000000000 --- a/docs/sources/packages_api/data/groupedtimezones.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GroupedTimeZones" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## GroupedTimeZones interface - -Signature - -```typescript -export interface GroupedTimeZones -``` -Import - -```typescript -import { GroupedTimeZones } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [name](#name-property) | string | | -| [zones](#zones-property) | TimeZone[] | | - -### name property - -Signature - -```typescript -name: string; -``` - -### zones property - -Signature - -```typescript -zones: TimeZone[]; -``` diff --git a/docs/sources/packages_api/data/guessfieldtypeforfield.md b/docs/sources/packages_api/data/guessfieldtypeforfield.md deleted file mode 100644 index 2f819950ca3..00000000000 --- a/docs/sources/packages_api/data/guessfieldtypeforfield.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "guessFieldTypeForField" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## guessFieldTypeForField() function - -### guessFieldTypeForField() function - -Looks at the data to guess the column type. This ignores any existing setting - -Signature - -```typescript -export declare function guessFieldTypeForField(field: Field): FieldType | undefined; -``` -Import - -```typescript -import { guessFieldTypeForField } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| field | Field | | - -Returns: - -`FieldType | undefined` - diff --git a/docs/sources/packages_api/data/guessfieldtypefromnameandvalue.md b/docs/sources/packages_api/data/guessfieldtypefromnameandvalue.md deleted file mode 100644 index 140ca65dadf..00000000000 --- a/docs/sources/packages_api/data/guessfieldtypefromnameandvalue.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "guessFieldTypeFromNameAndValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## guessFieldTypeFromNameAndValue() function - -### guessFieldTypeFromNameAndValue() function - -Given a name and value, this will pick a reasonable field type - -Signature - -```typescript -export declare function guessFieldTypeFromNameAndValue(name: string, v: any): FieldType; -``` -Import - -```typescript -import { guessFieldTypeFromNameAndValue } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| v | any | | - -Returns: - -`FieldType` - diff --git a/docs/sources/packages_api/data/guessfieldtypefromvalue.md b/docs/sources/packages_api/data/guessfieldtypefromvalue.md deleted file mode 100644 index f2486b1d126..00000000000 --- a/docs/sources/packages_api/data/guessfieldtypefromvalue.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "guessFieldTypeFromValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## guessFieldTypeFromValue() function - -### guessFieldTypeFromValue() function - -Given a value this will guess the best column type - -TODO: better Date/Time support! Look for standard date strings? - -Signature - -```typescript -export declare function guessFieldTypeFromValue(v: any): FieldType; -``` -Import - -```typescript -import { guessFieldTypeFromValue } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| v | any | | - -Returns: - -`FieldType` - diff --git a/docs/sources/packages_api/data/guessfieldtypes.md b/docs/sources/packages_api/data/guessfieldtypes.md deleted file mode 100644 index e192107848c..00000000000 --- a/docs/sources/packages_api/data/guessfieldtypes.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "guessFieldTypes" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## guessFieldTypes variable - -### guessFieldTypes variable - -Signature - -```typescript -guessFieldTypes: (series: DataFrame, guessDefined?: boolean) => DataFrame -``` -Import - -```typescript -import { guessFieldTypes } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/haslinks.md b/docs/sources/packages_api/data/haslinks.md deleted file mode 100644 index 9d8662cc4f5..00000000000 --- a/docs/sources/packages_api/data/haslinks.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "hasLinks" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## hasLinks() function - -### hasLinks() function - -Signature - -```typescript -export declare function hasLinks(field: Field): boolean; -``` -Import - -```typescript -import { hasLinks } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| field | Field | | - -Returns: - -`boolean` - diff --git a/docs/sources/packages_api/data/hasmsresolution.md b/docs/sources/packages_api/data/hasmsresolution.md deleted file mode 100644 index 5f55de033d0..00000000000 --- a/docs/sources/packages_api/data/hasmsresolution.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "hasMsResolution" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## hasMsResolution variable - -### hasMsResolution variable - -Checks if series time field has ms resolution - -Signature - -```typescript -hasMsResolution: (timeField: Field) => boolean -``` -Import - -```typescript -import { hasMsResolution } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/historyitem.md b/docs/sources/packages_api/data/historyitem.md deleted file mode 100644 index 768a1782779..00000000000 --- a/docs/sources/packages_api/data/historyitem.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "HistoryItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## HistoryItem interface - -Signature - -```typescript -export interface HistoryItem -``` -Import - -```typescript -import { HistoryItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [query](#query-property) | TQuery | | -| [ts](#ts-property) | number | | - -### query property - -Signature - -```typescript -query: TQuery; -``` - -### ts property - -Signature - -```typescript -ts: number; -``` diff --git a/docs/sources/packages_api/data/identityoverrideprocessor.md b/docs/sources/packages_api/data/identityoverrideprocessor.md deleted file mode 100644 index 16cceed4d66..00000000000 --- a/docs/sources/packages_api/data/identityoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "identityOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## identityOverrideProcessor variable - -### identityOverrideProcessor variable - -Signature - -```typescript -identityOverrideProcessor: (value: T, _context: FieldOverrideContext, _settings: any) => T -``` -Import - -```typescript -import { identityOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/internaltimezones.md b/docs/sources/packages_api/data/internaltimezones.md deleted file mode 100644 index bd21873e994..00000000000 --- a/docs/sources/packages_api/data/internaltimezones.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "InternalTimeZones" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## InternalTimeZones enum - -### InternalTimeZones enum - -Signature - -```typescript -export declare enum InternalTimeZones -``` -Import - -```typescript -import { InternalTimeZones } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| default | "" | | -| localBrowserTime | "browser" | | -| utc | "utc" | | - diff --git a/docs/sources/packages_api/data/interpolatefunction.md b/docs/sources/packages_api/data/interpolatefunction.md deleted file mode 100644 index 8e48470cc74..00000000000 --- a/docs/sources/packages_api/data/interpolatefunction.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "InterpolateFunction" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## InterpolateFunction type - -### InterpolateFunction type - -Signature - -```typescript -export declare type InterpolateFunction = (value: string, scopedVars?: ScopedVars, format?: string | Function) => string; -``` -Import - -```typescript -import { InterpolateFunction } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/intervalvalues.md b/docs/sources/packages_api/data/intervalvalues.md deleted file mode 100644 index dc52eebf0b9..00000000000 --- a/docs/sources/packages_api/data/intervalvalues.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "IntervalValues" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## IntervalValues interface - -Signature - -```typescript -export interface IntervalValues -``` -Import - -```typescript -import { IntervalValues } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [interval](#interval-property) | string | | -| [intervalMs](#intervalms-property) | number | | - -### interval property - -Signature - -```typescript -interval: string; -``` - -### intervalMs property - -Signature - -```typescript -intervalMs: number; -``` diff --git a/docs/sources/packages_api/data/isdataframe.md b/docs/sources/packages_api/data/isdataframe.md deleted file mode 100644 index 10506c38e13..00000000000 --- a/docs/sources/packages_api/data/isdataframe.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "isDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## isDataFrame variable - -### isDataFrame variable - -Signature - -```typescript -isDataFrame: (data: any) => data is DataFrame -``` -Import - -```typescript -import { isDataFrame } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/isdatetime.md b/docs/sources/packages_api/data/isdatetime.md deleted file mode 100644 index a7bde801ea2..00000000000 --- a/docs/sources/packages_api/data/isdatetime.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "isDateTime" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## isDateTime variable - -### isDateTime variable - -Signature - -```typescript -isDateTime: (value: any) => value is DateTime -``` -Import - -```typescript -import { isDateTime } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/iso_8601.md b/docs/sources/packages_api/data/iso_8601.md deleted file mode 100644 index 1192a825795..00000000000 --- a/docs/sources/packages_api/data/iso_8601.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ISO_8601" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ISO\_8601 variable - -### ISO\_8601 variable - -Signature - -```typescript -ISO_8601: DateTimeBuiltinFormat -``` -Import - -```typescript -import { ISO_8601 } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/istabledata.md b/docs/sources/packages_api/data/istabledata.md deleted file mode 100644 index 6dc76d1a3e7..00000000000 --- a/docs/sources/packages_api/data/istabledata.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "isTableData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## isTableData variable - -### isTableData variable - -Signature - -```typescript -isTableData: (data: any) => data is DataFrame -``` -Import - -```typescript -import { isTableData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/keyvalue.md b/docs/sources/packages_api/data/keyvalue.md deleted file mode 100644 index d5cc8953bf4..00000000000 --- a/docs/sources/packages_api/data/keyvalue.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "KeyValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## KeyValue type - -### KeyValue type - -Signature - -```typescript -export declare type KeyValue = { - [s: string]: T; -}; -``` -Import - -```typescript -import { KeyValue } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/labels.md b/docs/sources/packages_api/data/labels.md deleted file mode 100644 index 98e2e8a645c..00000000000 --- a/docs/sources/packages_api/data/labels.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Labels" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Labels interface - -Signature - -```typescript -export interface Labels -``` -Import - -```typescript -import { Labels } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/languageprovider.md b/docs/sources/packages_api/data/languageprovider.md deleted file mode 100644 index fa94e5fd70b..00000000000 --- a/docs/sources/packages_api/data/languageprovider.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LanguageProvider" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LanguageProvider class - -Signature - -```typescript -export declare abstract class LanguageProvider -``` -Import - -```typescript -import { LanguageProvider } from '@grafana/data'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [datasource](#datasource-property) | | DataSourceApi<any, any> | | -| [request](#request-property) | | (url: string, params?: any) => Promise<any> | | -| [start](#start-property) | | () => Promise<any[]> | Returns startTask that resolves with a task list when main syntax is loaded. Task list consists of secondary promises that load more detailed language features. | -| [startTask](#starttask-property) | | Promise<any[]> | | - -### datasource property - -Signature - -```typescript -abstract datasource: DataSourceApi; -``` - -### request property - -Signature - -```typescript -abstract request: (url: string, params?: any) => Promise; -``` - -### start property - -Returns startTask that resolves with a task list when main syntax is loaded. Task list consists of secondary promises that load more detailed language features. - -Signature - -```typescript -abstract start: () => Promise; -``` - -### startTask property - -Signature - -```typescript -startTask?: Promise; -``` diff --git a/docs/sources/packages_api/data/legacyresponsedata.md b/docs/sources/packages_api/data/legacyresponsedata.md deleted file mode 100644 index 9d835fff079..00000000000 --- a/docs/sources/packages_api/data/legacyresponsedata.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegacyResponseData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LegacyResponseData type - -### LegacyResponseData type - -Starting in v6.2 DataFrame can represent both TimeSeries and TableData - -Signature - -```typescript -export declare type LegacyResponseData = TimeSeries | TableData | any; -``` -Import - -```typescript -import { LegacyResponseData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/licenseinfo.md b/docs/sources/packages_api/data/licenseinfo.md deleted file mode 100644 index ece5008188b..00000000000 --- a/docs/sources/packages_api/data/licenseinfo.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LicenseInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LicenseInfo interface - -Describes the license information about the current running instance of Grafana. - -Signature - -```typescript -export interface LicenseInfo -``` -Import - -```typescript -import { LicenseInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [expiry](#expiry-property) | number | | -| [hasLicense](#haslicense-property) | boolean | | -| [licenseUrl](#licenseurl-property) | string | | -| [stateInfo](#stateinfo-property) | string | | - -### expiry property - -Signature - -```typescript -expiry: number; -``` - -### hasLicense property - -Signature - -```typescript -hasLicense: boolean; -``` - -### licenseUrl property - -Signature - -```typescript -licenseUrl: string; -``` - -### stateInfo property - -Signature - -```typescript -stateInfo: string; -``` diff --git a/docs/sources/packages_api/data/linkmodel.md b/docs/sources/packages_api/data/linkmodel.md deleted file mode 100644 index 5d28112ae9b..00000000000 --- a/docs/sources/packages_api/data/linkmodel.md +++ /dev/null @@ -1,72 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LinkModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LinkModel interface - -Processed Link Model. The values are ready to use - -Signature - -```typescript -export interface LinkModel -``` -Import - -```typescript -import { LinkModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [href](#href-property) | string | | -| [onClick](#onclick-property) | (e: any) => void | | -| [origin](#origin-property) | T | | -| [target](#target-property) | LinkTarget | | -| [title](#title-property) | string | | - -### href property - -Signature - -```typescript -href: string; -``` - -### onClick property - -Signature - -```typescript -onClick?: (e: any) => void; -``` - -### origin property - -Signature - -```typescript -origin: T; -``` - -### target property - -Signature - -```typescript -target: LinkTarget; -``` - -### title property - -Signature - -```typescript -title: string; -``` diff --git a/docs/sources/packages_api/data/linkmodelsupplier.md b/docs/sources/packages_api/data/linkmodelsupplier.md deleted file mode 100644 index b29d4b807aa..00000000000 --- a/docs/sources/packages_api/data/linkmodelsupplier.md +++ /dev/null @@ -1,48 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LinkModelSupplier" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LinkModelSupplier interface - -Provides a way to produce links on demand - -TODO: ScopedVars in in GrafanaUI package! - -Signature - -```typescript -export interface LinkModelSupplier -``` -Import - -```typescript -import { LinkModelSupplier } from '@grafana/data'; -``` -Methods - -| Method | Description | -| --- | --- | -| [getLinks(scopedVars)](#getlinks-method) | | - -### getLinks method - -Signature - -```typescript -getLinks(scopedVars?: any): Array>; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| scopedVars | any | | - -Returns: - -`Array>` - diff --git a/docs/sources/packages_api/data/linktarget.md b/docs/sources/packages_api/data/linktarget.md deleted file mode 100644 index 365dbbabb43..00000000000 --- a/docs/sources/packages_api/data/linktarget.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LinkTarget" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LinkTarget type - -### LinkTarget type - -Signature - -```typescript -export declare type LinkTarget = '_blank' | '_self' | undefined; -``` -Import - -```typescript -import { LinkTarget } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/loadingstate.md b/docs/sources/packages_api/data/loadingstate.md deleted file mode 100644 index 16d30cf56fd..00000000000 --- a/docs/sources/packages_api/data/loadingstate.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LoadingState" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LoadingState enum - -### LoadingState enum - -Represent panel data loading state. - -Signature - -```typescript -export declare enum LoadingState -``` -Import - -```typescript -import { LoadingState } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Done | "Done" | | -| Error | "Error" | | -| Loading | "Loading" | | -| NotStarted | "NotStarted" | | -| Streaming | "Streaming" | | - diff --git a/docs/sources/packages_api/data/locale.md b/docs/sources/packages_api/data/locale.md deleted file mode 100644 index fdfab4bbfe9..00000000000 --- a/docs/sources/packages_api/data/locale.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "locale" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## locale() function - -### locale() function - -Signature - -```typescript -export declare function locale(value: number, decimals: DecimalCount): FormattedValue; -``` -Import - -```typescript -import { locale } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | -| decimals | DecimalCount | | - -Returns: - -`FormattedValue` - diff --git a/docs/sources/packages_api/data/locationutil.md b/docs/sources/packages_api/data/locationutil.md deleted file mode 100644 index 1312d392e78..00000000000 --- a/docs/sources/packages_api/data/locationutil.md +++ /dev/null @@ -1,30 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "locationUtil" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## locationUtil variable - -### locationUtil variable - -Signature - -```typescript -locationUtil: { - initialize: ({ getConfig, buildParamsFromVariables, getTimeRangeForUrl }: LocationUtilDependencies) => void; - stripBaseFromUrl: (url: string) => string; - assureBaseUrl: (url: string) => string; - getTimeRangeUrlParams: () => string | null; - getVariablesUrlParams: (scopedVars?: ScopedVars | undefined) => string | null; - processUrl: (url: string) => string; -} -``` -Import - -```typescript -import { locationUtil } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/loglabelstatsmodel.md b/docs/sources/packages_api/data/loglabelstatsmodel.md deleted file mode 100644 index 24ab44ac854..00000000000 --- a/docs/sources/packages_api/data/loglabelstatsmodel.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogLabelStatsModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogLabelStatsModel interface - -Signature - -```typescript -export interface LogLabelStatsModel -``` -Import - -```typescript -import { LogLabelStatsModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [active](#active-property) | boolean | | -| [count](#count-property) | number | | -| [proportion](#proportion-property) | number | | -| [value](#value-property) | string | | - -### active property - -Signature - -```typescript -active?: boolean; -``` - -### count property - -Signature - -```typescript -count: number; -``` - -### proportion property - -Signature - -```typescript -proportion: number; -``` - -### value property - -Signature - -```typescript -value: string; -``` diff --git a/docs/sources/packages_api/data/loglevel.md b/docs/sources/packages_api/data/loglevel.md deleted file mode 100644 index d99630187f4..00000000000 --- a/docs/sources/packages_api/data/loglevel.md +++ /dev/null @@ -1,48 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogLevel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogLevel enum - -### LogLevel enum - -Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation. - -Signature - -```typescript -export declare enum LogLevel -``` -Import - -```typescript -import { LogLevel } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| alert | "critical" | | -| crit | "critical" | | -| critical | "critical" | | -| dbug | "debug" | | -| debug | "debug" | | -| emerg | "critical" | | -| eror | "error" | | -| err | "error" | | -| error | "error" | | -| fatal | "critical" | | -| info | "info" | | -| information | "info" | | -| notice | "info" | | -| trace | "trace" | | -| unknown | "unknown" | | -| warn | "warning" | | -| warning | "warning" | | - diff --git a/docs/sources/packages_api/data/logrowmodel.md b/docs/sources/packages_api/data/logrowmodel.md deleted file mode 100644 index 7e7bc2ab884..00000000000 --- a/docs/sources/packages_api/data/logrowmodel.md +++ /dev/null @@ -1,178 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogRowModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogRowModel interface - -Signature - -```typescript -export interface LogRowModel -``` -Import - -```typescript -import { LogRowModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataFrame](#dataframe-property) | DataFrame | | -| [duplicates](#duplicates-property) | number | | -| [entry](#entry-property) | string | | -| [entryFieldIndex](#entryfieldindex-property) | number | | -| [hasAnsi](#hasansi-property) | boolean | | -| [labels](#labels-property) | Labels | | -| [logLevel](#loglevel-property) | LogLevel | | -| [raw](#raw-property) | string | | -| [rowIndex](#rowindex-property) | number | | -| [searchWords](#searchwords-property) | string[] | | -| [timeEpochMs](#timeepochms-property) | number | | -| [timeEpochNs](#timeepochns-property) | string | | -| [timeFromNow](#timefromnow-property) | string | | -| [timeLocal](#timelocal-property) | string | | -| [timeUtc](#timeutc-property) | string | | -| [uid](#uid-property) | string | | -| [uniqueLabels](#uniquelabels-property) | Labels | | - -### dataFrame property - -Signature - -```typescript -dataFrame: DataFrame; -``` - -### duplicates property - -Signature - -```typescript -duplicates?: number; -``` - -### entry property - -Signature - -```typescript -entry: string; -``` - -### entryFieldIndex property - -Signature - -```typescript -entryFieldIndex: number; -``` - -### hasAnsi property - -Signature - -```typescript -hasAnsi: boolean; -``` - -### labels property - -Signature - -```typescript -labels: Labels; -``` - -### logLevel property - -Signature - -```typescript -logLevel: LogLevel; -``` - -### raw property - -Signature - -```typescript -raw: string; -``` - -### rowIndex property - -Signature - -```typescript -rowIndex: number; -``` - -### searchWords property - -Signature - -```typescript -searchWords?: string[]; -``` - -### timeEpochMs property - -Signature - -```typescript -timeEpochMs: number; -``` - -### timeEpochNs property - -Signature - -```typescript -timeEpochNs: string; -``` - -### timeFromNow property - -Signature - -```typescript -timeFromNow: string; -``` - -### timeLocal property - -Signature - -```typescript -timeLocal: string; -``` - -### timeUtc property - -Signature - -```typescript -timeUtc: string; -``` - -### uid property - -Signature - -```typescript -uid: string; -``` - -### uniqueLabels property - -Signature - -```typescript -uniqueLabels?: Labels; -``` diff --git a/docs/sources/packages_api/data/logsdedupdescription.md b/docs/sources/packages_api/data/logsdedupdescription.md deleted file mode 100644 index 56dc0f885a7..00000000000 --- a/docs/sources/packages_api/data/logsdedupdescription.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsDedupDescription" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsDedupDescription enum - -### LogsDedupDescription enum - -Signature - -```typescript -export declare enum LogsDedupDescription -``` -Import - -```typescript -import { LogsDedupDescription } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| exact | "De-duplication of successive lines that are identical, ignoring ISO datetimes." | | -| none | "No de-duplication" | | -| numbers | "De-duplication of successive lines that are identical when ignoring numbers, e.g., IP addresses, latencies." | | -| signature | "De-duplication of successive lines that have identical punctuation and whitespace." | | - diff --git a/docs/sources/packages_api/data/logsdedupstrategy.md b/docs/sources/packages_api/data/logsdedupstrategy.md deleted file mode 100644 index 4671056de44..00000000000 --- a/docs/sources/packages_api/data/logsdedupstrategy.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsDedupStrategy" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsDedupStrategy enum - -### LogsDedupStrategy enum - -Signature - -```typescript -export declare enum LogsDedupStrategy -``` -Import - -```typescript -import { LogsDedupStrategy } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| exact | "exact" | | -| none | "none" | | -| numbers | "numbers" | | -| signature | "signature" | | - diff --git a/docs/sources/packages_api/data/logsearchmatch.md b/docs/sources/packages_api/data/logsearchmatch.md deleted file mode 100644 index 25861b53004..00000000000 --- a/docs/sources/packages_api/data/logsearchmatch.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogSearchMatch" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogSearchMatch interface - -Signature - -```typescript -export interface LogSearchMatch -``` -Import - -```typescript -import { LogSearchMatch } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [length](#length-property) | number | | -| [start](#start-property) | number | | -| [text](#text-property) | string | | - -### length property - -Signature - -```typescript -length: number; -``` - -### start property - -Signature - -```typescript -start: number; -``` - -### text property - -Signature - -```typescript -text: string; -``` diff --git a/docs/sources/packages_api/data/logsmetaitem.md b/docs/sources/packages_api/data/logsmetaitem.md deleted file mode 100644 index d78bd9abaa1..00000000000 --- a/docs/sources/packages_api/data/logsmetaitem.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsMetaItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsMetaItem interface - -Signature - -```typescript -export interface LogsMetaItem -``` -Import - -```typescript -import { LogsMetaItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [kind](#kind-property) | LogsMetaKind | | -| [label](#label-property) | string | | -| [value](#value-property) | string | number | Labels | | - -### kind property - -Signature - -```typescript -kind: LogsMetaKind; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### value property - -Signature - -```typescript -value: string | number | Labels; -``` diff --git a/docs/sources/packages_api/data/logsmetakind.md b/docs/sources/packages_api/data/logsmetakind.md deleted file mode 100644 index c6da2565037..00000000000 --- a/docs/sources/packages_api/data/logsmetakind.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsMetaKind" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsMetaKind enum - -### LogsMetaKind enum - -Signature - -```typescript -export declare enum LogsMetaKind -``` -Import - -```typescript -import { LogsMetaKind } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| LabelsMap | 2 | | -| Number | 0 | | -| String | 1 | | - diff --git a/docs/sources/packages_api/data/logsmodel.md b/docs/sources/packages_api/data/logsmodel.md deleted file mode 100644 index 98cb96ef808..00000000000 --- a/docs/sources/packages_api/data/logsmodel.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsModel interface - -Signature - -```typescript -export interface LogsModel -``` -Import - -```typescript -import { LogsModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hasUniqueLabels](#hasuniquelabels-property) | boolean | | -| [meta](#meta-property) | LogsMetaItem[] | | -| [rows](#rows-property) | LogRowModel[] | | -| [series](#series-property) | GraphSeriesXY[] | | -| [visibleRange](#visiblerange-property) | AbsoluteTimeRange | | - -### hasUniqueLabels property - -Signature - -```typescript -hasUniqueLabels: boolean; -``` - -### meta property - -Signature - -```typescript -meta?: LogsMetaItem[]; -``` - -### rows property - -Signature - -```typescript -rows: LogRowModel[]; -``` - -### series property - -Signature - -```typescript -series?: GraphSeriesXY[]; -``` - -### visibleRange property - -Signature - -```typescript -visibleRange?: AbsoluteTimeRange; -``` diff --git a/docs/sources/packages_api/data/logsparser.md b/docs/sources/packages_api/data/logsparser.md deleted file mode 100644 index fa4eec4e444..00000000000 --- a/docs/sources/packages_api/data/logsparser.md +++ /dev/null @@ -1,80 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsParser" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsParser interface - -Signature - -```typescript -export interface LogsParser -``` -Import - -```typescript -import { LogsParser } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [buildMatcher](#buildmatcher-property) | (label: string) => RegExp | Value-agnostic matcher for a field label. Used to filter rows, and first capture group contains the value. | -| [getFields](#getfields-property) | (line: string) => string[] | Returns all parsable substrings from a line, used for highlighting | -| [getLabelFromField](#getlabelfromfield-property) | (field: string) => string | Gets the label name from a parsable substring of a line | -| [getValueFromField](#getvaluefromfield-property) | (field: string) => string | Gets the label value from a parsable substring of a line | -| [test](#test-property) | (line: string) => any | Function to verify if this is a valid parser for the given line. The parser accepts the line unless it returns undefined. | - -### buildMatcher property - -Value-agnostic matcher for a field label. Used to filter rows, and first capture group contains the value. - -Signature - -```typescript -buildMatcher: (label: string) => RegExp; -``` - -### getFields property - -Returns all parsable substrings from a line, used for highlighting - -Signature - -```typescript -getFields: (line: string) => string[]; -``` - -### getLabelFromField property - -Gets the label name from a parsable substring of a line - -Signature - -```typescript -getLabelFromField: (field: string) => string; -``` - -### getValueFromField property - -Gets the label value from a parsable substring of a line - -Signature - -```typescript -getValueFromField: (field: string) => string; -``` - -### test property - -Function to verify if this is a valid parser for the given line. The parser accepts the line unless it returns undefined. - -Signature - -```typescript -test: (line: string) => any; -``` diff --git a/docs/sources/packages_api/data/logsparsers.md b/docs/sources/packages_api/data/logsparsers.md deleted file mode 100644 index 7afe4648755..00000000000 --- a/docs/sources/packages_api/data/logsparsers.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogsParsers" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## LogsParsers variable - -### LogsParsers variable - -Signature - -```typescript -LogsParsers: { - [name: string]: LogsParser; -} -``` -Import - -```typescript -import { LogsParsers } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/mappingtype.md b/docs/sources/packages_api/data/mappingtype.md deleted file mode 100644 index c676dbda1bc..00000000000 --- a/docs/sources/packages_api/data/mappingtype.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MappingType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MappingType enum - -### MappingType enum - -Signature - -```typescript -export declare enum MappingType -``` -Import - -```typescript -import { MappingType } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| RangeToText | 2 | | -| ValueToText | 1 | | - diff --git a/docs/sources/packages_api/data/matcherconfig.md b/docs/sources/packages_api/data/matcherconfig.md deleted file mode 100644 index a6a87c01ec7..00000000000 --- a/docs/sources/packages_api/data/matcherconfig.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MatcherConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MatcherConfig interface - -Signature - -```typescript -export interface MatcherConfig -``` -Import - -```typescript -import { MatcherConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](#id-property) | string | | -| [options](#options-property) | TOptions | | - -### id property - -Signature - -```typescript -id: string; -``` - -### options property - -Signature - -```typescript -options?: TOptions; -``` diff --git a/docs/sources/packages_api/data/matcherid.md b/docs/sources/packages_api/data/matcherid.md deleted file mode 100644 index 108b4e19244..00000000000 --- a/docs/sources/packages_api/data/matcherid.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MatcherID" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MatcherID enum - -### MatcherID enum - -Signature - -```typescript -export declare enum MatcherID -``` -Import - -```typescript -import { MatcherID } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| allMatch | "allMatch" | | -| alwaysMatch | "alwaysMatch" | | -| anyMatch | "anyMatch" | | -| invertMatch | "invertMatch" | | -| neverMatch | "neverMatch" | | - diff --git a/docs/sources/packages_api/data/metadatainspectorprops.md b/docs/sources/packages_api/data/metadatainspectorprops.md deleted file mode 100644 index 3ab1ed4a789..00000000000 --- a/docs/sources/packages_api/data/metadatainspectorprops.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MetadataInspectorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MetadataInspectorProps interface - -Signature - -```typescript -export interface MetadataInspectorProps, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> -``` -Import - -```typescript -import { MetadataInspectorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | DataFrame[] | | -| [datasource](#datasource-property) | DSType | | - -### data property - -Signature - -```typescript -data: DataFrame[]; -``` - -### datasource property - -Signature - -```typescript -datasource: DSType; -``` diff --git a/docs/sources/packages_api/data/metricfindvalue.md b/docs/sources/packages_api/data/metricfindvalue.md deleted file mode 100644 index e956542cdd2..00000000000 --- a/docs/sources/packages_api/data/metricfindvalue.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MetricFindValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MetricFindValue interface - -Signature - -```typescript -export interface MetricFindValue -``` -Import - -```typescript -import { MetricFindValue } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [text](#text-property) | string | | - -### text property - -Signature - -```typescript -text: string; -``` diff --git a/docs/sources/packages_api/data/missing_value.md b/docs/sources/packages_api/data/missing_value.md deleted file mode 100644 index 83d5cd871c3..00000000000 --- a/docs/sources/packages_api/data/missing_value.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MISSING_VALUE" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MISSING\_VALUE variable - -### MISSING\_VALUE variable - -Signature - -```typescript -MISSING_VALUE: any -``` -Import - -```typescript -import { MISSING_VALUE } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/ms_date_time_format.md b/docs/sources/packages_api/data/ms_date_time_format.md deleted file mode 100644 index 7a1343f5bbd..00000000000 --- a/docs/sources/packages_api/data/ms_date_time_format.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MS_DATE_TIME_FORMAT" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MS\_DATE\_TIME\_FORMAT variable - -### MS\_DATE\_TIME\_FORMAT variable - -Signature - -```typescript -MS_DATE_TIME_FORMAT = "YYYY-MM-DD HH:mm:ss.SSS" -``` -Import - -```typescript -import { MS_DATE_TIME_FORMAT } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/mutabledataframe.md b/docs/sources/packages_api/data/mutabledataframe.md deleted file mode 100644 index fe43efe6518..00000000000 --- a/docs/sources/packages_api/data/mutabledataframe.md +++ /dev/null @@ -1,266 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MutableDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MutableDataFrame class - -Signature - -```typescript -export declare class MutableDataFrame extends FunctionalVector implements DataFrame, MutableVector -``` -Import - -```typescript -import { MutableDataFrame } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(source, creator)](#constructor-sourcecreator) | | Constructs a new instance of the MutableDataFrame class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [fields](#fields-property) | | MutableField[] | | -| [length](#length-property) | | number | | -| [meta](#meta-property) | | QueryResultMeta | | -| [name](#name-property) | | string | | -| [refId](#refid-property) | | string | | -| [values](#values-property) | | KeyValue<MutableVector> | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [add(value, addMissingFields)](#add-method) | | Add all properties of the value as fields on the frame | -| [addField(f, startLength)](#addfield-method) | | | -| [addFieldFor(value, name)](#addfieldfor-method) | | | -| [appendRow(row)](#appendrow-method) | | This will add each value to the corresponding column | -| [get(idx)](#get-method) | | Get an object with a property for each field in the DataFrame | -| [reverse()](#reverse-method) | | Reverse all values | -| [set(index, value, addMissingFields)](#set-method) | | | -| [toJSON()](#tojson-method) | | The simplified JSON values used in JSON.stringify() | -| [validate()](#validate-method) | | | - -### constructor(source, creator) - -Constructs a new instance of the `MutableDataFrame` class - -Signature - -```typescript -constructor(source?: DataFrame | DataFrameDTO, creator?: MutableVectorCreator); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| source | DataFrame | DataFrameDTO | | -| creator | MutableVectorCreator | | - -### fields property - -Signature - -```typescript -fields: MutableField[]; -``` - -### length property - -Signature - -```typescript -get length(): number; -``` - -### meta property - -Signature - -```typescript -meta?: QueryResultMeta; -``` - -### name property - -Signature - -```typescript -name?: string; -``` - -### refId property - -Signature - -```typescript -refId?: string; -``` - -### values property - -Signature - -```typescript -values: KeyValue; -``` - -### add method - -Add all properties of the value as fields on the frame - -Signature - -```typescript -add(value: T, addMissingFields?: boolean): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | T | | -| addMissingFields | boolean | | - -Returns: - -`void` - -### addField method - -Signature - -```typescript -addField(f: Field | FieldDTO, startLength?: number): MutableField; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| f | Field | FieldDTO | | -| startLength | number | | - -Returns: - -`MutableField` - -### addFieldFor method - -Signature - -```typescript -addFieldFor(value: any, name?: string): MutableField; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | any | | -| name | string | | - -Returns: - -`MutableField` - -### appendRow method - -This will add each value to the corresponding column - -Signature - -```typescript -appendRow(row: any[]): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| row | any[] | | - -Returns: - -`void` - -### get method - -Get an object with a property for each field in the DataFrame - -Signature - -```typescript -get(idx: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| idx | number | | - -Returns: - -`T` - -### reverse method - -Reverse all values - -Signature - -```typescript -reverse(): void; -``` -Returns: - -`void` - -### set method - -Signature - -```typescript -set(index: number, value: T, addMissingFields?: boolean): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | -| value | T | | -| addMissingFields | boolean | | - -Returns: - -`void` - -### toJSON method - -The simplified JSON values used in JSON.stringify() - -Signature - -```typescript -toJSON(): DataFrameDTO; -``` -Returns: - -`DataFrameDTO` - -### validate method - -Signature - -```typescript -validate(): void; -``` -Returns: - -`void` - diff --git a/docs/sources/packages_api/data/mutablefield.md b/docs/sources/packages_api/data/mutablefield.md deleted file mode 100644 index e4350bc6feb..00000000000 --- a/docs/sources/packages_api/data/mutablefield.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MutableField" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MutableField type - -### MutableField type - -Signature - -```typescript -export declare type MutableField = Field>; -``` -Import - -```typescript -import { MutableField } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/mutablevector.md b/docs/sources/packages_api/data/mutablevector.md deleted file mode 100644 index 71cae682bc0..00000000000 --- a/docs/sources/packages_api/data/mutablevector.md +++ /dev/null @@ -1,49 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MutableVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## MutableVector interface - -Vector with standard manipulation functions - -Signature - -```typescript -export interface MutableVector extends ReadWriteVector -``` -Import - -```typescript -import { MutableVector } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [add](#add-property) | (value: T) => void | Adds the value to the vector | -| [reverse](#reverse-property) | () => void | modifies the vector so it is now the opposite order | - -### add property - -Adds the value to the vector - -Signature - -```typescript -add: (value: T) => void; -``` - -### reverse property - -modifies the vector so it is now the opposite order - -Signature - -```typescript -reverse: () => void; -``` diff --git a/docs/sources/packages_api/data/navindex.md b/docs/sources/packages_api/data/navindex.md deleted file mode 100644 index bbae1c760b6..00000000000 --- a/docs/sources/packages_api/data/navindex.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NavIndex" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## NavIndex type - -### NavIndex type - -Signature - -```typescript -export declare type NavIndex = { - [s: string]: NavModelItem; -}; -``` -Import - -```typescript -import { NavIndex } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/navmodel.md b/docs/sources/packages_api/data/navmodel.md deleted file mode 100644 index 42ff09ed7d8..00000000000 --- a/docs/sources/packages_api/data/navmodel.md +++ /dev/null @@ -1,60 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NavModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## NavModel interface - -Interface used to describe different kinds of page titles and page navigation. Navmodels are usually generated in the backend and stored in Redux. - -Signature - -```typescript -export interface NavModel -``` -Import - -```typescript -import { NavModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [breadcrumbs](#breadcrumbs-property) | NavModelItem[] | Describes breadcrumbs that are used in places such as data source settings., folder page and plugins page. | -| [main](#main-property) | NavModelItem | Main page. that wraps the navigation. Generate the children property generate tabs when used with the Page component. | -| [node](#node-property) | NavModelItem | This is the current active tab/navigation. | - -### breadcrumbs property - -Describes breadcrumbs that are used in places such as data source settings., folder page and plugins page. - -Signature - -```typescript -breadcrumbs?: NavModelItem[]; -``` - -### main property - -Main page. that wraps the navigation. Generate the `children` property generate tabs when used with the Page component. - -Signature - -```typescript -main: NavModelItem; -``` - -### node property - -This is the current active tab/navigation. - -Signature - -```typescript -node: NavModelItem; -``` diff --git a/docs/sources/packages_api/data/navmodelbreadcrumb.md b/docs/sources/packages_api/data/navmodelbreadcrumb.md deleted file mode 100644 index 70490cbab11..00000000000 --- a/docs/sources/packages_api/data/navmodelbreadcrumb.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NavModelBreadcrumb" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## NavModelBreadcrumb interface - -Signature - -```typescript -export interface NavModelBreadcrumb -``` -Import - -```typescript -import { NavModelBreadcrumb } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [title](#title-property) | string | | -| [url](#url-property) | string | | - -### title property - -Signature - -```typescript -title: string; -``` - -### url property - -Signature - -```typescript -url?: string; -``` diff --git a/docs/sources/packages_api/data/navmodelitem.md b/docs/sources/packages_api/data/navmodelitem.md deleted file mode 100644 index ae2771ae58e..00000000000 --- a/docs/sources/packages_api/data/navmodelitem.md +++ /dev/null @@ -1,160 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NavModelItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## NavModelItem interface - -Signature - -```typescript -export interface NavModelItem -``` -Import - -```typescript -import { NavModelItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [active](#active-property) | boolean | | -| [breadcrumbs](#breadcrumbs-property) | NavModelBreadcrumb[] | | -| [children](#children-property) | NavModelItem[] | | -| [divider](#divider-property) | boolean | | -| [hideFromMenu](#hidefrommenu-property) | boolean | | -| [hideFromTabs](#hidefromtabs-property) | boolean | | -| [icon](#icon-property) | string | | -| [id](#id-property) | string | | -| [img](#img-property) | string | | -| [parentItem](#parentitem-property) | NavModelItem | | -| [showOrgSwitcher](#showorgswitcher-property) | boolean | | -| [subTitle](#subtitle-property) | string | | -| [target](#target-property) | string | | -| [text](#text-property) | string | | -| [url](#url-property) | string | | - -### active property - -Signature - -```typescript -active?: boolean; -``` - -### breadcrumbs property - -Signature - -```typescript -breadcrumbs?: NavModelBreadcrumb[]; -``` - -### children property - -Signature - -```typescript -children?: NavModelItem[]; -``` - -### divider property - -Signature - -```typescript -divider?: boolean; -``` - -### hideFromMenu property - -Signature - -```typescript -hideFromMenu?: boolean; -``` - -### hideFromTabs property - -Signature - -```typescript -hideFromTabs?: boolean; -``` - -### icon property - -Signature - -```typescript -icon?: string; -``` - -### id property - -Signature - -```typescript -id?: string; -``` - -### img property - -Signature - -```typescript -img?: string; -``` - -### parentItem property - -Signature - -```typescript -parentItem?: NavModelItem; -``` - -### showOrgSwitcher property - -Signature - -```typescript -showOrgSwitcher?: boolean; -``` - -### subTitle property - -Signature - -```typescript -subTitle?: string; -``` - -### target property - -Signature - -```typescript -target?: string; -``` - -### text property - -Signature - -```typescript -text: string; -``` - -### url property - -Signature - -```typescript -url?: string; -``` diff --git a/docs/sources/packages_api/data/nullvaluemode.md b/docs/sources/packages_api/data/nullvaluemode.md deleted file mode 100644 index 92392ce02c9..00000000000 --- a/docs/sources/packages_api/data/nullvaluemode.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NullValueMode" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## NullValueMode enum - -### NullValueMode enum - -Signature - -```typescript -export declare enum NullValueMode -``` -Import - -```typescript -import { NullValueMode } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| AsZero | "null as zero" | | -| Ignore | "connected" | | -| Null | "null" | | - diff --git a/docs/sources/packages_api/data/numberfieldconfigsettings.md b/docs/sources/packages_api/data/numberfieldconfigsettings.md deleted file mode 100644 index cf0044e46c9..00000000000 --- a/docs/sources/packages_api/data/numberfieldconfigsettings.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NumberFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## NumberFieldConfigSettings interface - -Signature - -```typescript -export interface NumberFieldConfigSettings -``` -Import - -```typescript -import { NumberFieldConfigSettings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [integer](#integer-property) | boolean | | -| [max](#max-property) | number | | -| [min](#min-property) | number | | -| [placeholder](#placeholder-property) | string | | -| [step](#step-property) | number | | - -### integer property - -Signature - -```typescript -integer?: boolean; -``` - -### max property - -Signature - -```typescript -max?: number; -``` - -### min property - -Signature - -```typescript -min?: number; -``` - -### placeholder property - -Signature - -```typescript -placeholder?: string; -``` - -### step property - -Signature - -```typescript -step?: number; -``` diff --git a/docs/sources/packages_api/data/numberoverrideprocessor.md b/docs/sources/packages_api/data/numberoverrideprocessor.md deleted file mode 100644 index 5b1b9c90db5..00000000000 --- a/docs/sources/packages_api/data/numberoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "numberOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## numberOverrideProcessor variable - -### numberOverrideProcessor variable - -Signature - -```typescript -numberOverrideProcessor: (value: any, context: FieldOverrideContext, settings?: NumberFieldConfigSettings | undefined) => number | undefined -``` -Import - -```typescript -import { numberOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/objremoveundefined.md b/docs/sources/packages_api/data/objremoveundefined.md deleted file mode 100644 index 1680437700f..00000000000 --- a/docs/sources/packages_api/data/objremoveundefined.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "objRemoveUndefined" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## objRemoveUndefined variable - -### objRemoveUndefined variable - -Signature - -```typescript -objRemoveUndefined: (obj: any) => any -``` -Import - -```typescript -import { objRemoveUndefined } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/omit_2.md b/docs/sources/packages_api/data/omit_2.md deleted file mode 100644 index cd75aaae899..00000000000 --- a/docs/sources/packages_api/data/omit_2.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Omit_2" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Omit\_2 type - -### Omit\_2 type - -Signature - -```typescript -export declare type Omit = Pick>; -``` -Import - -```typescript -import { Omit_2 } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourcejsondataoption.md b/docs/sources/packages_api/data/onupdatedatasourcejsondataoption.md deleted file mode 100644 index d0d78830a67..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourcejsondataoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceJsonDataOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceJsonDataOption variable - -### onUpdateDatasourceJsonDataOption variable - -Signature - -```typescript -onUpdateDatasourceJsonDataOption: (props: DataSourcePluginOptionsEditorProps, key: K) => (event: React.SyntheticEvent) => void -``` -Import - -```typescript -import { onUpdateDatasourceJsonDataOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourcejsondataoptionchecked.md b/docs/sources/packages_api/data/onupdatedatasourcejsondataoptionchecked.md deleted file mode 100644 index 58999aa9700..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourcejsondataoptionchecked.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceJsonDataOptionChecked" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceJsonDataOptionChecked variable - -### onUpdateDatasourceJsonDataOptionChecked variable - -Signature - -```typescript -onUpdateDatasourceJsonDataOptionChecked: (props: DataSourcePluginOptionsEditorProps, key: K) => (event: React.SyntheticEvent) => void -``` -Import - -```typescript -import { onUpdateDatasourceJsonDataOptionChecked } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourcejsondataoptionselect.md b/docs/sources/packages_api/data/onupdatedatasourcejsondataoptionselect.md deleted file mode 100644 index e75a340d0d4..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourcejsondataoptionselect.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceJsonDataOptionSelect" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceJsonDataOptionSelect variable - -### onUpdateDatasourceJsonDataOptionSelect variable - -Signature - -```typescript -onUpdateDatasourceJsonDataOptionSelect: (props: DataSourcePluginOptionsEditorProps, key: K) => (selected: SelectableValue) => void -``` -Import - -```typescript -import { onUpdateDatasourceJsonDataOptionSelect } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourceoption.md b/docs/sources/packages_api/data/onupdatedatasourceoption.md deleted file mode 100644 index fbc35f4789b..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourceoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceOption variable - -### onUpdateDatasourceOption variable - -Signature - -```typescript -onUpdateDatasourceOption: (props: DataSourcePluginOptionsEditorProps, key: keyof DataSourceSettings) => (event: React.SyntheticEvent) => void -``` -Import - -```typescript -import { onUpdateDatasourceOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourceresetoption.md b/docs/sources/packages_api/data/onupdatedatasourceresetoption.md deleted file mode 100644 index fb403ea02d1..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourceresetoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceResetOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceResetOption variable - -### onUpdateDatasourceResetOption variable - -Signature - -```typescript -onUpdateDatasourceResetOption: (props: DataSourcePluginOptionsEditorProps, key: string) => (event: React.MouseEvent) => void -``` -Import - -```typescript -import { onUpdateDatasourceResetOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoption.md b/docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoption.md deleted file mode 100644 index 13fcdb0c069..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceSecureJsonDataOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceSecureJsonDataOption variable - -### onUpdateDatasourceSecureJsonDataOption variable - -Signature - -```typescript -onUpdateDatasourceSecureJsonDataOption: >(props: DataSourcePluginOptionsEditorProps, key: string) => (event: React.SyntheticEvent) => void -``` -Import - -```typescript -import { onUpdateDatasourceSecureJsonDataOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoptionselect.md b/docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoptionselect.md deleted file mode 100644 index c5d87a4427c..00000000000 --- a/docs/sources/packages_api/data/onupdatedatasourcesecurejsondataoptionselect.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "onUpdateDatasourceSecureJsonDataOptionSelect" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## onUpdateDatasourceSecureJsonDataOptionSelect variable - -### onUpdateDatasourceSecureJsonDataOptionSelect variable - -Signature - -```typescript -onUpdateDatasourceSecureJsonDataOptionSelect: >(props: DataSourcePluginOptionsEditorProps, key: string) => (selected: SelectableValue) => void -``` -Import - -```typescript -import { onUpdateDatasourceSecureJsonDataOptionSelect } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/orgrole.md b/docs/sources/packages_api/data/orgrole.md deleted file mode 100644 index 172776b33eb..00000000000 --- a/docs/sources/packages_api/data/orgrole.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "OrgRole" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## OrgRole enum - -### OrgRole enum - -Signature - -```typescript -export declare enum OrgRole -``` -Import - -```typescript -import { OrgRole } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Admin | "Admin" | | -| Editor | "Editor" | | -| Viewer | "Viewer" | | - diff --git a/docs/sources/packages_api/data/paneldata.md b/docs/sources/packages_api/data/paneldata.md deleted file mode 100644 index dd832d6fb29..00000000000 --- a/docs/sources/packages_api/data/paneldata.md +++ /dev/null @@ -1,91 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelData interface - -Signature - -```typescript -export interface PanelData -``` -Import - -```typescript -import { PanelData } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](#error-property) | DataQueryError | Any query errors | -| [request](#request-property) | DataQueryRequest | Request contains the queries and properties sent to the datasource | -| [series](#series-property) | DataFrame[] | Contains data frames with field overrides applied | -| [state](#state-property) | LoadingState | State of the data (loading, done, error, streaming) | -| [timeRange](#timerange-property) | TimeRange | Contains the range from the request or a shifted time range if a request uses relative time | -| [timings](#timings-property) | DataQueryTimings | Timing measurements | - -### error property - -Any query errors - -Signature - -```typescript -error?: DataQueryError; -``` - -### request property - -Request contains the queries and properties sent to the datasource - -Signature - -```typescript -request?: DataQueryRequest; -``` - -### series property - -Contains data frames with field overrides applied - -Signature - -```typescript -series: DataFrame[]; -``` - -### state property - -State of the data (loading, done, error, streaming) - -Signature - -```typescript -state: LoadingState; -``` - -### timeRange property - -Contains the range from the request or a shifted time range if a request uses relative time - -Signature - -```typescript -timeRange: TimeRange; -``` - -### timings property - -Timing measurements - -Signature - -```typescript -timings?: DataQueryTimings; -``` diff --git a/docs/sources/packages_api/data/paneleditorprops.md b/docs/sources/packages_api/data/paneleditorprops.md deleted file mode 100644 index 8ce41cb0297..00000000000 --- a/docs/sources/packages_api/data/paneleditorprops.md +++ /dev/null @@ -1,58 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEditorProps interface - -Signature - -```typescript -export interface PanelEditorProps -``` -Import - -```typescript -import { PanelEditorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | PanelData | Result set of panel queries | -| [onOptionsChange](#onoptionschange-property) | (options: T, callback?: () => void) => void | Panel options change handler | -| [options](#options-property) | T | Panel options | - -### data property - -Result set of panel queries - -Signature - -```typescript -data: PanelData; -``` - -### onOptionsChange property - -Panel options change handler - -Signature - -```typescript -onOptionsChange: (options: T, callback?: () => void) => void; -``` - -### options property - -Panel options - -Signature - -```typescript -options: T; -``` diff --git a/docs/sources/packages_api/data/panelevents.md b/docs/sources/packages_api/data/panelevents.md deleted file mode 100644 index 73c929bb685..00000000000 --- a/docs/sources/packages_api/data/panelevents.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelEvents" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents namespace - -> 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. -> - -### PanelEvents namespace - -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -``` - -## Interfaces - -| Interface | Description | -| --- | --- | -| [PanelChangeViewPayload](./panelchangeviewpayload/) | Payloads | - -## Variables - -| Variable | Description | -| --- | --- | -| [componentDidMount](./componentdidmount/) | | -| [dataError](./dataerror/) | | -| [dataFramesReceived](./dataframesreceived/) | | -| [dataReceived](./datareceived/) | | -| [dataSnapshotLoad](./datasnapshotload/) | | -| [editModeInitialized](./editmodeinitialized/) | | -| [initPanelActions](./initpanelactions/) | | -| [panelChangeView](./panelchangeview/) | | -| [panelInitialized](./panelinitialized/) | | -| [panelSizeChanged](./panelsizechanged/) | | -| [panelTeardown](./panelteardown/) | | -| [refresh](./refresh/) | Events | -| [render](./render/) | | -| [viewModeChanged](./viewmodechanged/) | | - diff --git a/docs/sources/packages_api/data/panelevents/componentdidmount.md b/docs/sources/packages_api/data/panelevents/componentdidmount.md deleted file mode 100644 index 83c0332c660..00000000000 --- a/docs/sources/packages_api/data/panelevents/componentdidmount.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "componentDidMount" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.componentDidMount variable - -### PanelEvents.componentDidMount variable - -Signature - -```typescript -componentDidMount: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { componentDidMount } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/dataerror.md b/docs/sources/packages_api/data/panelevents/dataerror.md deleted file mode 100644 index dfd03f42bb8..00000000000 --- a/docs/sources/packages_api/data/panelevents/dataerror.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dataError" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.dataError variable - -### PanelEvents.dataError variable - -Signature - -```typescript -dataError: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { dataError } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/dataframesreceived.md b/docs/sources/packages_api/data/panelevents/dataframesreceived.md deleted file mode 100644 index 6b101f8ffe3..00000000000 --- a/docs/sources/packages_api/data/panelevents/dataframesreceived.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dataFramesReceived" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.dataFramesReceived variable - -### PanelEvents.dataFramesReceived variable - -Signature - -```typescript -dataFramesReceived: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { dataFramesReceived } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/datareceived.md b/docs/sources/packages_api/data/panelevents/datareceived.md deleted file mode 100644 index 4f103baf35a..00000000000 --- a/docs/sources/packages_api/data/panelevents/datareceived.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dataReceived" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.dataReceived variable - -### PanelEvents.dataReceived variable - -Signature - -```typescript -dataReceived: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { dataReceived } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/datasnapshotload.md b/docs/sources/packages_api/data/panelevents/datasnapshotload.md deleted file mode 100644 index f4c6a0049fc..00000000000 --- a/docs/sources/packages_api/data/panelevents/datasnapshotload.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "dataSnapshotLoad" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.dataSnapshotLoad variable - -### PanelEvents.dataSnapshotLoad variable - -Signature - -```typescript -dataSnapshotLoad: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { dataSnapshotLoad } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/editmodeinitialized.md b/docs/sources/packages_api/data/panelevents/editmodeinitialized.md deleted file mode 100644 index 9dc6dbcbba1..00000000000 --- a/docs/sources/packages_api/data/panelevents/editmodeinitialized.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "editModeInitialized" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.editModeInitialized variable - -### PanelEvents.editModeInitialized variable - -Signature - -```typescript -editModeInitialized: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { editModeInitialized } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/initpanelactions.md b/docs/sources/packages_api/data/panelevents/initpanelactions.md deleted file mode 100644 index ae8d81563a1..00000000000 --- a/docs/sources/packages_api/data/panelevents/initpanelactions.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "initPanelActions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.initPanelActions variable - -### PanelEvents.initPanelActions variable - -Signature - -```typescript -initPanelActions: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { initPanelActions } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/panelchangeview.md b/docs/sources/packages_api/data/panelevents/panelchangeview.md deleted file mode 100644 index 1c5a72724ac..00000000000 --- a/docs/sources/packages_api/data/panelevents/panelchangeview.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "panelChangeView" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.panelChangeView variable - -### PanelEvents.panelChangeView variable - -Signature - -```typescript -panelChangeView: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { panelChangeView } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/panelchangeviewpayload.md b/docs/sources/packages_api/data/panelevents/panelchangeviewpayload.md deleted file mode 100644 index 1e9acc32175..00000000000 --- a/docs/sources/packages_api/data/panelevents/panelchangeviewpayload.md +++ /dev/null @@ -1,64 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelChangeViewPayload" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.PanelChangeViewPayload interface - -Payloads - -Signature - -```typescript -export interface PanelChangeViewPayload -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { PanelChangeViewPayload } = PanelEvents; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [edit](#edit-property) | boolean | | -| [fullscreen](#fullscreen-property) | boolean | | -| [panelId](#panelid-property) | number | | -| [toggle](#toggle-property) | boolean | | - -### edit property - -Signature - -```typescript -edit?: boolean; -``` - -### fullscreen property - -Signature - -```typescript -fullscreen?: boolean; -``` - -### panelId property - -Signature - -```typescript -panelId?: number; -``` - -### toggle property - -Signature - -```typescript -toggle?: boolean; -``` diff --git a/docs/sources/packages_api/data/panelevents/panelinitialized.md b/docs/sources/packages_api/data/panelevents/panelinitialized.md deleted file mode 100644 index 6eff6f494d4..00000000000 --- a/docs/sources/packages_api/data/panelevents/panelinitialized.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "panelInitialized" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.panelInitialized variable - -### PanelEvents.panelInitialized variable - -Signature - -```typescript -panelInitialized: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { panelInitialized } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/panelsizechanged.md b/docs/sources/packages_api/data/panelevents/panelsizechanged.md deleted file mode 100644 index cf9d6ffea38..00000000000 --- a/docs/sources/packages_api/data/panelevents/panelsizechanged.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "panelSizeChanged" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.panelSizeChanged variable - -### PanelEvents.panelSizeChanged variable - -Signature - -```typescript -panelSizeChanged: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { panelSizeChanged } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/panelteardown.md b/docs/sources/packages_api/data/panelevents/panelteardown.md deleted file mode 100644 index 5ca17ac438f..00000000000 --- a/docs/sources/packages_api/data/panelevents/panelteardown.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "panelTeardown" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.panelTeardown variable - -### PanelEvents.panelTeardown variable - -Signature - -```typescript -panelTeardown: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { panelTeardown } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/refresh.md b/docs/sources/packages_api/data/panelevents/refresh.md deleted file mode 100644 index be79b976807..00000000000 --- a/docs/sources/packages_api/data/panelevents/refresh.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "refresh" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.refresh variable - -### PanelEvents.refresh variable - -Events - -Signature - -```typescript -refresh: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { refresh } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/render.md b/docs/sources/packages_api/data/panelevents/render.md deleted file mode 100644 index 28e47b2bf2e..00000000000 --- a/docs/sources/packages_api/data/panelevents/render.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "render" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.render variable - -### PanelEvents.render variable - -Signature - -```typescript -render: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { render } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelevents/viewmodechanged.md b/docs/sources/packages_api/data/panelevents/viewmodechanged.md deleted file mode 100644 index 83b61a93edb..00000000000 --- a/docs/sources/packages_api/data/panelevents/viewmodechanged.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "viewModeChanged" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelEvents.viewModeChanged variable - -### PanelEvents.viewModeChanged variable - -Signature - -```typescript -viewModeChanged: import("./appEvents").AppEvent -``` -Import - -```typescript -import { PanelEvents } from '@grafana/data'; -const { viewModeChanged } = PanelEvents; -``` diff --git a/docs/sources/packages_api/data/panelmigrationhandler.md b/docs/sources/packages_api/data/panelmigrationhandler.md deleted file mode 100644 index 7ee6d33ac85..00000000000 --- a/docs/sources/packages_api/data/panelmigrationhandler.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelMigrationHandler" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelMigrationHandler type - -### PanelMigrationHandler type - -Called when a panel is first loaded with current panel model - -Signature - -```typescript -export declare type PanelMigrationHandler = (panel: PanelModel) => Partial; -``` -Import - -```typescript -import { PanelMigrationHandler } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/panelmodel.md b/docs/sources/packages_api/data/panelmodel.md deleted file mode 100644 index 40ac0a911da..00000000000 --- a/docs/sources/packages_api/data/panelmodel.md +++ /dev/null @@ -1,78 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelModel interface - -Signature - -```typescript -export interface PanelModel -``` -Import - -```typescript -import { PanelModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldConfig](#fieldconfig-property) | FieldConfigSource | Field options configuration | -| [id](#id-property) | number | ID of the panel within the current dashboard | -| [options](#options-property) | TOptions | Panel options | -| [pluginVersion](#pluginversion-property) | string | Version of the panel plugin | -| [scopedVars](#scopedvars-property) | ScopedVars | | - -### fieldConfig property - -Field options configuration - -Signature - -```typescript -fieldConfig: FieldConfigSource; -``` - -### id property - -ID of the panel within the current dashboard - -Signature - -```typescript -id: number; -``` - -### options property - -Panel options - -Signature - -```typescript -options: TOptions; -``` - -### pluginVersion property - -Version of the panel plugin - -Signature - -```typescript -pluginVersion?: string; -``` - -### scopedVars property - -Signature - -```typescript -scopedVars?: ScopedVars; -``` diff --git a/docs/sources/packages_api/data/paneloptioneditorsregistry.md b/docs/sources/packages_api/data/paneloptioneditorsregistry.md deleted file mode 100644 index d51c758342f..00000000000 --- a/docs/sources/packages_api/data/paneloptioneditorsregistry.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionEditorsRegistry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelOptionEditorsRegistry type - -### PanelOptionEditorsRegistry type - -Signature - -```typescript -export declare type PanelOptionEditorsRegistry = Registry; -``` -Import - -```typescript -import { PanelOptionEditorsRegistry } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/paneloptionseditorbuilder.md b/docs/sources/packages_api/data/paneloptionseditorbuilder.md deleted file mode 100644 index b91afac6f5a..00000000000 --- a/docs/sources/packages_api/data/paneloptionseditorbuilder.md +++ /dev/null @@ -1,190 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionsEditorBuilder" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelOptionsEditorBuilder class - -Fluent API for declarative creation of panel options - -Signature - -```typescript -export declare class PanelOptionsEditorBuilder extends OptionsUIRegistryBuilder> -``` -Import - -```typescript -import { PanelOptionsEditorBuilder } from '@grafana/data'; -``` -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addBooleanSwitch(config)](#addbooleanswitch-method) | | | -| [addColorPicker(config)](#addcolorpicker-method) | | | -| [addNumberInput(config)](#addnumberinput-method) | | | -| [addRadio(config)](#addradio-method) | | | -| [addSelect(config)](#addselect-method) | | | -| [addStringArray(config)](#addstringarray-method) | | | -| [addTextInput(config)](#addtextinput-method) | | | -| [addTimeZonePicker(config)](#addtimezonepicker-method) | | | -| [addUnitPicker(config)](#addunitpicker-method) | | | - -### addBooleanSwitch method - -Signature - -```typescript -addBooleanSwitch(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings, boolean> | | - -Returns: - -`this` - -### addColorPicker method - -Signature - -```typescript -addColorPicker(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings & ColorFieldConfigSettings, string> | | - -Returns: - -`this` - -### addNumberInput method - -Signature - -```typescript -addNumberInput(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings & NumberFieldConfigSettings, number> | | - -Returns: - -`this` - -### addRadio method - -Signature - -```typescript -addRadio>(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings, TOption> | | - -Returns: - -`this` - -### addSelect method - -Signature - -```typescript -addSelect>(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings, TOption> | | - -Returns: - -`this` - -### addStringArray method - -Signature - -```typescript -addStringArray(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string[]> | | - -Returns: - -`this` - -### addTextInput method - -Signature - -```typescript -addTextInput(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings & StringFieldConfigSettings, string> | | - -Returns: - -`this` - -### addTimeZonePicker method - -Signature - -```typescript -addTimeZonePicker(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings, string> | | - -Returns: - -`this` - -### addUnitPicker method - -Signature - -```typescript -addUnitPicker(config: PanelOptionsEditorConfig): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | PanelOptionsEditorConfig<TOptions, TSettings & UnitFieldConfigSettings, string> | | - -Returns: - -`this` - diff --git a/docs/sources/packages_api/data/paneloptionseditorconfig.md b/docs/sources/packages_api/data/paneloptionseditorconfig.md deleted file mode 100644 index 743f27638d0..00000000000 --- a/docs/sources/packages_api/data/paneloptionseditorconfig.md +++ /dev/null @@ -1,114 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionsEditorConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelOptionsEditorConfig interface - -Signature - -```typescript -export interface PanelOptionsEditorConfig -``` -Import - -```typescript -import { PanelOptionsEditorConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category](#category-property) | string[] | Array of strings representing category of the option. First element in the array will make option render as collapsible section. | -| [defaultValue](#defaultvalue-property) | TValue | | -| [description](#description-property) | string | Description of the option. Will be displayed in the UI as form element description. | -| [name](#name-property) | string | Name of the option. Will be displayed in the UI as form element label. | -| [path](#path-property) | (keyof TOptions & string) | string | Path of the option property to control. | -| [settings](#settings-property) | TSettings | al Custom settings of the editor. | -| [showIf](#showif-property) | (currentConfig: TOptions) => boolean | undefined | Function that enables configuration of when option editor should be shown based on current panel option properties. | - -### category property - -Array of strings representing category of the option. First element in the array will make option render as collapsible section. - -Signature - -```typescript -category?: string[]; -``` - -### defaultValue property - -Signature - -```typescript -defaultValue?: TValue; -``` - -### description property - -Description of the option. Will be displayed in the UI as form element description. - -Signature - -```typescript -description?: string; -``` - -### name property - -Name of the option. Will be displayed in the UI as form element label. - -Signature - -```typescript -name: string; -``` - -### path property - -Path of the option property to control. - -Signature - -```typescript -path: (keyof TOptions & string) | string; -``` - -## Example - -Given options object of a type: - -```ts -interface Options { - a: { - b: string; - } -} - -``` -path can be either 'a' or 'a.b'. - -### settings property - -al Custom settings of the editor. - -Signature - -```typescript -settings?: TSettings; -``` - -### showIf property - -Function that enables configuration of when option editor should be shown based on current panel option properties. - -Signature - -```typescript -showIf?: (currentConfig: TOptions) => boolean | undefined; -``` diff --git a/docs/sources/packages_api/data/paneloptionseditoritem.md b/docs/sources/packages_api/data/paneloptionseditoritem.md deleted file mode 100644 index c3b267a4325..00000000000 --- a/docs/sources/packages_api/data/paneloptionseditoritem.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionsEditorItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelOptionsEditorItem interface - -Signature - -```typescript -export interface PanelOptionsEditorItem extends OptionsEditorItem, TValue> -``` -Import - -```typescript -import { PanelOptionsEditorItem } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/paneloptionseditorprops.md b/docs/sources/packages_api/data/paneloptionseditorprops.md deleted file mode 100644 index e78d0658f16..00000000000 --- a/docs/sources/packages_api/data/paneloptionseditorprops.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionsEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelOptionsEditorProps interface - -Signature - -```typescript -export interface PanelOptionsEditorProps extends StandardEditorProps -``` -Import - -```typescript -import { PanelOptionsEditorProps } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/panelplugin.md b/docs/sources/packages_api/data/panelplugin.md deleted file mode 100644 index 4baeca560e8..00000000000 --- a/docs/sources/packages_api/data/panelplugin.md +++ /dev/null @@ -1,362 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelPlugin" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelPlugin class - -Signature - -```typescript -export declare class PanelPlugin extends GrafanaPlugin -``` -Import - -```typescript -import { PanelPlugin } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(panel)](#constructor-panel) | | Constructs a new instance of the PanelPlugin class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [angularPanelCtrl](#angularpanelctrl-property) | | any | Legacy angular ctrl. If this exists it will be used instead of the panel | -| [defaults](#defaults-property) | | {} | null | | -| [editor](#editor-property) | | ComponentClass<PanelEditorProps<TOptions>> | | -| [fieldConfigDefaults](#fieldconfigdefaults-property) | | FieldConfigSource<TFieldConfigOptions> | | -| [fieldConfigRegistry](#fieldconfigregistry-property) | | FieldConfigOptionsRegistry | | -| [noPadding](#nopadding-property) | | boolean | | -| [onPanelMigration](#onpanelmigration-property) | | PanelMigrationHandler<TOptions> | | -| [onPanelTypeChanged](#onpaneltypechanged-property) | | PanelTypeChangedHandler<TOptions> | | -| [optionEditors](#optioneditors-property) | | PanelOptionEditorsRegistry | undefined | | -| [panel](#panel-property) | | ComponentType<PanelProps<TOptions>> | null | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [setDefaults(defaults)](#setdefaults-method) | | | -| [setEditor(editor)](#seteditor-method) | | | -| [setMigrationHandler(handler)](#setmigrationhandler-method) | | This function is called before the panel first loads if the current version is different than the version that was saved.This is a good place to support any changes to the options model | -| [setNoPadding()](#setnopadding-method) | | | -| [setPanelChangeHandler(handler)](#setpanelchangehandler-method) | | This function is called when the visualization was changed. This passes in the panel model for previous visualisation options inspection and panel model updates.This is useful for supporting PanelModel API updates when changing between Angular and React panels. | -| [setPanelOptions(builder)](#setpaneloptions-method) | | Enables panel options editor creation | -| [useFieldConfig(config)](#usefieldconfig-method) | | Allows specifying which standard field config options panel should use and defining default values | - -### constructor(panel) - -Constructs a new instance of the `PanelPlugin` class - -Signature - -```typescript -constructor(panel: ComponentType> | null); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| panel | ComponentType<PanelProps<TOptions>> | null | | - -### angularPanelCtrl property - -Legacy angular ctrl. If this exists it will be used instead of the panel - -Signature - -```typescript -angularPanelCtrl?: any; -``` - -### defaults property - -Signature - -```typescript -get defaults(): {} | null; -``` - -### editor property - -Signature - -```typescript -editor?: ComponentClass>; -``` - -### fieldConfigDefaults property - -Signature - -```typescript -get fieldConfigDefaults(): FieldConfigSource; -``` - -### fieldConfigRegistry property - -Signature - -```typescript -get fieldConfigRegistry(): FieldConfigOptionsRegistry; -``` - -### noPadding property - -Signature - -```typescript -noPadding?: boolean; -``` - -### onPanelMigration property - -Signature - -```typescript -onPanelMigration?: PanelMigrationHandler; -``` - -### onPanelTypeChanged property - -Signature - -```typescript -onPanelTypeChanged?: PanelTypeChangedHandler; -``` - -### optionEditors property - -Signature - -```typescript -get optionEditors(): PanelOptionEditorsRegistry | undefined; -``` - -### panel property - -Signature - -```typescript -panel: ComponentType> | null; -``` - -### setDefaults method - -Signature - -```typescript -setDefaults(defaults: TOptions): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| defaults | TOptions | | - -Returns: - -`this` - -### setEditor method - -Signature - -```typescript -setEditor(editor: ComponentClass>): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| editor | ComponentClass<PanelEditorProps<TOptions>> | | - -Returns: - -`this` - -### setMigrationHandler method - -This function is called before the panel first loads if the current version is different than the version that was saved. - -This is a good place to support any changes to the options model - -Signature - -```typescript -setMigrationHandler(handler: PanelMigrationHandler): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| handler | PanelMigrationHandler | | - -Returns: - -`this` - -### setNoPadding method - -Signature - -```typescript -setNoPadding(): this; -``` -Returns: - -`this` - -### setPanelChangeHandler method - -This function is called when the visualization was changed. This passes in the panel model for previous visualisation options inspection and panel model updates. - -This is useful for supporting PanelModel API updates when changing between Angular and React panels. - -Signature - -```typescript -setPanelChangeHandler(handler: PanelTypeChangedHandler): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| handler | PanelTypeChangedHandler | | - -Returns: - -`this` - -### setPanelOptions method - -Enables panel options editor creation - -Signature - -```typescript -setPanelOptions(builder: (builder: PanelOptionsEditorBuilder) => void): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| builder | (builder: PanelOptionsEditorBuilder<TOptions>) => void | | - -Returns: - -`this` - -## Example - - -```typescript - -import { ShapePanel } from './ShapePanel'; - -interface ShapePanelOptions {} - -export const plugin = new PanelPlugin(ShapePanel) - .setPanelOptions(builder => { - builder - .addSelect({ - id: 'shape', - name: 'Shape', - description: 'Select shape to render' - settings: { - options: [ - {value: 'circle', label: 'Circle' }, - {value: 'square', label: 'Square }, - {value: 'triangle', label: 'Triangle } - ] - }, - }) - }) - -``` - -### useFieldConfig method - -Allows specifying which standard field config options panel should use and defining default values - -Signature - -```typescript -useFieldConfig(config?: SetFieldConfigOptionsArgs): this; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | SetFieldConfigOptionsArgs<TFieldConfigOptions> | | - -Returns: - -`this` - -## Example - - -```typescript - -import { ShapePanel } from './ShapePanel'; - -interface ShapePanelOptions {} - -// when plugin should use all standard options -export const plugin = new PanelPlugin(ShapePanel) - .useFieldConfig(); - -// when plugin should only display specific standard options -// note, that options will be displayed in the order they are provided -export const plugin = new PanelPlugin(ShapePanel) - .useFieldConfig({ - standardOptions: [FieldConfigProperty.Min, FieldConfigProperty.Max] - }); - -// when standard option's default value needs to be provided -export const plugin = new PanelPlugin(ShapePanel) - .useFieldConfig({ - standardOptions: [FieldConfigProperty.Min, FieldConfigProperty.Max], - standardOptionsDefaults: { - [FieldConfigProperty.Min]: 20, - [FieldConfigProperty.Max]: 100 - } - }); - -// when custom field config options needs to be provided -export const plugin = new PanelPlugin(ShapePanel) - .useFieldConfig({ - useCustomConfig: builder => { - builder - .addNumberInput({ - id: 'shapeBorderWidth', - name: 'Border width', - description: 'Border width of the shape', - settings: { - min: 1, - max: 5, - }, - }) - .addSelect({ - id: 'displayMode', - name: 'Display mode', - description: 'How the shape shout be rendered' - settings: { - options: [{value: 'fill', label: 'Fill' }, {value: 'transparent', label: 'Transparent }] - }, - }) - }, - }); - - -``` - diff --git a/docs/sources/packages_api/data/panelpluginmeta.md b/docs/sources/packages_api/data/panelpluginmeta.md deleted file mode 100644 index 99971384dad..00000000000 --- a/docs/sources/packages_api/data/panelpluginmeta.md +++ /dev/null @@ -1,58 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelPluginMeta" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelPluginMeta interface - -Signature - -```typescript -export interface PanelPluginMeta extends PluginMeta -``` -Import - -```typescript -import { PanelPluginMeta } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hideFromList](#hidefromlist-property) | boolean | Indicates that panel should not be available in visualisation picker | -| [skipDataQuery](#skipdataquery-property) | boolean | Indicates that panel does not issue queries | -| [sort](#sort-property) | number | Sort order | - -### hideFromList property - -Indicates that panel should not be available in visualisation picker - -Signature - -```typescript -hideFromList?: boolean; -``` - -### skipDataQuery property - -Indicates that panel does not issue queries - -Signature - -```typescript -skipDataQuery?: boolean; -``` - -### sort property - -Sort order - -Signature - -```typescript -sort: number; -``` diff --git a/docs/sources/packages_api/data/panelprops.md b/docs/sources/packages_api/data/panelprops.md deleted file mode 100644 index b73974d0d8e..00000000000 --- a/docs/sources/packages_api/data/panelprops.md +++ /dev/null @@ -1,168 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelProps interface - -Signature - -```typescript -export interface PanelProps -``` -Import - -```typescript -import { PanelProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | PanelData | Result set of panel queries | -| [fieldConfig](#fieldconfig-property) | FieldConfigSource | Field options configuration | -| [height](#height-property) | number | Current height of the panel | -| [id](#id-property) | number | ID of the panel within the current dashboard | -| [onChangeTimeRange](#onchangetimerange-property) | (timeRange: AbsoluteTimeRange) => void | Time range change handler | -| [onFieldConfigChange](#onfieldconfigchange-property) | (config: FieldConfigSource) => void | Field config change handler | -| [onOptionsChange](#onoptionschange-property) | (options: T) => void | Panel options change handler | -| [options](#options-property) | T | Panel options | -| [replaceVariables](#replacevariables-property) | InterpolateFunction | Template variables interpolation function | -| [timeRange](#timerange-property) | TimeRange | Time range of the current dashboard | -| [timeZone](#timezone-property) | TimeZone | Time zone of the current dashboard | -| [transparent](#transparent-property) | boolean | Indicates whether or not panel should be rendered transparent | -| [width](#width-property) | number | Current width of the panel | - -### data property - -Result set of panel queries - -Signature - -```typescript -data: PanelData; -``` - -### fieldConfig property - -Field options configuration - -Signature - -```typescript -fieldConfig: FieldConfigSource; -``` - -### height property - -Current height of the panel - -Signature - -```typescript -height: number; -``` - -### id property - -ID of the panel within the current dashboard - -Signature - -```typescript -id: number; -``` - -### onChangeTimeRange property - -Time range change handler - -Signature - -```typescript -onChangeTimeRange: (timeRange: AbsoluteTimeRange) => void; -``` - -### onFieldConfigChange property - -Field config change handler - -Signature - -```typescript -onFieldConfigChange: (config: FieldConfigSource) => void; -``` - -### onOptionsChange property - -Panel options change handler - -Signature - -```typescript -onOptionsChange: (options: T) => void; -``` - -### options property - -Panel options - -Signature - -```typescript -options: T; -``` - -### replaceVariables property - -Template variables interpolation function - -Signature - -```typescript -replaceVariables: InterpolateFunction; -``` - -### timeRange property - -Time range of the current dashboard - -Signature - -```typescript -timeRange: TimeRange; -``` - -### timeZone property - -Time zone of the current dashboard - -Signature - -```typescript -timeZone: TimeZone; -``` - -### transparent property - -Indicates whether or not panel should be rendered transparent - -Signature - -```typescript -transparent: boolean; -``` - -### width property - -Current width of the panel - -Signature - -```typescript -width: number; -``` diff --git a/docs/sources/packages_api/data/paneltypechangedhandler.md b/docs/sources/packages_api/data/paneltypechangedhandler.md deleted file mode 100644 index ae9a500ccd8..00000000000 --- a/docs/sources/packages_api/data/paneltypechangedhandler.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelTypeChangedHandler" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PanelTypeChangedHandler type - -### PanelTypeChangedHandler type - -Called before a panel is initialized. Allows panel inspection for any updates before changing the panel type. - -Signature - -```typescript -export declare type PanelTypeChangedHandler = (panel: PanelModel, prevPluginId: string, prevOptions: any) => Partial; -``` -Import - -```typescript -import { PanelTypeChangedHandler } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/parseflags.md b/docs/sources/packages_api/data/parseflags.md deleted file mode 100644 index 2cae44e8c2b..00000000000 --- a/docs/sources/packages_api/data/parseflags.md +++ /dev/null @@ -1,41 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "parseFlags" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## parseFlags() function - -### parseFlags() function - -Converts any mode modifiers in the text to the Javascript equivalent flag - -Signature - -```typescript -export declare function parseFlags(text: string): { - cleaned: string; - flags: string; -}; -``` -Import - -```typescript -import { parseFlags } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | | - -Returns: - -`{ - cleaned: string; - flags: string; -}` - diff --git a/docs/sources/packages_api/data/parselabels.md b/docs/sources/packages_api/data/parselabels.md deleted file mode 100644 index e38ce130c4a..00000000000 --- a/docs/sources/packages_api/data/parselabels.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "parseLabels" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## parseLabels() function - -### parseLabels() function - -Returns a map of label keys to value from an input selector string. - -Example: `parseLabels('{job="foo", instance="bar"}) // {job: "foo", instance: "bar"}` - -Signature - -```typescript -export declare function parseLabels(labels: string): Labels; -``` -Import - -```typescript -import { parseLabels } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| labels | string | | - -Returns: - -`Labels` - diff --git a/docs/sources/packages_api/data/pluginbuildinfo.md b/docs/sources/packages_api/data/pluginbuildinfo.md deleted file mode 100644 index 0738e8d56ce..00000000000 --- a/docs/sources/packages_api/data/pluginbuildinfo.md +++ /dev/null @@ -1,79 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginBuildInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginBuildInfo interface - -Signature - -```typescript -export interface PluginBuildInfo -``` -Import - -```typescript -import { PluginBuildInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [branch](#branch-property) | string | | -| [hash](#hash-property) | string | | -| [number](#number-property) | number | | -| [pr](#pr-property) | number | | -| [repo](#repo-property) | string | | -| [time](#time-property) | number | | - -### branch property - -Signature - -```typescript -branch?: string; -``` - -### hash property - -Signature - -```typescript -hash?: string; -``` - -### number property - -Signature - -```typescript -number?: number; -``` - -### pr property - -Signature - -```typescript -pr?: number; -``` - -### repo property - -Signature - -```typescript -repo?: string; -``` - -### time property - -Signature - -```typescript -time?: number; -``` diff --git a/docs/sources/packages_api/data/pluginconfigpage.md b/docs/sources/packages_api/data/pluginconfigpage.md deleted file mode 100644 index cd9785f5151..00000000000 --- a/docs/sources/packages_api/data/pluginconfigpage.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginConfigPage" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginConfigPage interface - -Signature - -```typescript -export interface PluginConfigPage -``` -Import - -```typescript -import { PluginConfigPage } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body](#body-property) | ComponentClass<PluginConfigPageProps<T>> | | -| [icon](#icon-property) | string | | -| [id](#id-property) | string | | -| [title](#title-property) | string | | - -### body property - -Signature - -```typescript -body: ComponentClass>; -``` - -### icon property - -Signature - -```typescript -icon?: string; -``` - -### id property - -Signature - -```typescript -id: string; -``` - -### title property - -Signature - -```typescript -title: string; -``` diff --git a/docs/sources/packages_api/data/pluginconfigpageprops.md b/docs/sources/packages_api/data/pluginconfigpageprops.md deleted file mode 100644 index c5649606c90..00000000000 --- a/docs/sources/packages_api/data/pluginconfigpageprops.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginConfigPageProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginConfigPageProps interface - -Signature - -```typescript -export interface PluginConfigPageProps -``` -Import - -```typescript -import { PluginConfigPageProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [plugin](#plugin-property) | GrafanaPlugin<T> | | -| [query](#query-property) | KeyValue | | - -### plugin property - -Signature - -```typescript -plugin: GrafanaPlugin; -``` - -### query property - -Signature - -```typescript -query: KeyValue; -``` diff --git a/docs/sources/packages_api/data/plugindependencies.md b/docs/sources/packages_api/data/plugindependencies.md deleted file mode 100644 index 68668f23021..00000000000 --- a/docs/sources/packages_api/data/plugindependencies.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginDependencies" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginDependencies interface - -Signature - -```typescript -export interface PluginDependencies -``` -Import - -```typescript -import { PluginDependencies } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [grafanaVersion](#grafanaversion-property) | string | | -| [plugins](#plugins-property) | PluginDependencyInfo[] | | - -### grafanaVersion property - -Signature - -```typescript -grafanaVersion: string; -``` - -### plugins property - -Signature - -```typescript -plugins: PluginDependencyInfo[]; -``` diff --git a/docs/sources/packages_api/data/plugininclude.md b/docs/sources/packages_api/data/plugininclude.md deleted file mode 100644 index 32c87a0ede3..00000000000 --- a/docs/sources/packages_api/data/plugininclude.md +++ /dev/null @@ -1,88 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginInclude" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginInclude interface - -Signature - -```typescript -export interface PluginInclude -``` -Import - -```typescript -import { PluginInclude } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [addToNav](#addtonav-property) | boolean | | -| [component](#component-property) | string | | -| [icon](#icon-property) | string | | -| [name](#name-property) | string | | -| [path](#path-property) | string | | -| [role](#role-property) | string | | -| [type](#type-property) | PluginIncludeType | | - -### addToNav property - -Signature - -```typescript -addToNav?: boolean; -``` - -### component property - -Signature - -```typescript -component?: string; -``` - -### icon property - -Signature - -```typescript -icon?: string; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### path property - -Signature - -```typescript -path?: string; -``` - -### role property - -Signature - -```typescript -role?: string; -``` - -### type property - -Signature - -```typescript -type: PluginIncludeType; -``` diff --git a/docs/sources/packages_api/data/pluginincludetype.md b/docs/sources/packages_api/data/pluginincludetype.md deleted file mode 100644 index 71dc27206ab..00000000000 --- a/docs/sources/packages_api/data/pluginincludetype.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginIncludeType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginIncludeType enum - -### PluginIncludeType enum - -Signature - -```typescript -export declare enum PluginIncludeType -``` -Import - -```typescript -import { PluginIncludeType } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| dashboard | "dashboard" | | -| datasource | "datasource" | | -| page | "page" | | -| panel | "panel" | | - diff --git a/docs/sources/packages_api/data/pluginmeta.md b/docs/sources/packages_api/data/pluginmeta.md deleted file mode 100644 index 0f27025a0c4..00000000000 --- a/docs/sources/packages_api/data/pluginmeta.md +++ /dev/null @@ -1,187 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginMeta" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginMeta interface - -Signature - -```typescript -export interface PluginMeta -``` -Import - -```typescript -import { PluginMeta } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [baseUrl](#baseurl-property) | string | | -| [defaultNavUrl](#defaultnavurl-property) | string | | -| [dependencies](#dependencies-property) | PluginDependencies | | -| [enabled](#enabled-property) | boolean | | -| [enterprise](#enterprise-property) | boolean | | -| [hasUpdate](#hasupdate-property) | boolean | | -| [id](#id-property) | string | | -| [includes](#includes-property) | PluginInclude[] | | -| [info](#info-property) | PluginMetaInfo | | -| [jsonData](#jsondata-property) | T | | -| [latestVersion](#latestversion-property) | string | | -| [module](#module-property) | string | | -| [name](#name-property) | string | | -| [pinned](#pinned-property) | boolean | | -| [secureJsonData](#securejsondata-property) | KeyValue | | -| [signature](#signature-property) | PluginSignatureStatus | | -| [state](#state-property) | PluginState | | -| [type](#type-property) | PluginType | | - -### baseUrl property - -Signature - -```typescript -baseUrl: string; -``` - -### defaultNavUrl property - -Signature - -```typescript -defaultNavUrl?: string; -``` - -### dependencies property - -Signature - -```typescript -dependencies?: PluginDependencies; -``` - -### enabled property - -Signature - -```typescript -enabled?: boolean; -``` - -### enterprise property - -Signature - -```typescript -enterprise?: boolean; -``` - -### hasUpdate property - -Signature - -```typescript -hasUpdate?: boolean; -``` - -### id property - -Signature - -```typescript -id: string; -``` - -### includes property - -Signature - -```typescript -includes?: PluginInclude[]; -``` - -### info property - -Signature - -```typescript -info: PluginMetaInfo; -``` - -### jsonData property - -Signature - -```typescript -jsonData?: T; -``` - -### latestVersion property - -Signature - -```typescript -latestVersion?: string; -``` - -### module property - -Signature - -```typescript -module: string; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### pinned property - -Signature - -```typescript -pinned?: boolean; -``` - -### secureJsonData property - -Signature - -```typescript -secureJsonData?: KeyValue; -``` - -### signature property - -Signature - -```typescript -signature?: PluginSignatureStatus; -``` - -### state property - -Signature - -```typescript -state?: PluginState; -``` - -### type property - -Signature - -```typescript -type: PluginType; -``` diff --git a/docs/sources/packages_api/data/pluginmetainfo.md b/docs/sources/packages_api/data/pluginmetainfo.md deleted file mode 100644 index 4d551c82d73..00000000000 --- a/docs/sources/packages_api/data/pluginmetainfo.md +++ /dev/null @@ -1,103 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginMetaInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginMetaInfo interface - -Signature - -```typescript -export interface PluginMetaInfo -``` -Import - -```typescript -import { PluginMetaInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [author](#author-property) | {
name: string;
url?: string;
} | | -| [build](#build-property) | PluginBuildInfo | | -| [description](#description-property) | string | | -| [links](#links-property) | PluginMetaInfoLink[] | | -| [logos](#logos-property) | {
large: string;
small: string;
} | | -| [screenshots](#screenshots-property) | ScreenshotInfo[] | | -| [updated](#updated-property) | string | | -| [version](#version-property) | string | | - -### author property - -Signature - -```typescript -author: { - name: string; - url?: string; - }; -``` - -### build property - -Signature - -```typescript -build?: PluginBuildInfo; -``` - -### description property - -Signature - -```typescript -description: string; -``` - -### links property - -Signature - -```typescript -links: PluginMetaInfoLink[]; -``` - -### logos property - -Signature - -```typescript -logos: { - large: string; - small: string; - }; -``` - -### screenshots property - -Signature - -```typescript -screenshots: ScreenshotInfo[]; -``` - -### updated property - -Signature - -```typescript -updated: string; -``` - -### version property - -Signature - -```typescript -version: string; -``` diff --git a/docs/sources/packages_api/data/pluginsignaturestatus.md b/docs/sources/packages_api/data/pluginsignaturestatus.md deleted file mode 100644 index ca60e13b05b..00000000000 --- a/docs/sources/packages_api/data/pluginsignaturestatus.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginSignatureStatus" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginSignatureStatus enum - -### PluginSignatureStatus enum - -Signature - -```typescript -export declare enum PluginSignatureStatus -``` -Import - -```typescript -import { PluginSignatureStatus } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| internal | "internal" | | -| invalid | "invalid" | | -| modified | "modified" | | -| unsigned | "unsigned" | | -| valid | "valid" | | - diff --git a/docs/sources/packages_api/data/pluginstate.md b/docs/sources/packages_api/data/pluginstate.md deleted file mode 100644 index 561d4e00993..00000000000 --- a/docs/sources/packages_api/data/pluginstate.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginState" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginState enum - -### PluginState enum - -Signature - -```typescript -export declare enum PluginState -``` -Import - -```typescript -import { PluginState } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| alpha | "alpha" | | -| beta | "beta" | | -| deprecated | "deprecated" | | - diff --git a/docs/sources/packages_api/data/plugintype.md b/docs/sources/packages_api/data/plugintype.md deleted file mode 100644 index 5b94f6618d9..00000000000 --- a/docs/sources/packages_api/data/plugintype.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PluginType enum - -### PluginType enum - -Signature - -```typescript -export declare enum PluginType -``` -Import - -```typescript -import { PluginType } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| app | "app" | | -| datasource | "datasource" | | -| panel | "panel" | | -| renderer | "renderer" | | - diff --git a/docs/sources/packages_api/data/preferredvisualisationtype.md b/docs/sources/packages_api/data/preferredvisualisationtype.md deleted file mode 100644 index f96c449356a..00000000000 --- a/docs/sources/packages_api/data/preferredvisualisationtype.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PreferredVisualisationType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## PreferredVisualisationType type - -### PreferredVisualisationType type - -Signature - -```typescript -export declare type PreferredVisualisationType = 'graph' | 'table'; -``` -Import - -```typescript -import { PreferredVisualisationType } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/queryeditorprops.md b/docs/sources/packages_api/data/queryeditorprops.md deleted file mode 100644 index 72fbd0af4bc..00000000000 --- a/docs/sources/packages_api/data/queryeditorprops.md +++ /dev/null @@ -1,108 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryEditorProps interface - -Signature - -```typescript -export interface QueryEditorProps, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> -``` -Import - -```typescript -import { QueryEditorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | PanelData | Contains query response filtered by refId of QueryResultBase and possible query error | -| [datasource](#datasource-property) | DSType | | -| [exploreId](#exploreid-property) | any | | -| [exploreMode](#exploremode-property) | ExploreMode | | -| [history](#history-property) | HistoryItem[] | | -| [onBlur](#onblur-property) | () => void | | -| [onChange](#onchange-property) | (value: TQuery) => void | | -| [onRunQuery](#onrunquery-property) | () => void | | -| [query](#query-property) | TQuery | | - -### data property - -Contains query response filtered by refId of QueryResultBase and possible query error - -Signature - -```typescript -data?: PanelData; -``` - -### datasource property - -Signature - -```typescript -datasource: DSType; -``` - -### exploreId property - -Signature - -```typescript -exploreId?: any; -``` - -### exploreMode property - -Signature - -```typescript -exploreMode?: ExploreMode; -``` - -### history property - -Signature - -```typescript -history?: HistoryItem[]; -``` - -### onBlur property - -Signature - -```typescript -onBlur?: () => void; -``` - -### onChange property - -Signature - -```typescript -onChange: (value: TQuery) => void; -``` - -### onRunQuery property - -Signature - -```typescript -onRunQuery: () => void; -``` - -### query property - -Signature - -```typescript -query: TQuery; -``` diff --git a/docs/sources/packages_api/data/queryfix.md b/docs/sources/packages_api/data/queryfix.md deleted file mode 100644 index 4b709a6ee2b..00000000000 --- a/docs/sources/packages_api/data/queryfix.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryFix" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryFix interface - -Signature - -```typescript -export interface QueryFix -``` -Import - -```typescript -import { QueryFix } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action](#action-property) | QueryFixAction | | -| [label](#label-property) | string | | -| [type](#type-property) | string | | - -### action property - -Signature - -```typescript -action?: QueryFixAction; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### type property - -Signature - -```typescript -type: string; -``` diff --git a/docs/sources/packages_api/data/queryfixaction.md b/docs/sources/packages_api/data/queryfixaction.md deleted file mode 100644 index 77fc7f98b3d..00000000000 --- a/docs/sources/packages_api/data/queryfixaction.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryFixAction" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryFixAction interface - -Signature - -```typescript -export interface QueryFixAction -``` -Import - -```typescript -import { QueryFixAction } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [preventSubmit](#preventsubmit-property) | boolean | | -| [query](#query-property) | string | | -| [type](#type-property) | string | | - -### preventSubmit property - -Signature - -```typescript -preventSubmit?: boolean; -``` - -### query property - -Signature - -```typescript -query?: string; -``` - -### type property - -Signature - -```typescript -type: string; -``` diff --git a/docs/sources/packages_api/data/queryhint.md b/docs/sources/packages_api/data/queryhint.md deleted file mode 100644 index d2cf761c352..00000000000 --- a/docs/sources/packages_api/data/queryhint.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryHint" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryHint interface - -Signature - -```typescript -export interface QueryHint -``` -Import - -```typescript -import { QueryHint } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fix](#fix-property) | QueryFix | | -| [label](#label-property) | string | | -| [type](#type-property) | string | | - -### fix property - -Signature - -```typescript -fix?: QueryFix; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### type property - -Signature - -```typescript -type: string; -``` diff --git a/docs/sources/packages_api/data/queryresultbase.md b/docs/sources/packages_api/data/queryresultbase.md deleted file mode 100644 index 66497689cdf..00000000000 --- a/docs/sources/packages_api/data/queryresultbase.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryResultBase" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryResultBase interface - -Signature - -```typescript -export interface QueryResultBase -``` -Import - -```typescript -import { QueryResultBase } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [meta](#meta-property) | QueryResultMeta | Used by some backend data sources to communicate back info about the execution (generated sql, timing) | -| [refId](#refid-property) | string | Matches the query target refId | - -### meta property - -Used by some backend data sources to communicate back info about the execution (generated sql, timing) - -Signature - -```typescript -meta?: QueryResultMeta; -``` - -### refId property - -Matches the query target refId - -Signature - -```typescript -refId?: string; -``` diff --git a/docs/sources/packages_api/data/queryresultmeta.md b/docs/sources/packages_api/data/queryresultmeta.md deleted file mode 100644 index 88c3e1e649a..00000000000 --- a/docs/sources/packages_api/data/queryresultmeta.md +++ /dev/null @@ -1,138 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryResultMeta" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryResultMeta interface - -Signature - -```typescript -export interface QueryResultMeta -``` -Import - -```typescript -import { QueryResultMeta } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alignmentPeriod](#alignmentperiod-property) | string | | -| [custom](#custom-property) | Record<string, any> | DatasSource Specific Values | -| [executedQueryString](#executedquerystring-property) | string | This is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector | -| [gmdMeta](#gmdmeta-property) | any[] | Legacy data source specific, should be moved to custom | -| [json](#json-property) | boolean | | -| [limit](#limit-property) | number | | -| [notices](#notices-property) | QueryResultMetaNotice[] | Meta Notices | -| [preferredVisualisationType](#preferredvisualisationtype-property) | PreferredVisualisationType | Currently used to show results in Explore only in preferred visualisation option | -| [searchWords](#searchwords-property) | string[] | | -| [stats](#stats-property) | QueryResultMetaStat[] | Stats | -| [transformations](#transformations-property) | string[] | Used to track transformation ids that where part of the processing | - -### alignmentPeriod property - -Signature - -```typescript -alignmentPeriod?: string; -``` - -### custom property - -DatasSource Specific Values - -Signature - -```typescript -custom?: Record; -``` - -### executedQueryString property - -This is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector - -Signature - -```typescript -executedQueryString?: string; -``` - -### gmdMeta property - -Legacy data source specific, should be moved to custom - -Signature - -```typescript -gmdMeta?: any[]; -``` - -### json property - -Signature - -```typescript -json?: boolean; -``` - -### limit property - -Signature - -```typescript -limit?: number; -``` - -### notices property - -Meta Notices - -Signature - -```typescript -notices?: QueryResultMetaNotice[]; -``` - -### preferredVisualisationType property - -Currently used to show results in Explore only in preferred visualisation option - -Signature - -```typescript -preferredVisualisationType?: PreferredVisualisationType; -``` - -### searchWords property - -Signature - -```typescript -searchWords?: string[]; -``` - -### stats property - -Stats - -Signature - -```typescript -stats?: QueryResultMetaStat[]; -``` - -### transformations property - -Used to track transformation ids that where part of the processing - -Signature - -```typescript -transformations?: string[]; -``` diff --git a/docs/sources/packages_api/data/queryresultmetanotice.md b/docs/sources/packages_api/data/queryresultmetanotice.md deleted file mode 100644 index 44bc620e1d8..00000000000 --- a/docs/sources/packages_api/data/queryresultmetanotice.md +++ /dev/null @@ -1,71 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryResultMetaNotice" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryResultMetaNotice interface - -QueryResultMetaNotice is a structure that provides user notices for query result data - -Signature - -```typescript -export interface QueryResultMetaNotice -``` -Import - -```typescript -import { QueryResultMetaNotice } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [inspect](#inspect-property) | 'meta' | 'error' | 'data' | 'stats' | Optionally suggest an appropriate tab for the panel inspector | -| [link](#link-property) | string | An optional link that may be displayed in the UI. This value may be an absolute URL or relative to grafana root | -| [severity](#severity-property) | 'info' | 'warning' | 'error' | Specify the notice severity | -| [text](#text-property) | string | Notice descriptive text | - -### inspect property - -Optionally suggest an appropriate tab for the panel inspector - -Signature - -```typescript -inspect?: 'meta' | 'error' | 'data' | 'stats'; -``` - -### link property - -An optional link that may be displayed in the UI. This value may be an absolute URL or relative to grafana root - -Signature - -```typescript -link?: string; -``` - -### severity property - -Specify the notice severity - -Signature - -```typescript -severity: 'info' | 'warning' | 'error'; -``` - -### text property - -Notice descriptive text - -Signature - -```typescript -text: string; -``` diff --git a/docs/sources/packages_api/data/queryresultmetastat.md b/docs/sources/packages_api/data/queryresultmetastat.md deleted file mode 100644 index 0f8595783ef..00000000000 --- a/docs/sources/packages_api/data/queryresultmetastat.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryResultMetaStat" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## QueryResultMetaStat interface - -Signature - -```typescript -export interface QueryResultMetaStat extends FieldConfig -``` -Import - -```typescript -import { QueryResultMetaStat } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](#displayname-property) | string | | -| [value](#value-property) | number | | - -### displayName property - -Signature - -```typescript -displayName: string; -``` - -### value property - -Signature - -```typescript -value: number; -``` diff --git a/docs/sources/packages_api/data/rangemap.md b/docs/sources/packages_api/data/rangemap.md deleted file mode 100644 index 383237b6a6e..00000000000 --- a/docs/sources/packages_api/data/rangemap.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RangeMap" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## RangeMap interface - -Signature - -```typescript -export interface RangeMap extends BaseMap -``` -Import - -```typescript -import { RangeMap } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [from](#from-property) | string | | -| [to](#to-property) | string | | - -### from property - -Signature - -```typescript -from: string; -``` - -### to property - -Signature - -```typescript -to: string; -``` diff --git a/docs/sources/packages_api/data/rangeutil.md b/docs/sources/packages_api/data/rangeutil.md deleted file mode 100644 index 0f0cbd486a7..00000000000 --- a/docs/sources/packages_api/data/rangeutil.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "rangeUtil" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## rangeUtil namespace - -> 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. -> - -### rangeUtil namespace - -Import - -```typescript -import { rangeUtil } from '@grafana/data'; -``` - -## Functions - -| Function | Description | -| --- | --- | -| [describeTextRange(expr)](./describetextrange/) | | -| [getRelativeTimesList(timepickerSettings, currentDisplay)](./getrelativetimeslist/) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [convertRawToRange](./convertrawtorange/) | | -| [describeTimeRangeAbbrevation](./describetimerangeabbrevation/) | | -| [isValidTimeSpan](./isvalidtimespan/) | | - diff --git a/docs/sources/packages_api/data/rangeutil/convertrawtorange.md b/docs/sources/packages_api/data/rangeutil/convertrawtorange.md deleted file mode 100644 index 9a635d3ed6b..00000000000 --- a/docs/sources/packages_api/data/rangeutil/convertrawtorange.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "convertRawToRange" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## rangeUtil.convertRawToRange variable - -### rangeUtil.convertRawToRange variable - -Signature - -```typescript -convertRawToRange: (raw: RawTimeRange, timeZone?: string | undefined) => TimeRange -``` -Import - -```typescript -import { rangeUtil } from '@grafana/data'; -const { convertRawToRange } = rangeUtil; -``` diff --git a/docs/sources/packages_api/data/rangeutil/describetextrange.md b/docs/sources/packages_api/data/rangeutil/describetextrange.md deleted file mode 100644 index c8e9b416501..00000000000 --- a/docs/sources/packages_api/data/rangeutil/describetextrange.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "describeTextRange" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## rangeUtil.describeTextRange() function - -### rangeUtil.describeTextRange() function - -Signature - -```typescript -export declare function describeTextRange(expr: any): any; -``` -Import - -```typescript -import { rangeUtil } from '@grafana/data'; -const { describeTextRange } = rangeUtil; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| expr | any | | - -Returns: - -`any` - diff --git a/docs/sources/packages_api/data/rangeutil/describetimerangeabbrevation.md b/docs/sources/packages_api/data/rangeutil/describetimerangeabbrevation.md deleted file mode 100644 index b9c791357d9..00000000000 --- a/docs/sources/packages_api/data/rangeutil/describetimerangeabbrevation.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "describeTimeRangeAbbrevation" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## rangeUtil.describeTimeRangeAbbrevation variable - -### rangeUtil.describeTimeRangeAbbrevation variable - -Signature - -```typescript -describeTimeRangeAbbrevation: (range: TimeRange, timeZone?: string | undefined) => string -``` -Import - -```typescript -import { rangeUtil } from '@grafana/data'; -const { describeTimeRangeAbbrevation } = rangeUtil; -``` diff --git a/docs/sources/packages_api/data/rangeutil/getrelativetimeslist.md b/docs/sources/packages_api/data/rangeutil/getrelativetimeslist.md deleted file mode 100644 index e60e701da1a..00000000000 --- a/docs/sources/packages_api/data/rangeutil/getrelativetimeslist.md +++ /dev/null @@ -1,901 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getRelativeTimesList" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## rangeUtil.getRelativeTimesList() function - -### rangeUtil.getRelativeTimesList() function - -Signature - -```typescript -export declare function getRelativeTimesList(timepickerSettings: any, currentDisplay: any): import("lodash").Dictionary<(number | { - from: string; - to: string; - display: string; - section: number; -} | (() => string) | (() => string) | (() => { - from: string; - to: string; - display: string; - section: number; -} | undefined) | ((...items: { - from: string; - to: string; - display: string; - section: number; -}[]) => number) | { - (...items: ConcatArray<{ - from: string; - to: string; - display: string; - section: number; - }>[]): { - from: string; - to: string; - display: string; - section: number; - }[]; - (...items: ({ - from: string; - to: string; - display: string; - section: number; - } | ConcatArray<{ - from: string; - to: string; - display: string; - section: number; - }>)[]): { - from: string; - to: string; - display: string; - section: number; - }[]; -} | ((separator?: string | undefined) => string) | (() => { - from: string; - to: string; - display: string; - section: number; -}[]) | (() => { - from: string; - to: string; - display: string; - section: number; -} | undefined) | ((start?: number | undefined, end?: number | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | ((compareFn?: ((a: { - from: string; - to: string; - display: string; - section: number; -}, b: { - from: string; - to: string; - display: string; - section: number; -}) => number) | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | { - (start: number, deleteCount?: number | undefined): { - from: string; - to: string; - display: string; - section: number; - }[]; - (start: number, deleteCount: number, ...items: { - from: string; - to: string; - display: string; - section: number; - }[]): { - from: string; - to: string; - display: string; - section: number; - }[]; -} | ((...items: { - from: string; - to: string; - display: string; - section: number; -}[]) => number) | ((searchElement: { - from: string; - to: string; - display: string; - section: number; -}, fromIndex?: number | undefined) => number) | ((searchElement: { - from: string; - to: string; - display: string; - section: number; -}, fromIndex?: number | undefined) => number) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => void, thisArg?: any) => void) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => U, thisArg?: any) => U[]) | { - (callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => value is S, thisArg?: any): S[]; - (callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => unknown, thisArg?: any): { - from: string; - to: string; - display: string; - section: number; - }[]; -} | { - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }, initialValue: { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: U_1, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => U_1, initialValue: U_1): U_1; -} | { - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }, initialValue: { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: U_2, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => U_2, initialValue: U_2): U_2; -} | { - (predicate: (this: void, value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, obj: { - from: string; - to: string; - display: string; - section: number; - }[]) => value is S_1, thisArg?: any): S_1 | undefined; - (predicate: (value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, obj: { - from: string; - to: string; - display: string; - section: number; - }[]) => unknown, thisArg?: any): { - from: string; - to: string; - display: string; - section: number; - } | undefined; -} | ((predicate: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, obj: { - from: string; - to: string; - display: string; - section: number; -}[]) => unknown, thisArg?: any) => number) | ((value: { - from: string; - to: string; - display: string; - section: number; -}, start?: number | undefined, end?: number | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | ((target: number, start: number, end?: number | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | (() => IterableIterator<[number, { - from: string; - to: string; - display: string; - section: number; -}]>) | (() => IterableIterator) | (() => IterableIterator<{ - from: string; - to: string; - display: string; - section: number; -}>) | ((searchElement: { - from: string; - to: string; - display: string; - section: number; -}, fromIndex?: number | undefined) => boolean) | ((callback: (this: This, value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => U_3 | readonly U_3[], thisArg?: This | undefined) => U_3[]) | ((this: A, depth?: D | undefined) => { - done: A; - recur: A extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? any[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D] extends -1 ? "done" : "recur"] : A; -}[D extends -1 ? "done" : "recur"][]))[]>; -``` -Import - -```typescript -import { rangeUtil } from '@grafana/data'; -const { getRelativeTimesList } = rangeUtil; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| timepickerSettings | any | | -| currentDisplay | any | | - -Returns: - -`import("lodash").Dictionary<(number | { - from: string; - to: string; - display: string; - section: number; -} | (() => string) | (() => string) | (() => { - from: string; - to: string; - display: string; - section: number; -} | undefined) | ((...items: { - from: string; - to: string; - display: string; - section: number; -}[]) => number) | { - (...items: ConcatArray<{ - from: string; - to: string; - display: string; - section: number; - }>[]): { - from: string; - to: string; - display: string; - section: number; - }[]; - (...items: ({ - from: string; - to: string; - display: string; - section: number; - } | ConcatArray<{ - from: string; - to: string; - display: string; - section: number; - }>)[]): { - from: string; - to: string; - display: string; - section: number; - }[]; -} | ((separator?: string | undefined) => string) | (() => { - from: string; - to: string; - display: string; - section: number; -}[]) | (() => { - from: string; - to: string; - display: string; - section: number; -} | undefined) | ((start?: number | undefined, end?: number | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | ((compareFn?: ((a: { - from: string; - to: string; - display: string; - section: number; -}, b: { - from: string; - to: string; - display: string; - section: number; -}) => number) | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | { - (start: number, deleteCount?: number | undefined): { - from: string; - to: string; - display: string; - section: number; - }[]; - (start: number, deleteCount: number, ...items: { - from: string; - to: string; - display: string; - section: number; - }[]): { - from: string; - to: string; - display: string; - section: number; - }[]; -} | ((...items: { - from: string; - to: string; - display: string; - section: number; -}[]) => number) | ((searchElement: { - from: string; - to: string; - display: string; - section: number; -}, fromIndex?: number | undefined) => number) | ((searchElement: { - from: string; - to: string; - display: string; - section: number; -}, fromIndex?: number | undefined) => number) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => void, thisArg?: any) => void) | ((callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => U, thisArg?: any) => U[]) | { - (callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => value is S, thisArg?: any): S[]; - (callbackfn: (value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => unknown, thisArg?: any): { - from: string; - to: string; - display: string; - section: number; - }[]; -} | { - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }, initialValue: { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: U_1, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => U_1, initialValue: U_1): U_1; -} | { - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: { - from: string; - to: string; - display: string; - section: number; - }, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => { - from: string; - to: string; - display: string; - section: number; - }, initialValue: { - from: string; - to: string; - display: string; - section: number; - }): { - from: string; - to: string; - display: string; - section: number; - }; - (callbackfn: (previousValue: U_2, currentValue: { - from: string; - to: string; - display: string; - section: number; - }, currentIndex: number, array: { - from: string; - to: string; - display: string; - section: number; - }[]) => U_2, initialValue: U_2): U_2; -} | { - (predicate: (this: void, value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, obj: { - from: string; - to: string; - display: string; - section: number; - }[]) => value is S_1, thisArg?: any): S_1 | undefined; - (predicate: (value: { - from: string; - to: string; - display: string; - section: number; - }, index: number, obj: { - from: string; - to: string; - display: string; - section: number; - }[]) => unknown, thisArg?: any): { - from: string; - to: string; - display: string; - section: number; - } | undefined; -} | ((predicate: (value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, obj: { - from: string; - to: string; - display: string; - section: number; -}[]) => unknown, thisArg?: any) => number) | ((value: { - from: string; - to: string; - display: string; - section: number; -}, start?: number | undefined, end?: number | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | ((target: number, start: number, end?: number | undefined) => { - from: string; - to: string; - display: string; - section: number; -}[]) | (() => IterableIterator<[number, { - from: string; - to: string; - display: string; - section: number; -}]>) | (() => IterableIterator) | (() => IterableIterator<{ - from: string; - to: string; - display: string; - section: number; -}>) | ((searchElement: { - from: string; - to: string; - display: string; - section: number; -}, fromIndex?: number | undefined) => boolean) | ((callback: (this: This, value: { - from: string; - to: string; - display: string; - section: number; -}, index: number, array: { - from: string; - to: string; - display: string; - section: number; -}[]) => U_3 | readonly U_3[], thisArg?: This | undefined) => U_3[]) | ((this: A, depth?: D | undefined) => { - done: A; - recur: A extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? { - done: InnerArr; - recur: InnerArr extends readonly (infer InnerArr)[] ? any[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D]] extends -1 ? "done" : "recur"] : InnerArr; - }[[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20][D] extends -1 ? "done" : "recur"] : A; -}[D extends -1 ? "done" : "recur"][]))[]>` - diff --git a/docs/sources/packages_api/data/rangeutil/isvalidtimespan.md b/docs/sources/packages_api/data/rangeutil/isvalidtimespan.md deleted file mode 100644 index 71de822435a..00000000000 --- a/docs/sources/packages_api/data/rangeutil/isvalidtimespan.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "isValidTimeSpan" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## rangeUtil.isValidTimeSpan variable - -### rangeUtil.isValidTimeSpan variable - -Signature - -```typescript -isValidTimeSpan: (value: string) => boolean -``` -Import - -```typescript -import { rangeUtil } from '@grafana/data'; -const { isValidTimeSpan } = rangeUtil; -``` diff --git a/docs/sources/packages_api/data/rawtimerange.md b/docs/sources/packages_api/data/rawtimerange.md deleted file mode 100644 index c6b328f0b45..00000000000 --- a/docs/sources/packages_api/data/rawtimerange.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RawTimeRange" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## RawTimeRange interface - -Signature - -```typescript -export interface RawTimeRange -``` -Import - -```typescript -import { RawTimeRange } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [from](#from-property) | DateTime | string | | -| [to](#to-property) | DateTime | string | | - -### from property - -Signature - -```typescript -from: DateTime | string; -``` - -### to property - -Signature - -```typescript -to: DateTime | string; -``` diff --git a/docs/sources/packages_api/data/readcsv.md b/docs/sources/packages_api/data/readcsv.md deleted file mode 100644 index a8d09e47959..00000000000 --- a/docs/sources/packages_api/data/readcsv.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "readCSV" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## readCSV() function - -### readCSV() function - -Signature - -```typescript -export declare function readCSV(csv: string, options?: CSVOptions): DataFrame[]; -``` -Import - -```typescript -import { readCSV } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| csv | string | | -| options | CSVOptions | | - -Returns: - -`DataFrame[]` - diff --git a/docs/sources/packages_api/data/readwritevector.md b/docs/sources/packages_api/data/readwritevector.md deleted file mode 100644 index 297285393c5..00000000000 --- a/docs/sources/packages_api/data/readwritevector.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ReadWriteVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ReadWriteVector interface - -Apache arrow vectors are Read/Write - -Signature - -```typescript -export interface ReadWriteVector extends Vector -``` -Import - -```typescript -import { ReadWriteVector } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [set](#set-property) | (index: number, value: T) => void | | - -### set property - -Signature - -```typescript -set: (index: number, value: T) => void; -``` diff --git a/docs/sources/packages_api/data/reducedataoptions.md b/docs/sources/packages_api/data/reducedataoptions.md deleted file mode 100644 index b418ef69243..00000000000 --- a/docs/sources/packages_api/data/reducedataoptions.md +++ /dev/null @@ -1,69 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ReduceDataOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ReduceDataOptions interface - -Options for how to turn DataFrames into an array of display values - -Signature - -```typescript -export interface ReduceDataOptions -``` -Import - -```typescript -import { ReduceDataOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [calcs](#calcs-property) | string[] | When !values, pick one value for the whole field | -| [fields](#fields-property) | string | Which fields to show. By default this is only numeric fields | -| [limit](#limit-property) | number | if showing all values limit | -| [values](#values-property) | boolean | | - -### calcs property - -When !values, pick one value for the whole field - -Signature - -```typescript -calcs: string[]; -``` - -### fields property - -Which fields to show. By default this is only numeric fields - -Signature - -```typescript -fields?: string; -``` - -### limit property - -if showing all values limit - -Signature - -```typescript -limit?: number; -``` - -### values property - -Signature - -```typescript -values?: boolean; -``` diff --git a/docs/sources/packages_api/data/reducefield.md b/docs/sources/packages_api/data/reducefield.md deleted file mode 100644 index 76ea22189f3..00000000000 --- a/docs/sources/packages_api/data/reducefield.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "reduceField" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## reduceField() function - -### reduceField() function - -Signature - -```typescript -export declare function reduceField(options: ReduceFieldOptions): FieldCalcs; -``` -Import - -```typescript -import { reduceField } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | ReduceFieldOptions | | - -Returns: - -`FieldCalcs` - -an object with a key for each selected stat - diff --git a/docs/sources/packages_api/data/reducerid.md b/docs/sources/packages_api/data/reducerid.md deleted file mode 100644 index a784d5e6b12..00000000000 --- a/docs/sources/packages_api/data/reducerid.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ReducerID" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ReducerID enum - -### ReducerID enum - -Signature - -```typescript -export declare enum ReducerID -``` -Import - -```typescript -import { ReducerID } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| allIsNull | "allIsNull" | | -| allIsZero | "allIsZero" | | -| changeCount | "changeCount" | | -| count | "count" | | -| delta | "delta" | | -| diff | "diff" | | -| distinctCount | "distinctCount" | | -| first | "first" | | -| firstNotNull | "firstNotNull" | | -| last | "last" | | -| lastNotNull | "lastNotNull" | | -| logmin | "logmin" | | -| max | "max" | | -| mean | "mean" | | -| min | "min" | | -| range | "range" | | -| step | "step" | | -| sum | "sum" | | - diff --git a/docs/sources/packages_api/data/regexpornamesmatcheroptions.md b/docs/sources/packages_api/data/regexpornamesmatcheroptions.md deleted file mode 100644 index b5a37ac6362..00000000000 --- a/docs/sources/packages_api/data/regexpornamesmatcheroptions.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RegexpOrNamesMatcherOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## RegexpOrNamesMatcherOptions interface - -Signature - -```typescript -export interface RegexpOrNamesMatcherOptions -``` -Import - -```typescript -import { RegexpOrNamesMatcherOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [names](#names-property) | string[] | | -| [pattern](#pattern-property) | string | | - -### names property - -Signature - -```typescript -names?: string[]; -``` - -### pattern property - -Signature - -```typescript -pattern?: string; -``` diff --git a/docs/sources/packages_api/data/registry.md b/docs/sources/packages_api/data/registry.md deleted file mode 100644 index b2700a76e2b..00000000000 --- a/docs/sources/packages_api/data/registry.md +++ /dev/null @@ -1,166 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Registry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Registry class - -Signature - -```typescript -export declare class Registry -``` -Import - -```typescript -import { Registry } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(init)](#constructor-init) | | Constructs a new instance of the Registry class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [setInit](#setinit-property) | | (init: () => T[]) => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(id)](#get-method) | | | -| [getIfExists(id)](#getifexists-method) | | | -| [isEmpty()](#isempty-method) | | | -| [list(ids)](#list-method) | | Return a list of values by ID, or all values if not specified | -| [register(ext)](#register-method) | | | -| [selectOptions(current, filter)](#selectoptions-method) | | | - -### constructor(init) - -Constructs a new instance of the `Registry` class - -Signature - -```typescript -constructor(init?: (() => T[]) | undefined); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| init | (() => T[]) | undefined | | - -### setInit property - -Signature - -```typescript -setInit: (init: () => T[]) => void; -``` - -### get method - -Signature - -```typescript -get(id: string): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | - -Returns: - -`T` - -### getIfExists method - -Signature - -```typescript -getIfExists(id: string | undefined): T | undefined; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | undefined | | - -Returns: - -`T | undefined` - -### isEmpty method - -Signature - -```typescript -isEmpty(): boolean; -``` -Returns: - -`boolean` - -### list method - -Return a list of values by ID, or all values if not specified - -Signature - -```typescript -list(ids?: any[]): T[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ids | any[] | | - -Returns: - -`T[]` - -### register method - -Signature - -```typescript -register(ext: T): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| ext | T | | - -Returns: - -`void` - -### selectOptions method - -Signature - -```typescript -selectOptions(current?: string[], filter?: (ext: T) => boolean): RegistrySelectInfo; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| current | string[] | | -| filter | (ext: T) => boolean | | - -Returns: - -`RegistrySelectInfo` - diff --git a/docs/sources/packages_api/data/registryitem.md b/docs/sources/packages_api/data/registryitem.md deleted file mode 100644 index c515adf12f0..00000000000 --- a/docs/sources/packages_api/data/registryitem.md +++ /dev/null @@ -1,72 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RegistryItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## RegistryItem interface - -Signature - -```typescript -export interface RegistryItem -``` -Import - -```typescript -import { RegistryItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aliasIds](#aliasids-property) | string[] | | -| [description](#description-property) | string | | -| [excludeFromPicker](#excludefrompicker-property) | boolean | Some extensions should not be user selectable like: 'all' and 'any' matchers; | -| [id](#id-property) | string | | -| [name](#name-property) | string | | - -### aliasIds property - -Signature - -```typescript -aliasIds?: string[]; -``` - -### description property - -Signature - -```typescript -description?: string; -``` - -### excludeFromPicker property - -Some extensions should not be user selectable like: 'all' and 'any' matchers; - -Signature - -```typescript -excludeFromPicker?: boolean; -``` - -### id property - -Signature - -```typescript -id: string; -``` - -### name property - -Signature - -```typescript -name: string; -``` diff --git a/docs/sources/packages_api/data/registryitemwithoptions.md b/docs/sources/packages_api/data/registryitemwithoptions.md deleted file mode 100644 index 883034bab2c..00000000000 --- a/docs/sources/packages_api/data/registryitemwithoptions.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RegistryItemWithOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## RegistryItemWithOptions interface - -Signature - -```typescript -export interface RegistryItemWithOptions extends RegistryItem -``` -Import - -```typescript -import { RegistryItemWithOptions } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultOptions](#defaultoptions-property) | TOptions | Default options used if nothing else is specified | -| [getOptionsDisplayText](#getoptionsdisplaytext-property) | (options: TOptions) => string | Convert the options to a string | - -### defaultOptions property - -Default options used if nothing else is specified - -Signature - -```typescript -defaultOptions?: TOptions; -``` - -### getOptionsDisplayText property - -Convert the options to a string - -Signature - -```typescript -getOptionsDisplayText?: (options: TOptions) => string; -``` diff --git a/docs/sources/packages_api/data/rendermarkdown.md b/docs/sources/packages_api/data/rendermarkdown.md deleted file mode 100644 index 6e45e6ef15b..00000000000 --- a/docs/sources/packages_api/data/rendermarkdown.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "renderMarkdown" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## renderMarkdown() function - -### renderMarkdown() function - -Signature - -```typescript -export declare function renderMarkdown(str?: string): string; -``` -Import - -```typescript -import { renderMarkdown } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| str | string | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/reversedataframe.md b/docs/sources/packages_api/data/reversedataframe.md deleted file mode 100644 index fa541081cb0..00000000000 --- a/docs/sources/packages_api/data/reversedataframe.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "reverseDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## reverseDataFrame() function - -### reverseDataFrame() function - -Returns a copy with all values reversed - -Signature - -```typescript -export declare function reverseDataFrame(data: DataFrame): DataFrame; -``` -Import - -```typescript -import { reverseDataFrame } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame | | - -Returns: - -`DataFrame` - diff --git a/docs/sources/packages_api/data/scalecalculator.md b/docs/sources/packages_api/data/scalecalculator.md deleted file mode 100644 index f9802e42df6..00000000000 --- a/docs/sources/packages_api/data/scalecalculator.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ScaleCalculator" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ScaleCalculator type - -### ScaleCalculator type - -Signature - -```typescript -export declare type ScaleCalculator = (value: number) => ScaledValue; -``` -Import - -```typescript -import { ScaleCalculator } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/scaledunits.md b/docs/sources/packages_api/data/scaledunits.md deleted file mode 100644 index 2d38c22bb72..00000000000 --- a/docs/sources/packages_api/data/scaledunits.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "scaledUnits" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## scaledUnits() function - -### scaledUnits() function - -Signature - -```typescript -export declare function scaledUnits(factor: number, extArray: string[]): ValueFormatter; -``` -Import - -```typescript -import { scaledUnits } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| factor | number | | -| extArray | string[] | | - -Returns: - -`ValueFormatter` - diff --git a/docs/sources/packages_api/data/scaledvalue.md b/docs/sources/packages_api/data/scaledvalue.md deleted file mode 100644 index 3b181d2869c..00000000000 --- a/docs/sources/packages_api/data/scaledvalue.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ScaledValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ScaledValue interface - -Signature - -```typescript -export interface ScaledValue -``` -Import - -```typescript -import { ScaledValue } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | string | | -| [percent](#percent-property) | number | | -| [threshold](#threshold-property) | Threshold | | - -### color property - -Signature - -```typescript -color?: string; -``` - -### percent property - -Signature - -```typescript -percent?: number; -``` - -### threshold property - -Signature - -```typescript -threshold?: Threshold; -``` diff --git a/docs/sources/packages_api/data/scopedvar.md b/docs/sources/packages_api/data/scopedvar.md deleted file mode 100644 index 87a988de2f2..00000000000 --- a/docs/sources/packages_api/data/scopedvar.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ScopedVar" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ScopedVar interface - -Signature - -```typescript -export interface ScopedVar -``` -Import - -```typescript -import { ScopedVar } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [text](#text-property) | any | | -| [value](#value-property) | T | | - -### text property - -Signature - -```typescript -text: any; -``` - -### value property - -Signature - -```typescript -value: T; -``` diff --git a/docs/sources/packages_api/data/scopedvars.md b/docs/sources/packages_api/data/scopedvars.md deleted file mode 100644 index e7b2360eeff..00000000000 --- a/docs/sources/packages_api/data/scopedvars.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ScopedVars" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ScopedVars interface - -Signature - -```typescript -export interface ScopedVars -``` -Import - -```typescript -import { ScopedVars } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/screenshotinfo.md b/docs/sources/packages_api/data/screenshotinfo.md deleted file mode 100644 index 26215f49701..00000000000 --- a/docs/sources/packages_api/data/screenshotinfo.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ScreenshotInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ScreenshotInfo interface - -Signature - -```typescript -export interface ScreenshotInfo -``` -Import - -```typescript -import { ScreenshotInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [name](#name-property) | string | | -| [path](#path-property) | string | | - -### name property - -Signature - -```typescript -name: string; -``` - -### path property - -Signature - -```typescript -path: string; -``` diff --git a/docs/sources/packages_api/data/selectablevalue.md b/docs/sources/packages_api/data/selectablevalue.md deleted file mode 100644 index 76619539258..00000000000 --- a/docs/sources/packages_api/data/selectablevalue.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SelectableValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## SelectableValue interface - -Used in select elements - -Signature - -```typescript -export interface SelectableValue -``` -Import - -```typescript -import { SelectableValue } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description](#description-property) | string | | -| [imgUrl](#imgurl-property) | string | | -| [label](#label-property) | string | | -| [value](#value-property) | T | | - -### description property - -Signature - -```typescript -description?: string; -``` - -### imgUrl property - -Signature - -```typescript -imgUrl?: string; -``` - -### label property - -Signature - -```typescript -label?: string; -``` - -### value property - -Signature - -```typescript -value?: T; -``` diff --git a/docs/sources/packages_api/data/selectfieldconfigsettings.md b/docs/sources/packages_api/data/selectfieldconfigsettings.md deleted file mode 100644 index b1adc5f9c0c..00000000000 --- a/docs/sources/packages_api/data/selectfieldconfigsettings.md +++ /dev/null @@ -1,56 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SelectFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## SelectFieldConfigSettings interface - -Signature - -```typescript -export interface SelectFieldConfigSettings -``` -Import - -```typescript -import { SelectFieldConfigSettings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allowCustomValue](#allowcustomvalue-property) | boolean | | -| [getOptions](#getoptions-property) | (context: FieldOverrideContext) => Promise<Array<SelectableValue<T>>> | Optionally use the context to define the options | -| [options](#options-property) | Array<SelectableValue<T>> | The default options | - -### allowCustomValue property - -Signature - -```typescript -allowCustomValue?: boolean; -``` - -### getOptions property - -Optionally use the context to define the options - -Signature - -```typescript -getOptions?: (context: FieldOverrideContext) => Promise>>; -``` - -### options property - -The default options - -Signature - -```typescript -options: Array>; -``` diff --git a/docs/sources/packages_api/data/selectoverrideprocessor.md b/docs/sources/packages_api/data/selectoverrideprocessor.md deleted file mode 100644 index fdc1610ab0c..00000000000 --- a/docs/sources/packages_api/data/selectoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "selectOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## selectOverrideProcessor variable - -### selectOverrideProcessor variable - -Signature - -```typescript -selectOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: SelectFieldConfigSettings | undefined) => any -``` -Import - -```typescript -import { selectOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/setlocale.md b/docs/sources/packages_api/data/setlocale.md deleted file mode 100644 index 6e71f106564..00000000000 --- a/docs/sources/packages_api/data/setlocale.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "setLocale" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## setLocale variable - -### setLocale variable - -Signature - -```typescript -setLocale: (language: string) => void -``` -Import - -```typescript -import { setLocale } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/setmarkdownoptions.md b/docs/sources/packages_api/data/setmarkdownoptions.md deleted file mode 100644 index edf7a611c23..00000000000 --- a/docs/sources/packages_api/data/setmarkdownoptions.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "setMarkdownOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## setMarkdownOptions() function - -### setMarkdownOptions() function - -Signature - -```typescript -export declare function setMarkdownOptions(optionsOverride?: MarkedOptions): void; -``` -Import - -```typescript -import { setMarkdownOptions } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| optionsOverride | MarkedOptions | | - -Returns: - -`void` - diff --git a/docs/sources/packages_api/data/simplecountunit.md b/docs/sources/packages_api/data/simplecountunit.md deleted file mode 100644 index 68982c92682..00000000000 --- a/docs/sources/packages_api/data/simplecountunit.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "simpleCountUnit" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## simpleCountUnit() function - -### simpleCountUnit() function - -Signature - -```typescript -export declare function simpleCountUnit(symbol: string): ValueFormatter; -``` -Import - -```typescript -import { simpleCountUnit } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| symbol | string | | - -Returns: - -`ValueFormatter` - diff --git a/docs/sources/packages_api/data/sortdataframe.md b/docs/sources/packages_api/data/sortdataframe.md deleted file mode 100644 index d9281fa1a0d..00000000000 --- a/docs/sources/packages_api/data/sortdataframe.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "sortDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## sortDataFrame() function - -### sortDataFrame() function - -Signature - -```typescript -export declare function sortDataFrame(data: DataFrame, sortIndex?: number, reverse?: boolean): DataFrame; -``` -Import - -```typescript -import { sortDataFrame } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame | | -| sortIndex | number | | -| reverse | boolean | | - -Returns: - -`DataFrame` - diff --git a/docs/sources/packages_api/data/sortedvector.md b/docs/sources/packages_api/data/sortedvector.md deleted file mode 100644 index d44d976de66..00000000000 --- a/docs/sources/packages_api/data/sortedvector.md +++ /dev/null @@ -1,106 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SortedVector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## SortedVector class - -Values are returned in the order defined by the input parameter - -Signature - -```typescript -export declare class SortedVector implements Vector -``` -Import - -```typescript -import { SortedVector } from '@grafana/data'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(source, order)](#constructor-sourceorder) | | Constructs a new instance of the SortedVector class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [length](#length-property) | | number | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(index)](#get-method) | | | -| [toArray()](#toarray-method) | | | -| [toJSON()](#tojson-method) | | | - -### constructor(source, order) - -Constructs a new instance of the `SortedVector` class - -Signature - -```typescript -constructor(source: Vector, order: number[]); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| source | Vector<T> | | -| order | number[] | | - -### length property - -Signature - -```typescript -get length(): number; -``` - -### get method - -Signature - -```typescript -get(index: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`T` - -### toArray method - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - -### toJSON method - -Signature - -```typescript -toJSON(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/sortthresholds.md b/docs/sources/packages_api/data/sortthresholds.md deleted file mode 100644 index 3904bc4d0b1..00000000000 --- a/docs/sources/packages_api/data/sortthresholds.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "sortThresholds" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## sortThresholds() function - -### sortThresholds() function - -Sorts the thresholds - -Signature - -```typescript -export declare function sortThresholds(thresholds: Threshold[]): Threshold[]; -``` -Import - -```typescript -import { sortThresholds } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| thresholds | Threshold[] | | - -Returns: - -`Threshold[]` - diff --git a/docs/sources/packages_api/data/standardeditorcontext.md b/docs/sources/packages_api/data/standardeditorcontext.md deleted file mode 100644 index 7eb6d232a67..00000000000 --- a/docs/sources/packages_api/data/standardeditorcontext.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StandardEditorContext" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## StandardEditorContext interface - -Signature - -```typescript -export interface StandardEditorContext -``` -Import - -```typescript -import { StandardEditorContext } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | DataFrame[] | | -| [getSuggestions](#getsuggestions-property) | (scope?: VariableSuggestionsScope) => VariableSuggestion[] | | -| [options](#options-property) | TOptions | | -| [replaceVariables](#replacevariables-property) | InterpolateFunction | | - -### data property - -Signature - -```typescript -data?: DataFrame[]; -``` - -### getSuggestions property - -Signature - -```typescript -getSuggestions?: (scope?: VariableSuggestionsScope) => VariableSuggestion[]; -``` - -### options property - -Signature - -```typescript -options?: TOptions; -``` - -### replaceVariables property - -Signature - -```typescript -replaceVariables?: InterpolateFunction; -``` diff --git a/docs/sources/packages_api/data/standardeditorprops.md b/docs/sources/packages_api/data/standardeditorprops.md deleted file mode 100644 index 2af4f7c8a38..00000000000 --- a/docs/sources/packages_api/data/standardeditorprops.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StandardEditorProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## StandardEditorProps interface - -Signature - -```typescript -export interface StandardEditorProps -``` -Import - -```typescript -import { StandardEditorProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](#context-property) | StandardEditorContext<TOptions> | | -| [item](#item-property) | StandardEditorsRegistryItem<TValue, TSettings> | | -| [onChange](#onchange-property) | (value?: TValue) => void | | -| [value](#value-property) | TValue | | - -### context property - -Signature - -```typescript -context: StandardEditorContext; -``` - -### item property - -Signature - -```typescript -item: StandardEditorsRegistryItem; -``` - -### onChange property - -Signature - -```typescript -onChange: (value?: TValue) => void; -``` - -### value property - -Signature - -```typescript -value: TValue; -``` diff --git a/docs/sources/packages_api/data/standardeditorsregistry.md b/docs/sources/packages_api/data/standardeditorsregistry.md deleted file mode 100644 index 840f17daebf..00000000000 --- a/docs/sources/packages_api/data/standardeditorsregistry.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "standardEditorsRegistry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## standardEditorsRegistry variable - -### standardEditorsRegistry variable - -Signature - -```typescript -standardEditorsRegistry: Registry> -``` -Import - -```typescript -import { standardEditorsRegistry } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/standardeditorsregistryitem.md b/docs/sources/packages_api/data/standardeditorsregistryitem.md deleted file mode 100644 index 98e8c9d60a3..00000000000 --- a/docs/sources/packages_api/data/standardeditorsregistryitem.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StandardEditorsRegistryItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## StandardEditorsRegistryItem interface - -Signature - -```typescript -export interface StandardEditorsRegistryItem extends RegistryItem -``` -Import - -```typescript -import { StandardEditorsRegistryItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [editor](#editor-property) | ComponentType<StandardEditorProps<TValue, TSettings>> | | -| [settings](#settings-property) | TSettings | | - -### editor property - -Signature - -```typescript -editor: ComponentType>; -``` - -### settings property - -Signature - -```typescript -settings?: TSettings; -``` diff --git a/docs/sources/packages_api/data/standardfieldconfigeditorregistry.md b/docs/sources/packages_api/data/standardfieldconfigeditorregistry.md deleted file mode 100644 index 20ea2f14baa..00000000000 --- a/docs/sources/packages_api/data/standardfieldconfigeditorregistry.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "standardFieldConfigEditorRegistry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## standardFieldConfigEditorRegistry variable - -### standardFieldConfigEditorRegistry variable - -Signature - -```typescript -standardFieldConfigEditorRegistry: FieldConfigOptionsRegistry -``` -Import - -```typescript -import { standardFieldConfigEditorRegistry } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/standardtransformers.md b/docs/sources/packages_api/data/standardtransformers.md deleted file mode 100644 index 791bfbf3fc7..00000000000 --- a/docs/sources/packages_api/data/standardtransformers.md +++ /dev/null @@ -1,39 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "standardTransformers" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## standardTransformers variable - -### standardTransformers variable - -Signature - -```typescript -standardTransformers: { - noopTransformer: import("..").DataTransformerInfo; - filterFieldsTransformer: import("..").DataTransformerInfo; - filterFieldsByNameTransformer: import("..").DataTransformerInfo; - filterFramesTransformer: import("..").DataTransformerInfo; - filterFramesByRefIdTransformer: import("..").DataTransformerInfo; - orderFieldsTransformer: import("..").DataTransformerInfo; - organizeFieldsTransformer: import("..").DataTransformerInfo; - appendTransformer: import("..").DataTransformerInfo; - reduceTransformer: import("..").DataTransformerInfo; - calculateFieldTransformer: import("..").DataTransformerInfo; - seriesToColumnsTransformer: import("..").DataTransformerInfo; - renameFieldsTransformer: import("..").DataTransformerInfo; - labelsToFieldsTransformer: import("..").DataTransformerInfo; - ensureColumnsTransformer: import("..").DataTransformerInfo; - mergeTransformer: import("..").DataTransformerInfo; -} -``` -Import - -```typescript -import { standardTransformers } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/standardtransformersregistry.md b/docs/sources/packages_api/data/standardtransformersregistry.md deleted file mode 100644 index d326d57047a..00000000000 --- a/docs/sources/packages_api/data/standardtransformersregistry.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "standardTransformersRegistry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## standardTransformersRegistry variable - -### standardTransformersRegistry variable - -Registry of transformation options that can be driven by stored configuration files. - -Signature - -```typescript -standardTransformersRegistry: Registry> -``` -Import - -```typescript -import { standardTransformersRegistry } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/stringfieldconfigsettings.md b/docs/sources/packages_api/data/stringfieldconfigsettings.md deleted file mode 100644 index 644882eed03..00000000000 --- a/docs/sources/packages_api/data/stringfieldconfigsettings.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StringFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## StringFieldConfigSettings interface - -Signature - -```typescript -export interface StringFieldConfigSettings -``` -Import - -```typescript -import { StringFieldConfigSettings } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [expandTemplateVars](#expandtemplatevars-property) | boolean | | -| [maxLength](#maxlength-property) | number | | -| [placeholder](#placeholder-property) | string | | -| [rows](#rows-property) | number | | -| [useTextarea](#usetextarea-property) | boolean | | - -### expandTemplateVars property - -Signature - -```typescript -expandTemplateVars?: boolean; -``` - -### maxLength property - -Signature - -```typescript -maxLength?: number; -``` - -### placeholder property - -Signature - -```typescript -placeholder?: string; -``` - -### rows property - -Signature - -```typescript -rows?: number; -``` - -### useTextarea property - -Signature - -```typescript -useTextarea?: boolean; -``` diff --git a/docs/sources/packages_api/data/stringoverrideprocessor.md b/docs/sources/packages_api/data/stringoverrideprocessor.md deleted file mode 100644 index 0e14a9d831d..00000000000 --- a/docs/sources/packages_api/data/stringoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "stringOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## stringOverrideProcessor variable - -### stringOverrideProcessor variable - -Signature - -```typescript -stringOverrideProcessor: (value: any, context: FieldOverrideContext, settings?: StringFieldConfigSettings | undefined) => any -``` -Import - -```typescript -import { stringOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/stringstartsasregex.md b/docs/sources/packages_api/data/stringstartsasregex.md deleted file mode 100644 index 1ee1fd76c10..00000000000 --- a/docs/sources/packages_api/data/stringstartsasregex.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "stringStartsAsRegEx" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## stringStartsAsRegEx() function - -### stringStartsAsRegEx() function - -Signature - -```typescript -export declare function stringStartsAsRegEx(str: string): boolean; -``` -Import - -```typescript -import { stringStartsAsRegEx } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| str | string | | - -Returns: - -`boolean` - diff --git a/docs/sources/packages_api/data/stringtojsregex.md b/docs/sources/packages_api/data/stringtojsregex.md deleted file mode 100644 index 0c9b0a6dd9c..00000000000 --- a/docs/sources/packages_api/data/stringtojsregex.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "stringToJsRegex" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## stringToJsRegex() function - -### stringToJsRegex() function - -Signature - -```typescript -export declare function stringToJsRegex(str: string): RegExp; -``` -Import - -```typescript -import { stringToJsRegex } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| str | string | | - -Returns: - -`RegExp` - diff --git a/docs/sources/packages_api/data/stringtoms.md b/docs/sources/packages_api/data/stringtoms.md deleted file mode 100644 index c6cc6eea6f0..00000000000 --- a/docs/sources/packages_api/data/stringtoms.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "stringToMs" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## stringToMs() function - -### stringToMs() function - -Signature - -```typescript -export declare function stringToMs(str: string): number; -``` -Import - -```typescript -import { stringToMs } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| str | string | | - -Returns: - -`number` - diff --git a/docs/sources/packages_api/data/subtract.md b/docs/sources/packages_api/data/subtract.md deleted file mode 100644 index b9708203f2a..00000000000 --- a/docs/sources/packages_api/data/subtract.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Subtract" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Subtract type - -### Subtract type - -Signature - -```typescript -export declare type Subtract = Omit; -``` -Import - -```typescript -import { Subtract } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tabledata.md b/docs/sources/packages_api/data/tabledata.md deleted file mode 100644 index dd40e4e1de9..00000000000 --- a/docs/sources/packages_api/data/tabledata.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TableData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TableData interface - -Signature - -```typescript -export interface TableData extends QueryResultBase -``` -Import - -```typescript -import { TableData } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [columns](#columns-property) | Column[] | | -| [name](#name-property) | string | | -| [rows](#rows-property) | any[][] | | -| [type](#type-property) | string | | - -### columns property - -Signature - -```typescript -columns: Column[]; -``` - -### name property - -Signature - -```typescript -name?: string; -``` - -### rows property - -Signature - -```typescript -rows: any[][]; -``` - -### type property - -Signature - -```typescript -type?: string; -``` diff --git a/docs/sources/packages_api/data/textmatch.md b/docs/sources/packages_api/data/textmatch.md deleted file mode 100644 index c688d512275..00000000000 --- a/docs/sources/packages_api/data/textmatch.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TextMatch" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TextMatch interface - -Signature - -```typescript -export interface TextMatch -``` -Import - -```typescript -import { TextMatch } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [end](#end-property) | number | | -| [length](#length-property) | number | | -| [start](#start-property) | number | | -| [text](#text-property) | string | | - -### end property - -Signature - -```typescript -end: number; -``` - -### length property - -Signature - -```typescript -length: number; -``` - -### start property - -Signature - -```typescript -start: number; -``` - -### text property - -Signature - -```typescript -text: string; -``` diff --git a/docs/sources/packages_api/data/textutil.md b/docs/sources/packages_api/data/textutil.md deleted file mode 100644 index 8bb094db764..00000000000 --- a/docs/sources/packages_api/data/textutil.md +++ /dev/null @@ -1,28 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "textUtil" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## textUtil variable - -### textUtil variable - -Signature - -```typescript -textUtil: { - escapeHtml: typeof escapeHtml; - hasAnsiCodes: typeof hasAnsiCodes; - sanitize: typeof sanitize; - sanitizeUrl: typeof sanitizeUrl; -} -``` -Import - -```typescript -import { textUtil } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/threshold.md b/docs/sources/packages_api/data/threshold.md deleted file mode 100644 index eea2b880eea..00000000000 --- a/docs/sources/packages_api/data/threshold.md +++ /dev/null @@ -1,54 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Threshold" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Threshold interface - -Signature - -```typescript -export interface Threshold -``` -Import - -```typescript -import { Threshold } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | string | | -| [state](#state-property) | string | Warning, Error, LowLow, Low, OK, High, HighHigh etc | -| [value](#value-property) | number | | - -### color property - -Signature - -```typescript -color: string; -``` - -### state property - -Warning, Error, LowLow, Low, OK, High, HighHigh etc - -Signature - -```typescript -state?: string; -``` - -### value property - -Signature - -```typescript -value: number; -``` diff --git a/docs/sources/packages_api/data/thresholdsconfig.md b/docs/sources/packages_api/data/thresholdsconfig.md deleted file mode 100644 index d339ce48755..00000000000 --- a/docs/sources/packages_api/data/thresholdsconfig.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ThresholdsConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ThresholdsConfig interface - -Config that is passed to the ThresholdsEditor - -Signature - -```typescript -export interface ThresholdsConfig -``` -Import - -```typescript -import { ThresholdsConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [mode](#mode-property) | ThresholdsMode | | -| [steps](#steps-property) | Threshold[] | Must be sorted by 'value', first value is always -Infinity | - -### mode property - -Signature - -```typescript -mode: ThresholdsMode; -``` - -### steps property - -Must be sorted by 'value', first value is always -Infinity - -Signature - -```typescript -steps: Threshold[]; -``` diff --git a/docs/sources/packages_api/data/thresholdsfieldconfigsettings.md b/docs/sources/packages_api/data/thresholdsfieldconfigsettings.md deleted file mode 100644 index e606c5bafb8..00000000000 --- a/docs/sources/packages_api/data/thresholdsfieldconfigsettings.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ThresholdsFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ThresholdsFieldConfigSettings interface - -Signature - -```typescript -export interface ThresholdsFieldConfigSettings -``` -Import - -```typescript -import { ThresholdsFieldConfigSettings } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/thresholdsmode.md b/docs/sources/packages_api/data/thresholdsmode.md deleted file mode 100644 index 02c7c5d25e9..00000000000 --- a/docs/sources/packages_api/data/thresholdsmode.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ThresholdsMode" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ThresholdsMode enum - -### ThresholdsMode enum - -Display mode - -Signature - -```typescript -export declare enum ThresholdsMode -``` -Import - -```typescript -import { ThresholdsMode } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Absolute | "absolute" | | -| Percentage | "percentage" | between 0 and 1 (based on min/max) | - diff --git a/docs/sources/packages_api/data/thresholdsoverrideprocessor.md b/docs/sources/packages_api/data/thresholdsoverrideprocessor.md deleted file mode 100644 index 7613d5269f4..00000000000 --- a/docs/sources/packages_api/data/thresholdsoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "thresholdsOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## thresholdsOverrideProcessor variable - -### thresholdsOverrideProcessor variable - -Signature - -```typescript -thresholdsOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: ThresholdsFieldConfigSettings | undefined) => ThresholdsConfig -``` -Import - -```typescript -import { thresholdsOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/time_format.md b/docs/sources/packages_api/data/time_format.md deleted file mode 100644 index f0d4f852ca9..00000000000 --- a/docs/sources/packages_api/data/time_format.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TIME_FORMAT" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TIME\_FORMAT variable - -### TIME\_FORMAT variable - -Signature - -```typescript -TIME_FORMAT = "YYYY-MM-DD HH:mm:ss" -``` -Import - -```typescript -import { TIME_FORMAT } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/time_series_time_field_name.md b/docs/sources/packages_api/data/time_series_time_field_name.md deleted file mode 100644 index 3d5f1db97a7..00000000000 --- a/docs/sources/packages_api/data/time_series_time_field_name.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TIME_SERIES_TIME_FIELD_NAME" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TIME\_SERIES\_TIME\_FIELD\_NAME variable - -### TIME\_SERIES\_TIME\_FIELD\_NAME variable - -Signature - -```typescript -TIME_SERIES_TIME_FIELD_NAME = "Time" -``` -Import - -```typescript -import { TIME_SERIES_TIME_FIELD_NAME } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/time_series_value_field_name.md b/docs/sources/packages_api/data/time_series_value_field_name.md deleted file mode 100644 index 28861b03ba9..00000000000 --- a/docs/sources/packages_api/data/time_series_value_field_name.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TIME_SERIES_VALUE_FIELD_NAME" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TIME\_SERIES\_VALUE\_FIELD\_NAME variable - -### TIME\_SERIES\_VALUE\_FIELD\_NAME variable - -Signature - -```typescript -TIME_SERIES_VALUE_FIELD_NAME = "Value" -``` -Import - -```typescript -import { TIME_SERIES_VALUE_FIELD_NAME } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timefragment.md b/docs/sources/packages_api/data/timefragment.md deleted file mode 100644 index 19141d7d03c..00000000000 --- a/docs/sources/packages_api/data/timefragment.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeFragment" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeFragment type - -### TimeFragment type - -Signature - -```typescript -export declare type TimeFragment = string | DateTime; -``` -Import - -```typescript -import { TimeFragment } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timeoption.md b/docs/sources/packages_api/data/timeoption.md deleted file mode 100644 index 22dcdf2c570..00000000000 --- a/docs/sources/packages_api/data/timeoption.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeOption interface - -Signature - -```typescript -export interface TimeOption -``` -Import - -```typescript -import { TimeOption } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [display](#display-property) | string | | -| [from](#from-property) | string | | -| [section](#section-property) | number | | -| [to](#to-property) | string | | - -### display property - -Signature - -```typescript -display: string; -``` - -### from property - -Signature - -```typescript -from: string; -``` - -### section property - -Signature - -```typescript -section: number; -``` - -### to property - -Signature - -```typescript -to: string; -``` diff --git a/docs/sources/packages_api/data/timeoptions.md b/docs/sources/packages_api/data/timeoptions.md deleted file mode 100644 index d3db038bf12..00000000000 --- a/docs/sources/packages_api/data/timeoptions.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeOptions" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeOptions interface - -Signature - -```typescript -export interface TimeOptions -``` -Import - -```typescript -import { TimeOptions } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timerange.md b/docs/sources/packages_api/data/timerange.md deleted file mode 100644 index fcb38a20988..00000000000 --- a/docs/sources/packages_api/data/timerange.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeRange" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeRange interface - -Signature - -```typescript -export interface TimeRange -``` -Import - -```typescript -import { TimeRange } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [from](#from-property) | DateTime | | -| [raw](#raw-property) | RawTimeRange | | -| [to](#to-property) | DateTime | | - -### from property - -Signature - -```typescript -from: DateTime; -``` - -### raw property - -Signature - -```typescript -raw: RawTimeRange; -``` - -### to property - -Signature - -```typescript -to: DateTime; -``` diff --git a/docs/sources/packages_api/data/timeseries.md b/docs/sources/packages_api/data/timeseries.md deleted file mode 100644 index 4efca71ae0e..00000000000 --- a/docs/sources/packages_api/data/timeseries.md +++ /dev/null @@ -1,72 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeSeries" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeSeries interface - -Signature - -```typescript -export interface TimeSeries extends QueryResultBase -``` -Import - -```typescript -import { TimeSeries } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [datapoints](#datapoints-property) | TimeSeriesPoints | | -| [tags](#tags-property) | Labels | | -| [target](#target-property) | string | | -| [title](#title-property) | string | If name is manually configured via an alias / legend pattern | -| [unit](#unit-property) | string | | - -### datapoints property - -Signature - -```typescript -datapoints: TimeSeriesPoints; -``` - -### tags property - -Signature - -```typescript -tags?: Labels; -``` - -### target property - -Signature - -```typescript -target: string; -``` - -### title property - -If name is manually configured via an alias / legend pattern - -Signature - -```typescript -title?: string; -``` - -### unit property - -Signature - -```typescript -unit?: string; -``` diff --git a/docs/sources/packages_api/data/timeseriespoints.md b/docs/sources/packages_api/data/timeseriespoints.md deleted file mode 100644 index 41b78712a75..00000000000 --- a/docs/sources/packages_api/data/timeseriespoints.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeSeriesPoints" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeSeriesPoints type - -### TimeSeriesPoints type - -Signature - -```typescript -export declare type TimeSeriesPoints = TimeSeriesValue[][]; -``` -Import - -```typescript -import { TimeSeriesPoints } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timeseriesvalue.md b/docs/sources/packages_api/data/timeseriesvalue.md deleted file mode 100644 index 04d96a4fe2a..00000000000 --- a/docs/sources/packages_api/data/timeseriesvalue.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeSeriesValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeSeriesValue type - -### TimeSeriesValue type - -Signature - -```typescript -export declare type TimeSeriesValue = number | null; -``` -Import - -```typescript -import { TimeSeriesValue } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timezone.md b/docs/sources/packages_api/data/timezone.md deleted file mode 100644 index 985a0883ff5..00000000000 --- a/docs/sources/packages_api/data/timezone.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZone" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeZone type - -### TimeZone type - -Signature - -```typescript -export declare type TimeZone = TimeZoneBrowser | TimeZoneUtc | string; -``` -Import - -```typescript -import { TimeZone } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timezoneabbrevation.md b/docs/sources/packages_api/data/timezoneabbrevation.md deleted file mode 100644 index 21e5f96c4c8..00000000000 --- a/docs/sources/packages_api/data/timezoneabbrevation.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "timeZoneAbbrevation" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## timeZoneAbbrevation variable - -### timeZoneAbbrevation variable - -Helper function to return only the time zone abbreviation for a given date and time value. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md). - -Signature - -```typescript -timeZoneAbbrevation: DateTimeFormatter -``` -Import - -```typescript -import { timeZoneAbbrevation } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timezonebrowser.md b/docs/sources/packages_api/data/timezonebrowser.md deleted file mode 100644 index 713d49c8374..00000000000 --- a/docs/sources/packages_api/data/timezonebrowser.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZoneBrowser" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeZoneBrowser type - -### TimeZoneBrowser type - -Signature - -```typescript -export declare type TimeZoneBrowser = 'browser'; -``` -Import - -```typescript -import { TimeZoneBrowser } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timezonecountry.md b/docs/sources/packages_api/data/timezonecountry.md deleted file mode 100644 index aa7997b1b24..00000000000 --- a/docs/sources/packages_api/data/timezonecountry.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZoneCountry" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeZoneCountry interface - -Signature - -```typescript -export interface TimeZoneCountry -``` -Import - -```typescript -import { TimeZoneCountry } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [code](#code-property) | string | | -| [name](#name-property) | string | | - -### code property - -Signature - -```typescript -code: string; -``` - -### name property - -Signature - -```typescript -name: string; -``` diff --git a/docs/sources/packages_api/data/timezoneformatuserfriendly.md b/docs/sources/packages_api/data/timezoneformatuserfriendly.md deleted file mode 100644 index c86c28f638a..00000000000 --- a/docs/sources/packages_api/data/timezoneformatuserfriendly.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "timeZoneFormatUserFriendly" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## timeZoneFormatUserFriendly variable - -### timeZoneFormatUserFriendly variable - -Signature - -```typescript -timeZoneFormatUserFriendly: (timeZone: TimeZone | undefined) => string | undefined -``` -Import - -```typescript -import { timeZoneFormatUserFriendly } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timezoneinfo.md b/docs/sources/packages_api/data/timezoneinfo.md deleted file mode 100644 index fee7ff81e79..00000000000 --- a/docs/sources/packages_api/data/timezoneinfo.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZoneInfo" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeZoneInfo interface - -Signature - -```typescript -export interface TimeZoneInfo -``` -Import - -```typescript -import { TimeZoneInfo } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [abbreviation](#abbreviation-property) | string | | -| [countries](#countries-property) | TimeZoneCountry[] | | -| [name](#name-property) | string | | -| [offsetInMins](#offsetinmins-property) | number | | -| [zone](#zone-property) | string | | - -### abbreviation property - -Signature - -```typescript -abbreviation: string; -``` - -### countries property - -Signature - -```typescript -countries: TimeZoneCountry[]; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### offsetInMins property - -Signature - -```typescript -offsetInMins: number; -``` - -### zone property - -Signature - -```typescript -zone: string; -``` diff --git a/docs/sources/packages_api/data/timezoneresolver.md b/docs/sources/packages_api/data/timezoneresolver.md deleted file mode 100644 index cfcd5a5c768..00000000000 --- a/docs/sources/packages_api/data/timezoneresolver.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZoneResolver" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeZoneResolver type - -### TimeZoneResolver type - -The type to describe the time zone resolver function that will be used to access the default time zone of a user. - -Signature - -```typescript -export declare type TimeZoneResolver = () => TimeZone | undefined; -``` -Import - -```typescript -import { TimeZoneResolver } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/timezoneutc.md b/docs/sources/packages_api/data/timezoneutc.md deleted file mode 100644 index 5890c42070f..00000000000 --- a/docs/sources/packages_api/data/timezoneutc.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZoneUtc" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TimeZoneUtc type - -### TimeZoneUtc type - -Signature - -```typescript -export declare type TimeZoneUtc = 'utc'; -``` -Import - -```typescript -import { TimeZoneUtc } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tocsv.md b/docs/sources/packages_api/data/tocsv.md deleted file mode 100644 index daa08a1337c..00000000000 --- a/docs/sources/packages_api/data/tocsv.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toCSV" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toCSV() function - -### toCSV() function - -Signature - -```typescript -export declare function toCSV(data: DataFrame[], config?: CSVConfig): string; -``` -Import - -```typescript -import { toCSV } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame[] | | -| config | CSVConfig | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/todataframe.md b/docs/sources/packages_api/data/todataframe.md deleted file mode 100644 index 9b5103527f3..00000000000 --- a/docs/sources/packages_api/data/todataframe.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toDataFrame() function - -### toDataFrame() function - -Inspect any object and return the results as a DataFrame - -Signature - -```typescript -export declare function toDataFrame(data: any): DataFrame; -``` -Import - -```typescript -import { toDataFrame } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | any | | - -Returns: - -`DataFrame` - diff --git a/docs/sources/packages_api/data/todataframedto.md b/docs/sources/packages_api/data/todataframedto.md deleted file mode 100644 index 327015cd808..00000000000 --- a/docs/sources/packages_api/data/todataframedto.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toDataFrameDTO" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toDataFrameDTO() function - -### toDataFrameDTO() function - -Returns a copy that does not include functions - -Signature - -```typescript -export declare function toDataFrameDTO(data: DataFrame): DataFrameDTO; -``` -Import - -```typescript -import { toDataFrameDTO } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| data | DataFrame | | - -Returns: - -`DataFrameDTO` - diff --git a/docs/sources/packages_api/data/toduration.md b/docs/sources/packages_api/data/toduration.md deleted file mode 100644 index e3e6ca63784..00000000000 --- a/docs/sources/packages_api/data/toduration.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toDuration" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toDuration variable - -### toDuration variable - -Signature - -```typescript -toDuration: (input?: string | number | DateTimeDuration | undefined, unit?: "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" | undefined) => DateTimeDuration -``` -Import - -```typescript -import { toDuration } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tofixed.md b/docs/sources/packages_api/data/tofixed.md deleted file mode 100644 index 584f3f22222..00000000000 --- a/docs/sources/packages_api/data/tofixed.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toFixed" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toFixed() function - -### toFixed() function - -Signature - -```typescript -export declare function toFixed(value: number, decimals?: DecimalCount): string; -``` -Import - -```typescript -import { toFixed } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | -| decimals | DecimalCount | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/tofixedscaled.md b/docs/sources/packages_api/data/tofixedscaled.md deleted file mode 100644 index 94e103ad2c8..00000000000 --- a/docs/sources/packages_api/data/tofixedscaled.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toFixedScaled" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toFixedScaled() function - -### toFixedScaled() function - -Signature - -```typescript -export declare function toFixedScaled(value: number, decimals: DecimalCount, scaledDecimals: DecimalCount, additionalDecimals: number, ext?: string): FormattedValue; -``` -Import - -```typescript -import { toFixedScaled } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | -| decimals | DecimalCount | | -| scaledDecimals | DecimalCount | | -| additionalDecimals | number | | -| ext | string | | - -Returns: - -`FormattedValue` - diff --git a/docs/sources/packages_api/data/tofixedunit.md b/docs/sources/packages_api/data/tofixedunit.md deleted file mode 100644 index b5a32ee1116..00000000000 --- a/docs/sources/packages_api/data/tofixedunit.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toFixedUnit" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toFixedUnit() function - -### toFixedUnit() function - -Signature - -```typescript -export declare function toFixedUnit(unit: string, asPrefix?: boolean): ValueFormatter; -``` -Import - -```typescript -import { toFixedUnit } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| unit | string | | -| asPrefix | boolean | | - -Returns: - -`ValueFormatter` - diff --git a/docs/sources/packages_api/data/tofloatorundefined.md b/docs/sources/packages_api/data/tofloatorundefined.md deleted file mode 100644 index 16a80dc42ba..00000000000 --- a/docs/sources/packages_api/data/tofloatorundefined.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toFloatOrUndefined" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toFloatOrUndefined() function - -### toFloatOrUndefined() function - -Signature - -```typescript -export declare function toFloatOrUndefined(value: string): number | undefined; -``` -Import - -```typescript -import { toFloatOrUndefined } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | | - -Returns: - -`number | undefined` - diff --git a/docs/sources/packages_api/data/tointegerorundefined.md b/docs/sources/packages_api/data/tointegerorundefined.md deleted file mode 100644 index 82351a8ec26..00000000000 --- a/docs/sources/packages_api/data/tointegerorundefined.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toIntegerOrUndefined" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toIntegerOrUndefined() function - -### toIntegerOrUndefined() function - -Signature - -```typescript -export declare function toIntegerOrUndefined(value: string): number | undefined; -``` -Import - -```typescript -import { toIntegerOrUndefined } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | | - -Returns: - -`number | undefined` - diff --git a/docs/sources/packages_api/data/tolegacyresponsedata.md b/docs/sources/packages_api/data/tolegacyresponsedata.md deleted file mode 100644 index de4a1c9ede4..00000000000 --- a/docs/sources/packages_api/data/tolegacyresponsedata.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toLegacyResponseData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toLegacyResponseData variable - -### toLegacyResponseData variable - -Signature - -```typescript -toLegacyResponseData: (frame: DataFrame) => TimeSeries | TableData -``` -Import - -```typescript -import { toLegacyResponseData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tonumberstring.md b/docs/sources/packages_api/data/tonumberstring.md deleted file mode 100644 index c151d2ccea4..00000000000 --- a/docs/sources/packages_api/data/tonumberstring.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toNumberString" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toNumberString() function - -### toNumberString() function - -Signature - -```typescript -export declare function toNumberString(value: number | undefined | null): string; -``` -Import - -```typescript -import { toNumberString } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | undefined | null | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/data/topascalcase.md b/docs/sources/packages_api/data/topascalcase.md deleted file mode 100644 index 1a43e565701..00000000000 --- a/docs/sources/packages_api/data/topascalcase.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toPascalCase" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toPascalCase variable - -### toPascalCase variable - -Signature - -```typescript -toPascalCase: (string: string) => string -``` -Import - -```typescript -import { toPascalCase } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/toutc.md b/docs/sources/packages_api/data/toutc.md deleted file mode 100644 index e05c8848342..00000000000 --- a/docs/sources/packages_api/data/toutc.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toUtc" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## toUtc variable - -### toUtc variable - -Signature - -```typescript -toUtc: (input?: string | number | DateTime | Date | (string | number)[] | undefined, formatInput?: FormatInput) => DateTime -``` -Import - -```typescript -import { toUtc } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/trace.md b/docs/sources/packages_api/data/trace.md deleted file mode 100644 index 40b4dd48d0f..00000000000 --- a/docs/sources/packages_api/data/trace.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Trace" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Trace type - -### Trace type - -Signature - -```typescript -export declare type Trace = TraceData & { - duration: number; - endTime: number; - spans: TraceSpan[]; - startTime: number; - traceName: string; - services: Array<{ - name: string; - numberOfSpans: number; - }>; -}; -``` -Import - -```typescript -import { Trace } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracedata.md b/docs/sources/packages_api/data/tracedata.md deleted file mode 100644 index 092d14a03d3..00000000000 --- a/docs/sources/packages_api/data/tracedata.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceData type - -### TraceData type - -Signature - -```typescript -export declare type TraceData = { - processes: Record; - traceID: string; - warnings?: string[] | null; -}; -``` -Import - -```typescript -import { TraceData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracekeyvaluepair.md b/docs/sources/packages_api/data/tracekeyvaluepair.md deleted file mode 100644 index a3d66594b6c..00000000000 --- a/docs/sources/packages_api/data/tracekeyvaluepair.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceKeyValuePair" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceKeyValuePair type - -### TraceKeyValuePair type - -All timestamps are in microseconds - -Signature - -```typescript -export declare type TraceKeyValuePair = { - key: string; - type?: string; - value: any; -}; -``` -Import - -```typescript -import { TraceKeyValuePair } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracelink.md b/docs/sources/packages_api/data/tracelink.md deleted file mode 100644 index e97bf982131..00000000000 --- a/docs/sources/packages_api/data/tracelink.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceLink" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceLink type - -### TraceLink type - -Signature - -```typescript -export declare type TraceLink = { - url: string; - text: string; -}; -``` -Import - -```typescript -import { TraceLink } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracelog.md b/docs/sources/packages_api/data/tracelog.md deleted file mode 100644 index 1e955d4674f..00000000000 --- a/docs/sources/packages_api/data/tracelog.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceLog" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceLog type - -### TraceLog type - -Signature - -```typescript -export declare type TraceLog = { - timestamp: number; - fields: TraceKeyValuePair[]; -}; -``` -Import - -```typescript -import { TraceLog } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/traceprocess.md b/docs/sources/packages_api/data/traceprocess.md deleted file mode 100644 index 3155d6d7416..00000000000 --- a/docs/sources/packages_api/data/traceprocess.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceProcess" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceProcess type - -### TraceProcess type - -Signature - -```typescript -export declare type TraceProcess = { - serviceName: string; - tags: TraceKeyValuePair[]; -}; -``` -Import - -```typescript -import { TraceProcess } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracespan.md b/docs/sources/packages_api/data/tracespan.md deleted file mode 100644 index 5f22ce028d6..00000000000 --- a/docs/sources/packages_api/data/tracespan.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceSpan" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceSpan type - -### TraceSpan type - -Signature - -```typescript -export declare type TraceSpan = TraceSpanData & { - depth: number; - hasChildren: boolean; - process: TraceProcess; - relativeStartTime: number; - tags: NonNullable; - references: NonNullable; - warnings: NonNullable; - subsidiarilyReferencedBy: TraceSpanReference[]; -}; -``` -Import - -```typescript -import { TraceSpan } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracespandata.md b/docs/sources/packages_api/data/tracespandata.md deleted file mode 100644 index 63d76300f65..00000000000 --- a/docs/sources/packages_api/data/tracespandata.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceSpanData" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceSpanData type - -### TraceSpanData type - -Signature - -```typescript -export declare type TraceSpanData = { - spanID: string; - traceID: string; - processID: string; - operationName: string; - startTime: number; - duration: number; - logs: TraceLog[]; - tags?: TraceKeyValuePair[]; - references?: TraceSpanReference[]; - warnings?: string[] | null; - flags: number; -}; -``` -Import - -```typescript -import { TraceSpanData } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/tracespanreference.md b/docs/sources/packages_api/data/tracespanreference.md deleted file mode 100644 index 051ed72843c..00000000000 --- a/docs/sources/packages_api/data/tracespanreference.md +++ /dev/null @@ -1,28 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TraceSpanReference" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TraceSpanReference type - -### TraceSpanReference type - -Signature - -```typescript -export declare type TraceSpanReference = { - refType: 'CHILD_OF' | 'FOLLOWS_FROM'; - span?: TraceSpan | null | undefined; - spanID: string; - traceID: string; -}; -``` -Import - -```typescript -import { TraceSpanReference } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/transformdataframe.md b/docs/sources/packages_api/data/transformdataframe.md deleted file mode 100644 index 52f5cc4922e..00000000000 --- a/docs/sources/packages_api/data/transformdataframe.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "transformDataFrame" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## transformDataFrame() function - -### transformDataFrame() function - -Apply configured transformations to the input data - -Signature - -```typescript -export declare function transformDataFrame(options: DataTransformerConfig[], data: DataFrame[]): DataFrame[]; -``` -Import - -```typescript -import { transformDataFrame } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | DataTransformerConfig[] | | -| data | DataFrame[] | | - -Returns: - -`DataFrame[]` - diff --git a/docs/sources/packages_api/data/transformerregistyitem.md b/docs/sources/packages_api/data/transformerregistyitem.md deleted file mode 100644 index 5d0998d1d8c..00000000000 --- a/docs/sources/packages_api/data/transformerregistyitem.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TransformerRegistyItem" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TransformerRegistyItem interface - -Signature - -```typescript -export interface TransformerRegistyItem extends RegistryItem -``` -Import - -```typescript -import { TransformerRegistyItem } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [editor](#editor-property) | React.ComponentType<TransformerUIProps<TOptions>> | React component used as UI for the transformer | -| [transformation](#transformation-property) | DataTransformerInfo<TOptions> | Object describing transformer configuration | - -### editor property - -React component used as UI for the transformer - -Signature - -```typescript -editor: React.ComponentType>; -``` - -### transformation property - -Object describing transformer configuration - -Signature - -```typescript -transformation: DataTransformerInfo; -``` diff --git a/docs/sources/packages_api/data/transformeruiprops.md b/docs/sources/packages_api/data/transformeruiprops.md deleted file mode 100644 index 352e3a72d1e..00000000000 --- a/docs/sources/packages_api/data/transformeruiprops.md +++ /dev/null @@ -1,56 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TransformerUIProps" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## TransformerUIProps interface - -Signature - -```typescript -export interface TransformerUIProps -``` -Import - -```typescript -import { TransformerUIProps } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [input](#input-property) | DataFrame[] | Pre-transform data frames | -| [onChange](#onchange-property) | (options: T) => void | | -| [options](#options-property) | T | Transformer configuration, persisted on panel's model | - -### input property - -Pre-transform data frames - -Signature - -```typescript -input: DataFrame[]; -``` - -### onChange property - -Signature - -```typescript -onChange: (options: T) => void; -``` - -### options property - -Transformer configuration, persisted on panel's model - -Signature - -```typescript -options: T; -``` diff --git a/docs/sources/packages_api/data/unescapestringfromregex.md b/docs/sources/packages_api/data/unescapestringfromregex.md deleted file mode 100644 index 274ebe520b2..00000000000 --- a/docs/sources/packages_api/data/unescapestringfromregex.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "unEscapeStringFromRegex" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## unEscapeStringFromRegex variable - -### unEscapeStringFromRegex variable - -Signature - -```typescript -unEscapeStringFromRegex: (value: string) => string -``` -Import - -```typescript -import { unEscapeStringFromRegex } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/unitfieldconfigsettings.md b/docs/sources/packages_api/data/unitfieldconfigsettings.md deleted file mode 100644 index 3f40433479e..00000000000 --- a/docs/sources/packages_api/data/unitfieldconfigsettings.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "UnitFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## UnitFieldConfigSettings interface - -Signature - -```typescript -export interface UnitFieldConfigSettings -``` -Import - -```typescript -import { UnitFieldConfigSettings } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/unitoverrideprocessor.md b/docs/sources/packages_api/data/unitoverrideprocessor.md deleted file mode 100644 index 26cf59a0e95..00000000000 --- a/docs/sources/packages_api/data/unitoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "unitOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## unitOverrideProcessor variable - -### unitOverrideProcessor variable - -Signature - -```typescript -unitOverrideProcessor: (value: boolean, _context: FieldOverrideContext, _settings?: UnitFieldConfigSettings | undefined) => boolean -``` -Import - -```typescript -import { unitOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/updatedatasourcepluginjsondataoption.md b/docs/sources/packages_api/data/updatedatasourcepluginjsondataoption.md deleted file mode 100644 index 5fc4f461986..00000000000 --- a/docs/sources/packages_api/data/updatedatasourcepluginjsondataoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "updateDatasourcePluginJsonDataOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## updateDatasourcePluginJsonDataOption variable - -### updateDatasourcePluginJsonDataOption variable - -Signature - -```typescript -updateDatasourcePluginJsonDataOption: (props: DataSourcePluginOptionsEditorProps, key: K, val: any) => void -``` -Import - -```typescript -import { updateDatasourcePluginJsonDataOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/updatedatasourcepluginoption.md b/docs/sources/packages_api/data/updatedatasourcepluginoption.md deleted file mode 100644 index d07b1bb5be5..00000000000 --- a/docs/sources/packages_api/data/updatedatasourcepluginoption.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "updateDatasourcePluginOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## updateDatasourcePluginOption() function - -### updateDatasourcePluginOption() function - -Signature - -```typescript -export declare function updateDatasourcePluginOption(props: DataSourcePluginOptionsEditorProps, key: keyof DataSourceSettings, val: any): void; -``` -Import - -```typescript -import { updateDatasourcePluginOption } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | DataSourcePluginOptionsEditorProps | | -| key | keyof DataSourceSettings | | -| val | any | | - -Returns: - -`void` - diff --git a/docs/sources/packages_api/data/updatedatasourcepluginresetoption.md b/docs/sources/packages_api/data/updatedatasourcepluginresetoption.md deleted file mode 100644 index 5f80d8f0409..00000000000 --- a/docs/sources/packages_api/data/updatedatasourcepluginresetoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "updateDatasourcePluginResetOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## updateDatasourcePluginResetOption variable - -### updateDatasourcePluginResetOption variable - -Signature - -```typescript -updateDatasourcePluginResetOption: >(props: DataSourcePluginOptionsEditorProps, key: string) => void -``` -Import - -```typescript -import { updateDatasourcePluginResetOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/updatedatasourcepluginsecurejsondataoption.md b/docs/sources/packages_api/data/updatedatasourcepluginsecurejsondataoption.md deleted file mode 100644 index 8ef568ffd5d..00000000000 --- a/docs/sources/packages_api/data/updatedatasourcepluginsecurejsondataoption.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "updateDatasourcePluginSecureJsonDataOption" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## updateDatasourcePluginSecureJsonDataOption variable - -### updateDatasourcePluginSecureJsonDataOption variable - -Signature - -```typescript -updateDatasourcePluginSecureJsonDataOption: >(props: DataSourcePluginOptionsEditorProps, key: string, val: any) => void -``` -Import - -```typescript -import { updateDatasourcePluginSecureJsonDataOption } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/urlquerymap.md b/docs/sources/packages_api/data/urlquerymap.md deleted file mode 100644 index 1663033d4ad..00000000000 --- a/docs/sources/packages_api/data/urlquerymap.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "UrlQueryMap" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## UrlQueryMap type - -### UrlQueryMap type - -Type to represent the values parsed from the query string. - -Signature - -```typescript -export declare type UrlQueryMap = Record; -``` -Import - -```typescript -import { UrlQueryMap } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/urlqueryvalue.md b/docs/sources/packages_api/data/urlqueryvalue.md deleted file mode 100644 index a0da2fe93f2..00000000000 --- a/docs/sources/packages_api/data/urlqueryvalue.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "UrlQueryValue" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## UrlQueryValue type - -### UrlQueryValue type - -Type to represent the value of a single query variable. - -Signature - -```typescript -export declare type UrlQueryValue = string | number | boolean | string[] | number[] | boolean[] | undefined | null; -``` -Import - -```typescript -import { UrlQueryValue } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/urlutil.md b/docs/sources/packages_api/data/urlutil.md deleted file mode 100644 index e69fe371e12..00000000000 --- a/docs/sources/packages_api/data/urlutil.md +++ /dev/null @@ -1,28 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "urlUtil" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## urlUtil variable - -### urlUtil variable - -Signature - -```typescript -urlUtil: { - renderUrl: typeof renderUrl; - toUrlParams: typeof toUrlParams; - appendQueryToUrl: typeof appendQueryToUrl; - getUrlSearchParams: typeof getUrlSearchParams; -} -``` -Import - -```typescript -import { urlUtil } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/userorgdto.md b/docs/sources/packages_api/data/userorgdto.md deleted file mode 100644 index b7fcefea979..00000000000 --- a/docs/sources/packages_api/data/userorgdto.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "UserOrgDTO" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## UserOrgDTO interface - -Signature - -```typescript -export interface UserOrgDTO -``` -Import - -```typescript -import { UserOrgDTO } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [name](#name-property) | string | | -| [orgId](#orgid-property) | number | | -| [role](#role-property) | OrgRole | | - -### name property - -Signature - -```typescript -name: string; -``` - -### orgId property - -Signature - -```typescript -orgId: number; -``` - -### role property - -Signature - -```typescript -role: OrgRole; -``` diff --git a/docs/sources/packages_api/data/validatefieldconfig.md b/docs/sources/packages_api/data/validatefieldconfig.md deleted file mode 100644 index 1e746fae8c4..00000000000 --- a/docs/sources/packages_api/data/validatefieldconfig.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "validateFieldConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## validateFieldConfig() function - -### validateFieldConfig() function - -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) - -Signature - -```typescript -export declare function validateFieldConfig(config: FieldConfig): void; -``` -Import - -```typescript -import { validateFieldConfig } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | FieldConfig | | - -Returns: - -`void` - diff --git a/docs/sources/packages_api/data/valueconverter.md b/docs/sources/packages_api/data/valueconverter.md deleted file mode 100644 index 2fde86a2ef3..00000000000 --- a/docs/sources/packages_api/data/valueconverter.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueConverter" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueConverter type - -### ValueConverter type - -Signature - -```typescript -export declare type ValueConverter = (val: any) => T; -``` -Import - -```typescript -import { ValueConverter } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/valueformat.md b/docs/sources/packages_api/data/valueformat.md deleted file mode 100644 index 37d2eef7923..00000000000 --- a/docs/sources/packages_api/data/valueformat.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueFormat" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueFormat interface - -Signature - -```typescript -export interface ValueFormat -``` -Import - -```typescript -import { ValueFormat } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fn](#fn-property) | ValueFormatter | | -| [id](#id-property) | string | | -| [name](#name-property) | string | | - -### fn property - -Signature - -```typescript -fn: ValueFormatter; -``` - -### id property - -Signature - -```typescript -id: string; -``` - -### name property - -Signature - -```typescript -name: string; -``` diff --git a/docs/sources/packages_api/data/valueformatcategory.md b/docs/sources/packages_api/data/valueformatcategory.md deleted file mode 100644 index 11b6d9bf98f..00000000000 --- a/docs/sources/packages_api/data/valueformatcategory.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueFormatCategory" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueFormatCategory interface - -Signature - -```typescript -export interface ValueFormatCategory -``` -Import - -```typescript -import { ValueFormatCategory } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [formats](#formats-property) | ValueFormat[] | | -| [name](#name-property) | string | | - -### formats property - -Signature - -```typescript -formats: ValueFormat[]; -``` - -### name property - -Signature - -```typescript -name: string; -``` diff --git a/docs/sources/packages_api/data/valueformatter.md b/docs/sources/packages_api/data/valueformatter.md deleted file mode 100644 index c8bb13fa31b..00000000000 --- a/docs/sources/packages_api/data/valueformatter.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueFormatter" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueFormatter type - -### ValueFormatter type - -Signature - -```typescript -export declare type ValueFormatter = (value: number, decimals?: DecimalCount, scaledDecimals?: DecimalCount, timeZone?: TimeZone) => FormattedValue; -``` -Import - -```typescript -import { ValueFormatter } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/valuelinkconfig.md b/docs/sources/packages_api/data/valuelinkconfig.md deleted file mode 100644 index e55faa2a7ae..00000000000 --- a/docs/sources/packages_api/data/valuelinkconfig.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueLinkConfig" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueLinkConfig interface - -Signature - -```typescript -export interface ValueLinkConfig -``` -Import - -```typescript -import { ValueLinkConfig } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [calculatedValue](#calculatedvalue-property) | DisplayValue | Result of field reduction | -| [valueRowIndex](#valuerowindex-property) | number | Index of the value row within Field. Should be provided only when value is not a result of a reduction | - -### calculatedValue property - -Result of field reduction - -Signature - -```typescript -calculatedValue?: DisplayValue; -``` - -### valueRowIndex property - -Index of the value row within Field. Should be provided only when value is not a result of a reduction - -Signature - -```typescript -valueRowIndex?: number; -``` diff --git a/docs/sources/packages_api/data/valuemap.md b/docs/sources/packages_api/data/valuemap.md deleted file mode 100644 index f846eaf0318..00000000000 --- a/docs/sources/packages_api/data/valuemap.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueMap" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueMap interface - -Signature - -```typescript -export interface ValueMap extends BaseMap -``` -Import - -```typescript -import { ValueMap } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [value](#value-property) | string | | - -### value property - -Signature - -```typescript -value: string; -``` diff --git a/docs/sources/packages_api/data/valuemapping.md b/docs/sources/packages_api/data/valuemapping.md deleted file mode 100644 index 500e66837d7..00000000000 --- a/docs/sources/packages_api/data/valuemapping.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueMapping" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueMapping type - -### ValueMapping type - -Signature - -```typescript -export declare type ValueMapping = ValueMap | RangeMap; -``` -Import - -```typescript -import { ValueMapping } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/valuemappingfieldconfigsettings.md b/docs/sources/packages_api/data/valuemappingfieldconfigsettings.md deleted file mode 100644 index e6720cae724..00000000000 --- a/docs/sources/packages_api/data/valuemappingfieldconfigsettings.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValueMappingFieldConfigSettings" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## ValueMappingFieldConfigSettings interface - -Signature - -```typescript -export interface ValueMappingFieldConfigSettings -``` -Import - -```typescript -import { ValueMappingFieldConfigSettings } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/valuemappingsoverrideprocessor.md b/docs/sources/packages_api/data/valuemappingsoverrideprocessor.md deleted file mode 100644 index 7cdab1bad08..00000000000 --- a/docs/sources/packages_api/data/valuemappingsoverrideprocessor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "valueMappingsOverrideProcessor" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## valueMappingsOverrideProcessor variable - -### valueMappingsOverrideProcessor variable - -Signature - -```typescript -valueMappingsOverrideProcessor: (value: any, _context: FieldOverrideContext, _settings?: ValueMappingFieldConfigSettings | undefined) => ValueMapping[] -``` -Import - -```typescript -import { valueMappingsOverrideProcessor } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/var_calc.md b/docs/sources/packages_api/data/var_calc.md deleted file mode 100644 index 6f4cc7528f6..00000000000 --- a/docs/sources/packages_api/data/var_calc.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VAR_CALC" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VAR\_CALC variable - -### VAR\_CALC variable - -Signature - -```typescript -VAR_CALC = "__calc" -``` -Import - -```typescript -import { VAR_CALC } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/var_cell_prefix.md b/docs/sources/packages_api/data/var_cell_prefix.md deleted file mode 100644 index c0c7e4b4c03..00000000000 --- a/docs/sources/packages_api/data/var_cell_prefix.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VAR_CELL_PREFIX" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VAR\_CELL\_PREFIX variable - -### VAR\_CELL\_PREFIX variable - -Signature - -```typescript -VAR_CELL_PREFIX = "__cell_" -``` -Import - -```typescript -import { VAR_CELL_PREFIX } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/var_field_labels.md b/docs/sources/packages_api/data/var_field_labels.md deleted file mode 100644 index 99a5e80710f..00000000000 --- a/docs/sources/packages_api/data/var_field_labels.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VAR_FIELD_LABELS" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VAR\_FIELD\_LABELS variable - -### VAR\_FIELD\_LABELS variable - -Signature - -```typescript -VAR_FIELD_LABELS = "__field.labels" -``` -Import - -```typescript -import { VAR_FIELD_LABELS } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/var_field_name.md b/docs/sources/packages_api/data/var_field_name.md deleted file mode 100644 index 9349a60b69d..00000000000 --- a/docs/sources/packages_api/data/var_field_name.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VAR_FIELD_NAME" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VAR\_FIELD\_NAME variable - -### VAR\_FIELD\_NAME variable - -Signature - -```typescript -VAR_FIELD_NAME = "__field.name" -``` -Import - -```typescript -import { VAR_FIELD_NAME } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/var_series_name.md b/docs/sources/packages_api/data/var_series_name.md deleted file mode 100644 index c22dab39245..00000000000 --- a/docs/sources/packages_api/data/var_series_name.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VAR_SERIES_NAME" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VAR\_SERIES\_NAME variable - -### VAR\_SERIES\_NAME variable - -Signature - -```typescript -VAR_SERIES_NAME = "__series.name" -``` -Import - -```typescript -import { VAR_SERIES_NAME } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/variablemodel.md b/docs/sources/packages_api/data/variablemodel.md deleted file mode 100644 index 01928466be5..00000000000 --- a/docs/sources/packages_api/data/variablemodel.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VariableModel" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VariableModel interface - -Signature - -```typescript -export interface VariableModel -``` -Import - -```typescript -import { VariableModel } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [label](#label-property) | string | null | | -| [name](#name-property) | string | | -| [type](#type-property) | VariableType | | - -### label property - -Signature - -```typescript -label: string | null; -``` - -### name property - -Signature - -```typescript -name: string; -``` - -### type property - -Signature - -```typescript -type: VariableType; -``` diff --git a/docs/sources/packages_api/data/variableorigin.md b/docs/sources/packages_api/data/variableorigin.md deleted file mode 100644 index 1ae721a5099..00000000000 --- a/docs/sources/packages_api/data/variableorigin.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VariableOrigin" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VariableOrigin enum - -### VariableOrigin enum - -Signature - -```typescript -export declare enum VariableOrigin -``` -Import - -```typescript -import { VariableOrigin } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| BuiltIn | "built-in" | | -| Field | "field" | | -| Fields | "fields" | | -| Series | "series" | | -| Template | "template" | | -| Value | "value" | | - diff --git a/docs/sources/packages_api/data/variablesuggestion.md b/docs/sources/packages_api/data/variablesuggestion.md deleted file mode 100644 index 2269ab1720c..00000000000 --- a/docs/sources/packages_api/data/variablesuggestion.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VariableSuggestion" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VariableSuggestion interface - -Signature - -```typescript -export interface VariableSuggestion -``` -Import - -```typescript -import { VariableSuggestion } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [documentation](#documentation-property) | string | | -| [label](#label-property) | string | | -| [origin](#origin-property) | VariableOrigin | | -| [value](#value-property) | string | | - -### documentation property - -Signature - -```typescript -documentation?: string; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### origin property - -Signature - -```typescript -origin: VariableOrigin; -``` - -### value property - -Signature - -```typescript -value: string; -``` diff --git a/docs/sources/packages_api/data/variablesuggestionsscope.md b/docs/sources/packages_api/data/variablesuggestionsscope.md deleted file mode 100644 index 037b03c8cc3..00000000000 --- a/docs/sources/packages_api/data/variablesuggestionsscope.md +++ /dev/null @@ -1,30 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VariableSuggestionsScope" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VariableSuggestionsScope enum - -### VariableSuggestionsScope enum - -Signature - -```typescript -export declare enum VariableSuggestionsScope -``` -Import - -```typescript -import { VariableSuggestionsScope } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Values | "values" | | - diff --git a/docs/sources/packages_api/data/variabletype.md b/docs/sources/packages_api/data/variabletype.md deleted file mode 100644 index e6cbc3c4030..00000000000 --- a/docs/sources/packages_api/data/variabletype.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VariableType" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VariableType type - -### VariableType type - -Signature - -```typescript -export declare type VariableType = 'query' | 'adhoc' | 'constant' | 'datasource' | 'interval' | 'textbox' | 'custom' | 'system'; -``` -Import - -```typescript -import { VariableType } from '@grafana/data'; -``` diff --git a/docs/sources/packages_api/data/vector.md b/docs/sources/packages_api/data/vector.md deleted file mode 100644 index 0fba4209715..00000000000 --- a/docs/sources/packages_api/data/vector.md +++ /dev/null @@ -1,74 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Vector" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## Vector interface - -Signature - -```typescript -export interface Vector -``` -Import - -```typescript -import { Vector } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [length](#length-property) | number | | - -Methods - -| Method | Description | -| --- | --- | -| [get(index)](#get-method) | Access the value by index (Like an array) | -| [toArray()](#toarray-method) | Get the results as an array. | - -### length property - -Signature - -```typescript -length: number; -``` - -### get method - -Access the value by index (Like an array) - -Signature - -```typescript -get(index: number): T; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`T` - -### toArray method - -Get the results as an array. - -Signature - -```typescript -toArray(): T[]; -``` -Returns: - -`T[]` - diff --git a/docs/sources/packages_api/data/vectorator.md b/docs/sources/packages_api/data/vectorator.md deleted file mode 100644 index 5f27e5a31dd..00000000000 --- a/docs/sources/packages_api/data/vectorator.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "vectorator" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## vectorator() function - -### vectorator() function - -Use functional programming with your vector - -Signature - -```typescript -export declare function vectorator(vector: Vector): { - [Symbol.iterator](): Generator; - forEach(iterator: (row: T) => void): void; - map(transform: (item: T, index: number) => V): V[]; - filter(predicate: (item: T) => V_1): T[]; -}; -``` -Import - -```typescript -import { vectorator } from '@grafana/data'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| vector | Vector<T> | | - -Returns: - -`{ - [Symbol.iterator](): Generator; - forEach(iterator: (row: T) => void): void; - map(transform: (item: T, index: number) => V): V[]; - filter(predicate: (item: T) => V_1): T[]; -}` - diff --git a/docs/sources/packages_api/data/vizorientation.md b/docs/sources/packages_api/data/vizorientation.md deleted file mode 100644 index 47558bdda07..00000000000 --- a/docs/sources/packages_api/data/vizorientation.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VizOrientation" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## VizOrientation enum - -### VizOrientation enum - -Signature - -```typescript -export declare enum VizOrientation -``` -Import - -```typescript -import { VizOrientation } from '@grafana/data'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Auto | "auto" | | -| Horizontal | "horizontal" | | -| Vertical | "vertical" | | - diff --git a/docs/sources/packages_api/data/yaxis.md b/docs/sources/packages_api/data/yaxis.md deleted file mode 100644 index 050c59925d4..00000000000 --- a/docs/sources/packages_api/data/yaxis.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "YAxis" -keywords = ["grafana","documentation","sdk","@grafana/data"] -type = "docs" -+++ - -## YAxis interface - -Signature - -```typescript -export interface YAxis -``` -Import - -```typescript -import { YAxis } from '@grafana/data'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [index](#index-property) | number | | -| [min](#min-property) | number | | -| [tickDecimals](#tickdecimals-property) | number | | - -### index property - -Signature - -```typescript -index: number; -``` - -### min property - -Signature - -```typescript -min?: number; -``` - -### tickDecimals property - -Signature - -```typescript -tickDecimals?: number; -``` diff --git a/docs/sources/packages_api/e2e-selectors/_index.md b/docs/sources/packages_api/e2e-selectors/_index.md deleted file mode 100644 index d5afae8994d..00000000000 --- a/docs/sources/packages_api/e2e-selectors/_index.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "@grafana/e2e-selectors" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## @grafana/e2e-selectors package - -A library containing the different design components of the Grafana ecosystem. - -## Interfaces - -| Interface | Description | -| --- | --- | -| [Selectors](./selectors/) | | -| [UrlSelector](./urlselector/) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [selectors](./selectors/) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [CssSelector](./cssselector/) | | -| [E2ESelectors](./e2eselectors/) | | -| [FunctionSelector](./functionselector/) | | -| [StringSelector](./stringselector/) | | - diff --git a/docs/sources/packages_api/e2e-selectors/cssselector.md b/docs/sources/packages_api/e2e-selectors/cssselector.md deleted file mode 100644 index 4afc77c7429..00000000000 --- a/docs/sources/packages_api/e2e-selectors/cssselector.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CssSelector" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## CssSelector type - -### CssSelector type - -Signature - -```typescript -export declare type CssSelector = () => string; -``` -Import - -```typescript -import { CssSelector } from '@grafana/e2e-selectors'; -``` diff --git a/docs/sources/packages_api/e2e-selectors/e2eselectors.md b/docs/sources/packages_api/e2e-selectors/e2eselectors.md deleted file mode 100644 index d8fd8171433..00000000000 --- a/docs/sources/packages_api/e2e-selectors/e2eselectors.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "E2ESelectors" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## E2ESelectors type - -### E2ESelectors type - -Signature - -```typescript -export declare type E2ESelectors = { - [P in keyof S]: S[P]; -}; -``` -Import - -```typescript -import { E2ESelectors } from '@grafana/e2e-selectors'; -``` diff --git a/docs/sources/packages_api/e2e-selectors/functionselector.md b/docs/sources/packages_api/e2e-selectors/functionselector.md deleted file mode 100644 index 097061d5932..00000000000 --- a/docs/sources/packages_api/e2e-selectors/functionselector.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FunctionSelector" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## FunctionSelector type - -### FunctionSelector type - -Signature - -```typescript -export declare type FunctionSelector = (id: string) => string; -``` -Import - -```typescript -import { FunctionSelector } from '@grafana/e2e-selectors'; -``` diff --git a/docs/sources/packages_api/e2e-selectors/selectors.md b/docs/sources/packages_api/e2e-selectors/selectors.md deleted file mode 100644 index 98436f6ae04..00000000000 --- a/docs/sources/packages_api/e2e-selectors/selectors.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "selectors" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## selectors variable - -### selectors variable - -Signature - -```typescript -selectors: { - pages: E2ESelectors; - components: E2ESelectors; -} -``` -Import - -```typescript -import { selectors } from '@grafana/e2e-selectors'; -``` diff --git a/docs/sources/packages_api/e2e-selectors/stringselector.md b/docs/sources/packages_api/e2e-selectors/stringselector.md deleted file mode 100644 index 98b30489eb1..00000000000 --- a/docs/sources/packages_api/e2e-selectors/stringselector.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StringSelector" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## StringSelector type - -### StringSelector type - -Signature - -```typescript -export declare type StringSelector = string; -``` -Import - -```typescript -import { StringSelector } from '@grafana/e2e-selectors'; -``` diff --git a/docs/sources/packages_api/e2e-selectors/urlselector.md b/docs/sources/packages_api/e2e-selectors/urlselector.md deleted file mode 100644 index 05d9a54dc69..00000000000 --- a/docs/sources/packages_api/e2e-selectors/urlselector.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "UrlSelector" -keywords = ["grafana","documentation","sdk","@grafana/e2e-selectors"] -type = "docs" -+++ - -## UrlSelector interface - -Signature - -```typescript -export interface UrlSelector extends Selectors -``` -Import - -```typescript -import { UrlSelector } from '@grafana/e2e-selectors'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [url](#url-property) | string | FunctionSelector | | - -### url property - -Signature - -```typescript -url: string | FunctionSelector; -``` diff --git a/docs/sources/packages_api/e2e/_index.md b/docs/sources/packages_api/e2e/_index.md deleted file mode 100644 index 31a3b9e4c5a..00000000000 --- a/docs/sources/packages_api/e2e/_index.md +++ /dev/null @@ -1,19 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "@grafana/e2e" -keywords = ["grafana","documentation","sdk","@grafana/e2e"] -type = "docs" -+++ - -## @grafana/e2e package - -A library for writing end-to-end tests for Grafana and its ecosystem. - -## Variables - -| Variable | Description | -| --- | --- | -| [e2e](./e2e/) | | - diff --git a/docs/sources/packages_api/e2e/e2e.md b/docs/sources/packages_api/e2e/e2e.md deleted file mode 100644 index 5597b43c96b..00000000000 --- a/docs/sources/packages_api/e2e/e2e.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "e2e" -keywords = ["grafana","documentation","sdk","@grafana/e2e"] -type = "docs" -+++ - -## e2e variable - -### e2e variable - -Signature - -```typescript -e2e: (() => Cypress.cy) & typeof e2eObject -``` -Import - -```typescript -import { e2e } from '@grafana/e2e'; -``` diff --git a/docs/sources/packages_api/runtime/_index.md b/docs/sources/packages_api/runtime/_index.md deleted file mode 100644 index 3b6bbc3bff9..00000000000 --- a/docs/sources/packages_api/runtime/_index.md +++ /dev/null @@ -1,82 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "@grafana/runtime" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## @grafana/runtime package - -A library containing services, configurations etc. used to interact with the Grafana engine. - -## Classes - -| Class | Description | -| --- | --- | -| [DataSourceWithBackend](./datasourcewithbackend/) | Extend this class to implement a data source plugin that is depending on the Grafana backend API. | -| [GrafanaBootConfig](./grafanabootconfig/) | | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [EchoEventType](./echoeventtype/) | Supported echo event types that can be sent via the [EchoSrv](./runtime/echosrv.md). | -| [HealthStatus](./healthstatus/) | Describes the current health status of a data source plugin. | -| [MetaAnalyticsEventName](./metaanalyticseventname/) | The meta analytics events that can be added to the echo service. | - -## Functions - -| Function | Description | -| --- | --- | -| [getAngularLoader()](./getangularloader/) | Used to retrieve the [AngularLoader](./runtime/angularloader.md) that enables the use of Angular components within a React component.Please see the [AngularComponent](./runtime/angularcomponent.md) for a proper example. | -| [getDataSourceSrv()](./getdatasourcesrv/) | Used to retrieve the [DataSourceSrv](./runtime/datasourcesrv.md) that is the entry point for communicating with a datasource that is added as a plugin (both external and internal). | -| [getEchoSrv()](./getechosrv/) | Used to retrieve the [EchoSrv](./runtime/echosrv.md) that can be used to report events to registered echo backends. | -| [getLocationSrv()](./getlocationsrv/) | Used to retrieve the [LocationSrv](./runtime/locationsrv.md) that can be used to automatically navigate the user to a new place in Grafana. | -| [loadPluginCss(options)](./loadplugincss/) | Use this to load css for a Grafana plugin by specifying a [PluginCssOptions](./runtime/plugincssoptions.md) containing styling for the dark and the light theme. | -| [toDataQueryError(err)](./todataqueryerror/) | Convert an object into a DataQueryError -- if this is an HTTP response, it will put the correct values in the error field | -| [toDataQueryResponse(res)](./todataqueryresponse/) | Parse the results from \`/api/ds/query | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AngularComponent](./angularcomponent/) | Used to enable rendering of Angular components within a React component without losing proper typings. | -| [AngularLoader](./angularloader/) | Used to load an Angular component from the context of a React component. Please see the [AngularComponent](./runtime/angularcomponent.md) for a proper example. | -| [BackendSrv](./backendsrv/) | Used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. The BackendSrv is using the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) under the hood to handle all the communication.The request function can be used to perform a remote call by specifying a [BackendSrvRequest](./runtime/backendsrvrequest.md). To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will use default values executing the request. | -| [DashboardInfo](./dashboardinfo/) | Describes the basic dashboard information that can be passed as the meta analytics payload. | -| [DashboardViewEventPayload](./dashboardvieweventpayload/) | Describes the payload of a dashboard view event. | -| [DataRequestEventPayload](./datarequesteventpayload/) | Describes the payload of a data request event. | -| [DataRequestInfo](./datarequestinfo/) | Describes the data request information passed as the meta analytics payload. | -| [DataSourceSrv](./datasourcesrv/) | This is the entry point for communicating with a datasource that is added as a plugin (both external and internal). Via this service you will get access to the [DataSourceApi](./data/datasourceapi.md) that have a rich API for communicating with the datasource. | -| [EchoBackend](./echobackend/) | Describes echo backends that can be registered to receive of events. | -| [EchoEvent](./echoevent/) | Describes an echo event. | -| [EchoMeta](./echometa/) | Describes the meta information that are sent together with each event. | -| [EchoSrv](./echosrv/) | Used to send events to all the registered backends. This should be accessed via the [getEchoSrv()](./runtime/getechosrv.md) function. Will, by default, flush events to the backends every 10s or when the flush function is triggered. | -| [HealthCheckResult](./healthcheckresult/) | Describes the payload returned when checking the health of a data source plugin. | -| [LocationSrv](./locationsrv/) | If you need to automatically navigate the user to a new place in the application this should be done via the LocationSrv and it will make sure to update the application state accordingly. | -| [LocationUpdate](./locationupdate/) | | -| [MetaAnalyticsEvent](./metaanalyticsevent/) | Describes meta analytics event with predefined [EchoEventType.MetaAnalytics](./runtime/echoeventtype/metaanalytics.md) type. | -| [PluginCssOptions](./plugincssoptions/) | Option to specify a plugin css that should be applied for the dark and the light theme. | -| [SizeMeta](./sizemeta/) | Describes a size with width/height | -| [TemplateSrv](./templatesrv/) | Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating | - -## Variables - -| Variable | Description | -| --- | --- | -| [config](./config/) | Use this to access the [GrafanaBootConfig](./runtime/grafanabootconfig.md) for the current running Grafana instance. | -| [getBackendSrv](./getbackendsrv/) | Used to retrieve the [BackendSrv](./runtime/backendsrv.md) that can be used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. | -| [getLegacyAngularInjector](./getlegacyangularinjector/) | (BETA) WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future. | -| [getTemplateSrv](./gettemplatesrv/) | Used to retrieve the [TemplateSrv](./runtime/templatesrv.md) that can be used to fetch available template variables. | -| [registerEchoBackend](./registerechobackend/) | Used to register echo backends that will receive Grafana echo events during application runtime. | -| [reportMetaAnalytics](./reportmetaanalytics/) | Helper function to report meta analytics to the [EchoSrv](./runtime/echosrv.md). | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [BackendSrvRequest](./backendsrvrequest/) | Used to initiate a remote call via the [BackendSrv](./runtime/backendsrv.md) | -| [MetaAnalyticsEventPayload](./metaanalyticseventpayload/) | Describes the meta analytics payload passed with the [MetaAnalyticsEvent](./runtime/metaanalyticsevent.md) | - diff --git a/docs/sources/packages_api/runtime/angularcomponent.md b/docs/sources/packages_api/runtime/angularcomponent.md deleted file mode 100644 index f9128f8b291..00000000000 --- a/docs/sources/packages_api/runtime/angularcomponent.md +++ /dev/null @@ -1,101 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AngularComponent" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## AngularComponent interface - -Used to enable rendering of Angular components within a React component without losing proper typings. - -Signature - -```typescript -export interface AngularComponent -``` -Import - -```typescript -import { AngularComponent } from '@grafana/runtime'; -``` - -## Example - - -```typescript -class Component extends PureComponent { - element: HTMLElement; - angularComponent: AngularComponent; - - componentDidMount() { - const template = '' // angular template here; - const scopeProps = { ctrl: angularController }; // angular scope properties here - const loader = getAngularLoader(); - this.angularComponent = loader.load(this.element, scopeProps, template); - } - - componentWillUnmount() { - if (this.angularComponent) { - this.angularComponent.destroy(); - } - } - - render() { - return ( -
(this.element = element)} /> - ); - } -} - -``` - -Methods - -| Method | Description | -| --- | --- | -| [destroy()](#destroy-method) | Should be called when the React component will unmount. | -| [digest()](#digest-method) | Can be used to trigger a re-render of the Angular component. | -| [getScope()](#getscope-method) | Used to access the Angular scope from the React component. | - -### destroy method - -Should be called when the React component will unmount. - -Signature - -```typescript -destroy(): void; -``` -Returns: - -`void` - -### digest method - -Can be used to trigger a re-render of the Angular component. - -Signature - -```typescript -digest(): void; -``` -Returns: - -`void` - -### getScope method - -Used to access the Angular scope from the React component. - -Signature - -```typescript -getScope(): any; -``` -Returns: - -`any` - diff --git a/docs/sources/packages_api/runtime/angularloader.md b/docs/sources/packages_api/runtime/angularloader.md deleted file mode 100644 index b101c459819..00000000000 --- a/docs/sources/packages_api/runtime/angularloader.md +++ /dev/null @@ -1,48 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AngularLoader" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## AngularLoader interface - -Used to load an Angular component from the context of a React component. Please see the [AngularComponent](./runtime/angularcomponent.md) for a proper example. - -Signature - -```typescript -export interface AngularLoader -``` -Import - -```typescript -import { AngularLoader } from '@grafana/runtime'; -``` -Methods - -| Method | Description | -| --- | --- | -| [load(elem, scopeProps, template)](#load-method) | | - -### load method - -Signature - -```typescript -load(elem: any, scopeProps: any, template: string): AngularComponent; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| elem | any | the element that the Angular component will be loaded into. | -| scopeProps | any | values that will be accessed via the Angular scope. | -| template | string | template used by the Angular component. | - -Returns: - -`AngularComponent` - diff --git a/docs/sources/packages_api/runtime/backendsrv.md b/docs/sources/packages_api/runtime/backendsrv.md deleted file mode 100644 index 3da6cdb4d0b..00000000000 --- a/docs/sources/packages_api/runtime/backendsrv.md +++ /dev/null @@ -1,177 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BackendSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## BackendSrv interface - -Used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. The BackendSrv is using the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) under the hood to handle all the communication. - -The request function can be used to perform a remote call by specifying a [BackendSrvRequest](./runtime/backendsrvrequest.md). To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will use default values executing the request. - -Signature - -```typescript -export interface BackendSrv -``` - -Import - -```typescript -import { BackendSrv } from '@grafana/runtime'; -``` - -## Remarks - -By default Grafana will display an error message alert if the remote call fails. If you want to prevent this from happending you need to catch the error thrown by the BackendSrv and set the `showErrorAlert = true` on the request options object. - -> In versions prior to v7.2 you disable the notification alert by setting isHandled on the caught error - -Methods - -| Method | Description | -| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [datasourceRequest(options)](#datasourcerequest-method) | Special function used to communicate with datasources that will emit core events that the Grafana QueryInspector and QueryEditor is listening for to be able to display datasource query information. Can be skipped by adding option.silent when initializing the request. | -| [delete(url)](#delete-method) | | -| [get(url, params, requestId)](#get-method) | | -| [patch(url, data)](#patch-method) | | -| [post(url, data)](#post-method) | | -| [put(url, data)](#put-method) | | -| [request(options)](#request-method) | | - -### datasourceRequest method - -Special function used to communicate with datasources that will emit core events that the Grafana QueryInspector and QueryEditor is listening for to be able to display datasource query information. Can be skipped by adding `option.silent` when initializing the request. - -Signature - -```typescript -datasourceRequest(options: BackendSrvRequest): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------------------ | ----------- | -| options | BackendSrvRequest | | - -Returns: - -`Promise` - -### delete method - -Signature - -```typescript -delete(url: string): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| url | string | | - -Returns: - -`Promise` - -### get method - -Signature - -```typescript -get(url: string, params?: any, requestId?: string): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| url | string | | -| params | any | | -| requestId | string | | - -Returns: - -`Promise` - -### patch method - -Signature - -```typescript -patch(url: string, data?: any): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| url | string | | -| data | any | | - -Returns: - -`Promise` - -### post method - -Signature - -```typescript -post(url: string, data?: any): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| url | string | | -| data | any | | - -Returns: - -`Promise` - -### put method - -Signature - -```typescript -put(url: string, data?: any): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| url | string | | -| data | any | | - -Returns: - -`Promise` - -### request method - -Signature - -```typescript -request(options: BackendSrvRequest): Promise; -``` - -Parameters - -| Parameter | Type | Description | -| --------- | ------------------------------ | ----------- | -| options | BackendSrvRequest | | - -Returns: - -`Promise` diff --git a/docs/sources/packages_api/runtime/backendsrvrequest.md b/docs/sources/packages_api/runtime/backendsrvrequest.md deleted file mode 100644 index 485dbbee8fc..00000000000 --- a/docs/sources/packages_api/runtime/backendsrvrequest.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BackendSrvRequest" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## BackendSrvRequest type - -### BackendSrvRequest type - -Used to initiate a remote call via the [BackendSrv](./runtime/backendsrv.md) - -Signature - -```typescript -export declare type BackendSrvRequest = { - url: string; - retry?: number; - headers?: any; - method?: string; - showSuccessAlert?: boolean; - requestId?: string; - [key: string]: any; -}; -``` -Import - -```typescript -import { BackendSrvRequest } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/config.md b/docs/sources/packages_api/runtime/config.md deleted file mode 100644 index aeb276e4b41..00000000000 --- a/docs/sources/packages_api/runtime/config.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "config" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## config variable - -### config variable - -Use this to access the [GrafanaBootConfig](./runtime/grafanabootconfig.md) for the current running Grafana instance. - -Signature - -```typescript -config: GrafanaBootConfig -``` -Import - -```typescript -import { config } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/dashboardinfo.md b/docs/sources/packages_api/runtime/dashboardinfo.md deleted file mode 100644 index 5beb43cd63c..00000000000 --- a/docs/sources/packages_api/runtime/dashboardinfo.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DashboardInfo" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## DashboardInfo interface - -Describes the basic dashboard information that can be passed as the meta analytics payload. - -Signature - -```typescript -export interface DashboardInfo -``` -Import - -```typescript -import { DashboardInfo } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dashboardId](#dashboardid-property) | number | | -| [dashboardName](#dashboardname-property) | string | | -| [dashboardUid](#dashboarduid-property) | string | | -| [folderName](#foldername-property) | string | | - -### dashboardId property - -Signature - -```typescript -dashboardId: number; -``` - -### dashboardName property - -Signature - -```typescript -dashboardName: string; -``` - -### dashboardUid property - -Signature - -```typescript -dashboardUid: string; -``` - -### folderName property - -Signature - -```typescript -folderName?: string; -``` diff --git a/docs/sources/packages_api/runtime/dashboardvieweventpayload.md b/docs/sources/packages_api/runtime/dashboardvieweventpayload.md deleted file mode 100644 index 37d184da9fb..00000000000 --- a/docs/sources/packages_api/runtime/dashboardvieweventpayload.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DashboardViewEventPayload" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## DashboardViewEventPayload interface - -Describes the payload of a dashboard view event. - -Signature - -```typescript -export interface DashboardViewEventPayload extends DashboardInfo -``` -Import - -```typescript -import { DashboardViewEventPayload } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [eventName](#eventname-property) | MetaAnalyticsEventName.DashboardView | | - -### eventName property - -Signature - -```typescript -eventName: MetaAnalyticsEventName.DashboardView; -``` diff --git a/docs/sources/packages_api/runtime/datarequesteventpayload.md b/docs/sources/packages_api/runtime/datarequesteventpayload.md deleted file mode 100644 index a5a0c4a927c..00000000000 --- a/docs/sources/packages_api/runtime/datarequesteventpayload.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataRequestEventPayload" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## DataRequestEventPayload interface - -Describes the payload of a data request event. - -Signature - -```typescript -export interface DataRequestEventPayload extends DataRequestInfo -``` -Import - -```typescript -import { DataRequestEventPayload } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [eventName](#eventname-property) | MetaAnalyticsEventName.DataRequest | | - -### eventName property - -Signature - -```typescript -eventName: MetaAnalyticsEventName.DataRequest; -``` diff --git a/docs/sources/packages_api/runtime/datarequestinfo.md b/docs/sources/packages_api/runtime/datarequestinfo.md deleted file mode 100644 index 7f883af470c..00000000000 --- a/docs/sources/packages_api/runtime/datarequestinfo.md +++ /dev/null @@ -1,90 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataRequestInfo" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## DataRequestInfo interface - -Describes the data request information passed as the meta analytics payload. - -Signature - -```typescript -export interface DataRequestInfo extends Partial -``` -Import - -```typescript -import { DataRequestInfo } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dataSize](#datasize-property) | number | | -| [datasourceId](#datasourceid-property) | number | | -| [datasourceName](#datasourcename-property) | string | | -| [duration](#duration-property) | number | | -| [error](#error-property) | string | | -| [panelId](#panelid-property) | number | | -| [panelName](#panelname-property) | string | | - -### dataSize property - -Signature - -```typescript -dataSize?: number; -``` - -### datasourceId property - -Signature - -```typescript -datasourceId?: number; -``` - -### datasourceName property - -Signature - -```typescript -datasourceName: string; -``` - -### duration property - -Signature - -```typescript -duration: number; -``` - -### error property - -Signature - -```typescript -error?: string; -``` - -### panelId property - -Signature - -```typescript -panelId?: number; -``` - -### panelName property - -Signature - -```typescript -panelName?: string; -``` diff --git a/docs/sources/packages_api/runtime/datasourcesrv.md b/docs/sources/packages_api/runtime/datasourcesrv.md deleted file mode 100644 index 2eccafdc135..00000000000 --- a/docs/sources/packages_api/runtime/datasourcesrv.md +++ /dev/null @@ -1,67 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## DataSourceSrv interface - -This is the entry point for communicating with a datasource that is added as a plugin (both external and internal). Via this service you will get access to the [DataSourceApi](./data/datasourceapi.md) that have a rich API for communicating with the datasource. - -Signature - -```typescript -export interface DataSourceSrv -``` -Import - -```typescript -import { DataSourceSrv } from '@grafana/runtime'; -``` -Methods - -| Method | Description | -| --- | --- | -| [get(name, scopedVars)](#get-method) | | -| [getDataSourceSettingsByUid(uid)](#getdatasourcesettingsbyuid-method) | Returns metadata based on UID. | - -### get method - -Signature - -```typescript -get(name?: string | null, scopedVars?: ScopedVars): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | null | name of the datasource plugin you want to use. | -| scopedVars | ScopedVars | variables used to interpolate a templated passed as name. | - -Returns: - -`Promise` - -### getDataSourceSettingsByUid method - -Returns metadata based on UID. - -Signature - -```typescript -getDataSourceSettingsByUid(uid: string): DataSourceInstanceSettings | undefined; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| uid | string | | - -Returns: - -`DataSourceInstanceSettings | undefined` - diff --git a/docs/sources/packages_api/runtime/datasourcewithbackend.md b/docs/sources/packages_api/runtime/datasourcewithbackend.md deleted file mode 100644 index 0a6947ce8f5..00000000000 --- a/docs/sources/packages_api/runtime/datasourcewithbackend.md +++ /dev/null @@ -1,204 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceWithBackend" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## DataSourceWithBackend class - -Extend this class to implement a data source plugin that is depending on the Grafana backend API. - -Signature - -```typescript -export declare class DataSourceWithBackend extends DataSourceApi -``` -Import - -```typescript -import { DataSourceWithBackend } from '@grafana/runtime'; -``` -Constructors - -| Constructor | Modifiers | Description | -| -------------------------------------------------------------- | --------- | ------------------------------------------------------------------------- | -| [constructor(instanceSettings)](#constructor-instancesettings) | | Constructs a new instance of the DataSourceWithBackend class | - -Methods - -| Method | Modifiers | Description | -| --------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [applyTemplateVariables(query, scopedVars)](#applytemplatevariables-method) | | Override to apply template variables. The result is usually also TQuery, but sometimes this can be used to modify the query structure before sending to the backend.NOTE: if you do modify the structure or use template variables, alerting queries may not work as expected | -| [callHealthCheck()](#callhealthcheck-method) | | Run the datasource healthcheck | -| [filterQuery(query)](#filterquery-method) | | Override to skip executing a query | -| [getResource(path, params)](#getresource-method) | | Make a GET request to the datasource resource path | -| [postResource(path, body)](#postresource-method) | | Send a POST request to the datasource resource path | -| [processResponse(res)](#processresponse-method) | | Optionally augment the response before returning the results to the | -| [query(request)](#query-method) | | Ideally final -- any other implementation may not work as expected | -| [testDatasource()](#testdatasource-method) | | Checks the plugin health | - -### constructor(instanceSettings) - -Constructs a new instance of the `DataSourceWithBackend` class - -Signature - -```typescript -constructor(instanceSettings: DataSourceInstanceSettings); -``` -Parameters - -| Parameter | Type | Description | -| ---------------- | ------------------------------------------------------- | ----------- | -| instanceSettings | DataSourceInstanceSettings<TOptions> | | - -### applyTemplateVariables method - -Override to apply template variables. The result is usually also `TQuery`, but sometimes this can be used to modify the query structure before sending to the backend. - -> **Note:** if you do modify the structure or use template variables, alerting queries may not work as expected - -Signature - -```typescript -/** @virtual */ -applyTemplateVariables(query: TQuery, scopedVars: ScopedVars): Record; -``` -Parameters - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------- | -| query | TQuery | | -| scopedVars | ScopedVars | | - -Returns: - -`Record` - -### callHealthCheck method - -Run the datasource healthcheck - -Signature - -```typescript -callHealthCheck(): Promise; -``` -Returns: - -`Promise` - -### filterQuery method - -Override to skip executing a query - -Signature - -```typescript -/** @virtual */ -filterQuery?(query: TQuery): boolean; -``` -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| query | TQuery | | - -Returns: - -`boolean` - -### getResource method - -Make a GET request to the datasource resource path - -Signature - -```typescript -getResource(path: string, params?: any): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| path | string | | -| params | any | | - -Returns: - -`Promise` - -### postResource method - -Send a POST request to the datasource resource path - -Signature - -```typescript -postResource(path: string, body?: any): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| path | string | | -| body | any | | - -Returns: - -`Promise` - -### processResponse method - -Optionally augment the response before returning the results to the - -Signature - -```typescript -processResponse?(res: DataQueryResponse): Promise; -``` -Parameters - -| Parameter | Type | Description | -| --------- | ------------------------------ | ----------- | -| res | DataQueryResponse | | - -Returns: - -`Promise` - -### query method - -Ideally final -- any other implementation may not work as expected - -Signature - -```typescript -query(request: DataQueryRequest): Observable; -``` -Parameters - -| Parameter | Type | Description | -| --------- | ------------------------------------------- | ----------- | -| request | DataQueryRequest<TQuery> | | - -Returns: - -`Observable` - -### testDatasource method - -Checks the plugin health - -Signature - -```typescript -testDatasource(): Promise; -``` -Returns: - -`Promise` - diff --git a/docs/sources/packages_api/runtime/echobackend.md b/docs/sources/packages_api/runtime/echobackend.md deleted file mode 100644 index 80c88532aa2..00000000000 --- a/docs/sources/packages_api/runtime/echobackend.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EchoBackend" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## EchoBackend interface - -Describes echo backends that can be registered to receive of events. - -Signature - -```typescript -export interface EchoBackend -``` -Import - -```typescript -import { EchoBackend } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [addEvent](#addevent-property) | (event: T) => void | | -| [flush](#flush-property) | () => void | | -| [options](#options-property) | O | | -| [supportedEvents](#supportedevents-property) | EchoEventType[] | | - -### addEvent property - -Signature - -```typescript -addEvent: (event: T) => void; -``` - -### flush property - -Signature - -```typescript -flush: () => void; -``` - -### options property - -Signature - -```typescript -options: O; -``` - -### supportedEvents property - -Signature - -```typescript -supportedEvents: EchoEventType[]; -``` diff --git a/docs/sources/packages_api/runtime/echoevent.md b/docs/sources/packages_api/runtime/echoevent.md deleted file mode 100644 index b374c2e5217..00000000000 --- a/docs/sources/packages_api/runtime/echoevent.md +++ /dev/null @@ -1,56 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EchoEvent" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## EchoEvent interface - -Describes an echo event. - -Signature - -```typescript -export interface EchoEvent -``` -Import - -```typescript -import { EchoEvent } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [meta](#meta-property) | EchoMeta | | -| [payload](#payload-property) | P | Event payload containing event specific data. | -| [type](#type-property) | EchoEventType | | - -### meta property - -Signature - -```typescript -meta: EchoMeta; -``` - -### payload property - -Event payload containing event specific data. - -Signature - -```typescript -payload: P; -``` - -### type property - -Signature - -```typescript -type: EchoEventType; -``` diff --git a/docs/sources/packages_api/runtime/echoeventtype.md b/docs/sources/packages_api/runtime/echoeventtype.md deleted file mode 100644 index 93aebf629df..00000000000 --- a/docs/sources/packages_api/runtime/echoeventtype.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EchoEventType" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## EchoEventType enum - -### EchoEventType enum - -Supported echo event types that can be sent via the [EchoSrv](./runtime/echosrv.md). - -Signature - -```typescript -export declare enum EchoEventType -``` -Import - -```typescript -import { EchoEventType } from '@grafana/runtime'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| MetaAnalytics | "meta-analytics" | | -| Performance | "performance" | | - diff --git a/docs/sources/packages_api/runtime/echometa.md b/docs/sources/packages_api/runtime/echometa.md deleted file mode 100644 index c29cf215bd9..00000000000 --- a/docs/sources/packages_api/runtime/echometa.md +++ /dev/null @@ -1,129 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EchoMeta" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## EchoMeta interface - -Describes the meta information that are sent together with each event. - -Signature - -```typescript -export interface EchoMeta -``` -Import - -```typescript -import { EchoMeta } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [screenSize](#screensize-property) | SizeMeta | | -| [sessionId](#sessionid-property) | string | A unique browser session | -| [timeSinceNavigationStart](#timesincenavigationstart-property) | number | A highres timestamp since navigation start | -| [ts](#ts-property) | number | A millisecond epoch | -| [url](#url-property) | string | | -| [userAgent](#useragent-property) | string | | -| [userId](#userid-property) | number | The current users unique identifier. | -| [userLogin](#userlogin-property) | string | The current users username used to login into Grafana e.g. email. | -| [userSignedIn](#usersignedin-property) | boolean | True when user is logged in into Grafana. | -| [windowSize](#windowsize-property) | SizeMeta | | - -### screenSize property - -Signature - -```typescript -screenSize: SizeMeta; -``` - -### sessionId property - -A unique browser session - -Signature - -```typescript -sessionId: string; -``` - -### timeSinceNavigationStart property - -A highres timestamp since navigation start - -Signature - -```typescript -timeSinceNavigationStart: number; -``` - -### ts property - -A millisecond epoch - -Signature - -```typescript -ts: number; -``` - -### url property - -Signature - -```typescript -url?: string; -``` - -### userAgent property - -Signature - -```typescript -userAgent: string; -``` - -### userId property - -The current users unique identifier. - -Signature - -```typescript -userId: number; -``` - -### userLogin property - -The current users username used to login into Grafana e.g. email. - -Signature - -```typescript -userLogin: string; -``` - -### userSignedIn property - -True when user is logged in into Grafana. - -Signature - -```typescript -userSignedIn: boolean; -``` - -### windowSize property - -Signature - -```typescript -windowSize: SizeMeta; -``` diff --git a/docs/sources/packages_api/runtime/echosrv.md b/docs/sources/packages_api/runtime/echosrv.md deleted file mode 100644 index 91c430e634e..00000000000 --- a/docs/sources/packages_api/runtime/echosrv.md +++ /dev/null @@ -1,83 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EchoSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## EchoSrv interface - -Used to send events to all the registered backends. This should be accessed via the [getEchoSrv()](./runtime/getechosrv.md) function. Will, by default, flush events to the backends every 10s or when the flush function is triggered. - -Signature - -```typescript -export interface EchoSrv -``` -Import - -```typescript -import { EchoSrv } from '@grafana/runtime'; -``` -Methods - -| Method | Description | -| --- | --- | -| [addBackend(backend)](#addbackend-method) | Add a new echo backend to the list of backends that will receive events. | -| [addEvent(event, meta)](#addevent-method) | Call this to add event that will be sent to the echo backends upon next flush. | -| [flush()](#flush-method) | Call this to flush current events to the echo backends. | - -### addBackend method - -Add a new echo backend to the list of backends that will receive events. - -Signature - -```typescript -addBackend(backend: EchoBackend): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| backend | EchoBackend | | - -Returns: - -`void` - -### addEvent method - -Call this to add event that will be sent to the echo backends upon next flush. - -Signature - -```typescript -addEvent(event: Omit, meta?: {}): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | Omit<T, 'meta'> | Object containing event information. | -| meta | {} | Object that will extend/override the default meta object. | - -Returns: - -`void` - -### flush method - -Call this to flush current events to the echo backends. - -Signature - -```typescript -flush(): void; -``` -Returns: - -`void` - diff --git a/docs/sources/packages_api/runtime/getangularloader.md b/docs/sources/packages_api/runtime/getangularloader.md deleted file mode 100644 index 09b43df38d2..00000000000 --- a/docs/sources/packages_api/runtime/getangularloader.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getAngularLoader" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getAngularLoader() function - -### getAngularLoader() function - -Used to retrieve the [AngularLoader](./runtime/angularloader.md) that enables the use of Angular components within a React component. - -Please see the [AngularComponent](./runtime/angularcomponent.md) for a proper example. - -Signature - -```typescript -export declare function getAngularLoader(): AngularLoader; -``` -Import - -```typescript -import { getAngularLoader } from '@grafana/runtime'; -``` -Returns: - -`AngularLoader` - diff --git a/docs/sources/packages_api/runtime/getbackendsrv.md b/docs/sources/packages_api/runtime/getbackendsrv.md deleted file mode 100644 index 1af65f6159a..00000000000 --- a/docs/sources/packages_api/runtime/getbackendsrv.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getBackendSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getBackendSrv variable - -### getBackendSrv variable - -Used to retrieve the [BackendSrv](./runtime/backendsrv.md) that can be used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. - -Signature - -```typescript -getBackendSrv: () => BackendSrv -``` -Import - -```typescript -import { getBackendSrv } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/getdatasourcesrv.md b/docs/sources/packages_api/runtime/getdatasourcesrv.md deleted file mode 100644 index 2b31269b9fa..00000000000 --- a/docs/sources/packages_api/runtime/getdatasourcesrv.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getDataSourceSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getDataSourceSrv() function - -### getDataSourceSrv() function - -Used to retrieve the [DataSourceSrv](./runtime/datasourcesrv.md) that is the entry point for communicating with a datasource that is added as a plugin (both external and internal). - -Signature - -```typescript -export declare function getDataSourceSrv(): DataSourceSrv; -``` -Import - -```typescript -import { getDataSourceSrv } from '@grafana/runtime'; -``` -Returns: - -`DataSourceSrv` - diff --git a/docs/sources/packages_api/runtime/getechosrv.md b/docs/sources/packages_api/runtime/getechosrv.md deleted file mode 100644 index 85dd41900ce..00000000000 --- a/docs/sources/packages_api/runtime/getechosrv.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getEchoSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getEchoSrv() function - -### getEchoSrv() function - -Used to retrieve the [EchoSrv](./runtime/echosrv.md) that can be used to report events to registered echo backends. - -Signature - -```typescript -export declare function getEchoSrv(): EchoSrv; -``` -Import - -```typescript -import { getEchoSrv } from '@grafana/runtime'; -``` -Returns: - -`EchoSrv` - diff --git a/docs/sources/packages_api/runtime/getlegacyangularinjector.md b/docs/sources/packages_api/runtime/getlegacyangularinjector.md deleted file mode 100644 index df3b0bb9f0c..00000000000 --- a/docs/sources/packages_api/runtime/getlegacyangularinjector.md +++ /dev/null @@ -1,28 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getLegacyAngularInjector" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getLegacyAngularInjector variable - -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. -> - -### getLegacyAngularInjector variable - -WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future. - -Signature - -```typescript -getLegacyAngularInjector: () => auto.IInjectorService -``` -Import - -```typescript -import { getLegacyAngularInjector } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/getlocationsrv.md b/docs/sources/packages_api/runtime/getlocationsrv.md deleted file mode 100644 index 9abb2c9a7ff..00000000000 --- a/docs/sources/packages_api/runtime/getlocationsrv.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getLocationSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getLocationSrv() function - -### getLocationSrv() function - -Used to retrieve the [LocationSrv](./runtime/locationsrv.md) that can be used to automatically navigate the user to a new place in Grafana. - -Signature - -```typescript -export declare function getLocationSrv(): LocationSrv; -``` -Import - -```typescript -import { getLocationSrv } from '@grafana/runtime'; -``` -Returns: - -`LocationSrv` - diff --git a/docs/sources/packages_api/runtime/gettemplatesrv.md b/docs/sources/packages_api/runtime/gettemplatesrv.md deleted file mode 100644 index cfd401fe850..00000000000 --- a/docs/sources/packages_api/runtime/gettemplatesrv.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTemplateSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## getTemplateSrv variable - -### getTemplateSrv variable - -Used to retrieve the [TemplateSrv](./runtime/templatesrv.md) that can be used to fetch available template variables. - -Signature - -```typescript -getTemplateSrv: () => TemplateSrv -``` -Import - -```typescript -import { getTemplateSrv } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/grafanabootconfig.md b/docs/sources/packages_api/runtime/grafanabootconfig.md deleted file mode 100644 index 07bbfa65752..00000000000 --- a/docs/sources/packages_api/runtime/grafanabootconfig.md +++ /dev/null @@ -1,401 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GrafanaBootConfig" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## GrafanaBootConfig class - -Signature - -```typescript -export declare class GrafanaBootConfig implements GrafanaConfig -``` -Import - -```typescript -import { GrafanaBootConfig } from '@grafana/runtime'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(options)](#constructor-options) | | Constructs a new instance of the GrafanaBootConfig class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [alertingEnabled](#alertingenabled-property) | | boolean | | -| [alertingErrorOrTimeout](#alertingerrorortimeout-property) | | string | | -| [alertingMinInterval](#alertingmininterval-property) | | number | | -| [alertingNoDataOrNullValues](#alertingnodataornullvalues-property) | | string | | -| [allowOrgCreate](#alloworgcreate-property) | | boolean | | -| [appSubUrl](#appsuburl-property) | | string | | -| [appUrl](#appurl-property) | | string | | -| [authProxyEnabled](#authproxyenabled-property) | | boolean | | -| [autoAssignOrg](#autoassignorg-property) | | boolean | | -| [bootData](#bootdata-property) | | any | | -| [buildInfo](#buildinfo-property) | | BuildInfo | | -| [datasources](#datasources-property) | | {
[str: string]: DataSourceInstanceSettings;
} | | -| [defaultDatasource](#defaultdatasource-property) | | string | | -| [disableLoginForm](#disableloginform-property) | | boolean | | -| [disableSanitizeHtml](#disablesanitizehtml-property) | | boolean | | -| [disableUserSignUp](#disableusersignup-property) | | boolean | | -| [editorsCanAdmin](#editorscanadmin-property) | | boolean | | -| [exploreEnabled](#exploreenabled-property) | | boolean | | -| [externalUserMngInfo](#externalusermnginfo-property) | | string | | -| [externalUserMngLinkName](#externalusermnglinkname-property) | | string | | -| [externalUserMngLinkUrl](#externalusermnglinkurl-property) | | string | | -| [featureToggles](#featuretoggles-property) | | FeatureToggles | | -| [ldapEnabled](#ldapenabled-property) | | boolean | | -| [licenseInfo](#licenseinfo-property) | | LicenseInfo | | -| [loginError](#loginerror-property) | | any | | -| [loginHint](#loginhint-property) | | any | | -| [minRefreshInterval](#minrefreshinterval-property) | | string | | -| [navTree](#navtree-property) | | any | | -| [newPanelTitle](#newpaneltitle-property) | | string | | -| [oauth](#oauth-property) | | any | | -| [panels](#panels-property) | | {
[key: string]: PanelPluginMeta;
} | | -| [passwordHint](#passwordhint-property) | | any | | -| [pluginsToPreload](#pluginstopreload-property) | | string[] | | -| [rendererAvailable](#rendereravailable-property) | | boolean | | -| [samlEnabled](#samlenabled-property) | | boolean | | -| [theme](#theme-property) | | GrafanaTheme | | -| [verifyEmailEnabled](#verifyemailenabled-property) | | boolean | | -| [viewersCanEdit](#viewerscanedit-property) | | boolean | | -| [windowTitlePrefix](#windowtitleprefix-property) | | string | | - -### constructor(options) - -Constructs a new instance of the `GrafanaBootConfig` class - -Signature - -```typescript -constructor(options: GrafanaBootConfig); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | GrafanaBootConfig | | - -### alertingEnabled property - -Signature - -```typescript -alertingEnabled: boolean; -``` - -### alertingErrorOrTimeout property - -Signature - -```typescript -alertingErrorOrTimeout: string; -``` - -### alertingMinInterval property - -Signature - -```typescript -alertingMinInterval: number; -``` - -### alertingNoDataOrNullValues property - -Signature - -```typescript -alertingNoDataOrNullValues: string; -``` - -### allowOrgCreate property - -Signature - -```typescript -allowOrgCreate: boolean; -``` - -### appSubUrl property - -Signature - -```typescript -appSubUrl: string; -``` - -### appUrl property - -Signature - -```typescript -appUrl: string; -``` - -### authProxyEnabled property - -Signature - -```typescript -authProxyEnabled: boolean; -``` - -### autoAssignOrg property - -Signature - -```typescript -autoAssignOrg: boolean; -``` - -### bootData property - -Signature - -```typescript -bootData: any; -``` - -### buildInfo property - -Signature - -```typescript -buildInfo: BuildInfo; -``` - -### datasources property - -Signature - -```typescript -datasources: { - [str: string]: DataSourceInstanceSettings; - }; -``` - -### defaultDatasource property - -Signature - -```typescript -defaultDatasource: string; -``` - -### disableLoginForm property - -Signature - -```typescript -disableLoginForm: boolean; -``` - -### disableSanitizeHtml property - -Signature - -```typescript -disableSanitizeHtml: boolean; -``` - -### disableUserSignUp property - -Signature - -```typescript -disableUserSignUp: boolean; -``` - -### editorsCanAdmin property - -Signature - -```typescript -editorsCanAdmin: boolean; -``` - -### exploreEnabled property - -Signature - -```typescript -exploreEnabled: boolean; -``` - -### externalUserMngInfo property - -Signature - -```typescript -externalUserMngInfo: string; -``` - -### externalUserMngLinkName property - -Signature - -```typescript -externalUserMngLinkName: string; -``` - -### externalUserMngLinkUrl property - -Signature - -```typescript -externalUserMngLinkUrl: string; -``` - -### featureToggles property - -Signature - -```typescript -featureToggles: FeatureToggles; -``` - -### ldapEnabled property - -Signature - -```typescript -ldapEnabled: boolean; -``` - -### licenseInfo property - -Signature - -```typescript -licenseInfo: LicenseInfo; -``` - -### loginError property - -Signature - -```typescript -loginError: any; -``` - -### loginHint property - -Signature - -```typescript -loginHint: any; -``` - -### minRefreshInterval property - -Signature - -```typescript -minRefreshInterval: string; -``` - -### navTree property - -Signature - -```typescript -navTree: any; -``` - -### newPanelTitle property - -Signature - -```typescript -newPanelTitle: string; -``` - -### oauth property - -Signature - -```typescript -oauth: any; -``` - -### panels property - -Signature - -```typescript -panels: { - [key: string]: PanelPluginMeta; - }; -``` - -### passwordHint property - -Signature - -```typescript -passwordHint: any; -``` - -### pluginsToPreload property - -Signature - -```typescript -pluginsToPreload: string[]; -``` - -### rendererAvailable property - -Signature - -```typescript -rendererAvailable: boolean; -``` - -### samlEnabled property - -Signature - -```typescript -samlEnabled: boolean; -``` - -### theme property - -Signature - -```typescript -theme: GrafanaTheme; -``` - -### verifyEmailEnabled property - -Signature - -```typescript -verifyEmailEnabled: boolean; -``` - -### viewersCanEdit property - -Signature - -```typescript -viewersCanEdit: boolean; -``` - -### windowTitlePrefix property - -Signature - -```typescript -windowTitlePrefix: string; -``` diff --git a/docs/sources/packages_api/runtime/healthcheckresult.md b/docs/sources/packages_api/runtime/healthcheckresult.md deleted file mode 100644 index 1a00ec59add..00000000000 --- a/docs/sources/packages_api/runtime/healthcheckresult.md +++ /dev/null @@ -1,54 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "HealthCheckResult" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## HealthCheckResult interface - -Describes the payload returned when checking the health of a data source plugin. - -Signature - -```typescript -export interface HealthCheckResult -``` -Import - -```typescript -import { HealthCheckResult } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [details](#details-property) | Record<string, any> | | -| [message](#message-property) | string | | -| [status](#status-property) | HealthStatus | | - -### details property - -Signature - -```typescript -details?: Record; -``` - -### message property - -Signature - -```typescript -message: string; -``` - -### status property - -Signature - -```typescript -status: HealthStatus; -``` diff --git a/docs/sources/packages_api/runtime/healthstatus.md b/docs/sources/packages_api/runtime/healthstatus.md deleted file mode 100644 index ddcf4647022..00000000000 --- a/docs/sources/packages_api/runtime/healthstatus.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "HealthStatus" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## HealthStatus enum - -### HealthStatus enum - -Describes the current health status of a data source plugin. - -Signature - -```typescript -export declare enum HealthStatus -``` -Import - -```typescript -import { HealthStatus } from '@grafana/runtime'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Error | "ERROR" | | -| OK | "OK" | | -| Unknown | "UNKNOWN" | | - diff --git a/docs/sources/packages_api/runtime/loadplugincss.md b/docs/sources/packages_api/runtime/loadplugincss.md deleted file mode 100644 index 6ec00b9982a..00000000000 --- a/docs/sources/packages_api/runtime/loadplugincss.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "loadPluginCss" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## loadPluginCss() function - -### loadPluginCss() function - -Use this to load css for a Grafana plugin by specifying a [PluginCssOptions](./runtime/plugincssoptions.md) containing styling for the dark and the light theme. - -Signature - -```typescript -export declare function loadPluginCss(options: PluginCssOptions): Promise; -``` -Import - -```typescript -import { loadPluginCss } from '@grafana/runtime'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | PluginCssOptions | plugin styling for light and dark theme. | - -Returns: - -`Promise` - diff --git a/docs/sources/packages_api/runtime/locationsrv.md b/docs/sources/packages_api/runtime/locationsrv.md deleted file mode 100644 index 34bd4335000..00000000000 --- a/docs/sources/packages_api/runtime/locationsrv.md +++ /dev/null @@ -1,46 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LocationSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## LocationSrv interface - -If you need to automatically navigate the user to a new place in the application this should be done via the LocationSrv and it will make sure to update the application state accordingly. - -Signature - -```typescript -export interface LocationSrv -``` -Import - -```typescript -import { LocationSrv } from '@grafana/runtime'; -``` -Methods - -| Method | Description | -| --- | --- | -| [update(options)](#update-method) | | - -### update method - -Signature - -```typescript -update(options: LocationUpdate): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | LocationUpdate | | - -Returns: - -`void` - diff --git a/docs/sources/packages_api/runtime/locationupdate.md b/docs/sources/packages_api/runtime/locationupdate.md deleted file mode 100644 index 4c340c7e565..00000000000 --- a/docs/sources/packages_api/runtime/locationupdate.md +++ /dev/null @@ -1,67 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LocationUpdate" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## LocationUpdate interface - -Signature - -```typescript -export interface LocationUpdate -``` -Import - -```typescript -import { LocationUpdate } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [partial](#partial-property) | boolean | If set to true, the query argument will be added to the existing URL. | -| [path](#path-property) | string | Target path where you automatically wants to navigate the user. | -| [query](#query-property) | UrlQueryMap | Specify this value if you want to add values to the query string of the URL. | -| [replace](#replace-property) | boolean | | - -### partial property - -If set to true, the query argument will be added to the existing URL. - -Signature - -```typescript -partial?: boolean; -``` - -### path property - -Target path where you automatically wants to navigate the user. - -Signature - -```typescript -path?: string; -``` - -### query property - -Specify this value if you want to add values to the query string of the URL. - -Signature - -```typescript -query?: UrlQueryMap; -``` - -### replace property - -Signature - -```typescript -replace?: boolean; -``` diff --git a/docs/sources/packages_api/runtime/metaanalyticsevent.md b/docs/sources/packages_api/runtime/metaanalyticsevent.md deleted file mode 100644 index 0ff01a26499..00000000000 --- a/docs/sources/packages_api/runtime/metaanalyticsevent.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MetaAnalyticsEvent" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## MetaAnalyticsEvent interface - -Describes meta analytics event with predefined [EchoEventType.MetaAnalytics](./runtime/echoeventtype/metaanalytics.md) type. - -Signature - -```typescript -export interface MetaAnalyticsEvent extends EchoEvent -``` -Import - -```typescript -import { MetaAnalyticsEvent } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/metaanalyticseventname.md b/docs/sources/packages_api/runtime/metaanalyticseventname.md deleted file mode 100644 index ff76e50caf1..00000000000 --- a/docs/sources/packages_api/runtime/metaanalyticseventname.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MetaAnalyticsEventName" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## MetaAnalyticsEventName enum - -### MetaAnalyticsEventName enum - -The meta analytics events that can be added to the echo service. - -Signature - -```typescript -export declare enum MetaAnalyticsEventName -``` -Import - -```typescript -import { MetaAnalyticsEventName } from '@grafana/runtime'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| DashboardView | "dashboard-view" | | -| DataRequest | "data-request" | | - diff --git a/docs/sources/packages_api/runtime/metaanalyticseventpayload.md b/docs/sources/packages_api/runtime/metaanalyticseventpayload.md deleted file mode 100644 index 474a23cbc21..00000000000 --- a/docs/sources/packages_api/runtime/metaanalyticseventpayload.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MetaAnalyticsEventPayload" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## MetaAnalyticsEventPayload type - -### MetaAnalyticsEventPayload type - -Describes the meta analytics payload passed with the [MetaAnalyticsEvent](./runtime/metaanalyticsevent.md) - -Signature - -```typescript -export declare type MetaAnalyticsEventPayload = DashboardViewEventPayload | DataRequestEventPayload; -``` -Import - -```typescript -import { MetaAnalyticsEventPayload } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/plugincssoptions.md b/docs/sources/packages_api/runtime/plugincssoptions.md deleted file mode 100644 index 1f16e19f5e9..00000000000 --- a/docs/sources/packages_api/runtime/plugincssoptions.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PluginCssOptions" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## PluginCssOptions interface - -Option to specify a plugin css that should be applied for the dark and the light theme. - -Signature - -```typescript -export interface PluginCssOptions -``` -Import - -```typescript -import { PluginCssOptions } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dark](#dark-property) | string | | -| [light](#light-property) | string | | - -### dark property - -Signature - -```typescript -dark: string; -``` - -### light property - -Signature - -```typescript -light: string; -``` diff --git a/docs/sources/packages_api/runtime/registerechobackend.md b/docs/sources/packages_api/runtime/registerechobackend.md deleted file mode 100644 index b4844cb7bd2..00000000000 --- a/docs/sources/packages_api/runtime/registerechobackend.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "registerEchoBackend" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## registerEchoBackend variable - -### registerEchoBackend variable - -Used to register echo backends that will receive Grafana echo events during application runtime. - -Signature - -```typescript -registerEchoBackend: (backend: EchoBackend) => void -``` -Import - -```typescript -import { registerEchoBackend } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/reportmetaanalytics.md b/docs/sources/packages_api/runtime/reportmetaanalytics.md deleted file mode 100644 index e3604cbb0ea..00000000000 --- a/docs/sources/packages_api/runtime/reportmetaanalytics.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "reportMetaAnalytics" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## reportMetaAnalytics variable - -### reportMetaAnalytics variable - -Helper function to report meta analytics to the [EchoSrv](./runtime/echosrv.md). - -Signature - -```typescript -reportMetaAnalytics: (payload: MetaAnalyticsEventPayload) => void -``` -Import - -```typescript -import { reportMetaAnalytics } from '@grafana/runtime'; -``` diff --git a/docs/sources/packages_api/runtime/sizemeta.md b/docs/sources/packages_api/runtime/sizemeta.md deleted file mode 100644 index 87f623bec5f..00000000000 --- a/docs/sources/packages_api/runtime/sizemeta.md +++ /dev/null @@ -1,45 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SizeMeta" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## SizeMeta interface - -Describes a size with width/height - -Signature - -```typescript -export interface SizeMeta -``` -Import - -```typescript -import { SizeMeta } from '@grafana/runtime'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [height](#height-property) | number | | -| [width](#width-property) | number | | - -### height property - -Signature - -```typescript -height: number; -``` - -### width property - -Signature - -```typescript -width: number; -``` diff --git a/docs/sources/packages_api/runtime/templatesrv.md b/docs/sources/packages_api/runtime/templatesrv.md deleted file mode 100644 index 2c88ed651f9..00000000000 --- a/docs/sources/packages_api/runtime/templatesrv.md +++ /dev/null @@ -1,66 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TemplateSrv" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## TemplateSrv interface - -Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard. - -For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating - -Signature - -```typescript -export interface TemplateSrv -``` -Import - -```typescript -import { TemplateSrv } from '@grafana/runtime'; -``` -Methods - -| Method | Description | -| --- | --- | -| [getVariables()](#getvariables-method) | List the dashboard variables | -| [replace(target, scopedVars, format)](#replace-method) | Replace the values within the target string. See also | - -### getVariables method - -List the dashboard variables - -Signature - -```typescript -getVariables(): VariableModel[]; -``` -Returns: - -`VariableModel[]` - -### replace method - -Replace the values within the target string. See also - -Signature - -```typescript -replace(target: string, scopedVars?: ScopedVars, format?: string | Function): string; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| target | string | | -| scopedVars | ScopedVars | | -| format | string | Function | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/runtime/todataqueryerror.md b/docs/sources/packages_api/runtime/todataqueryerror.md deleted file mode 100644 index a890441cba2..00000000000 --- a/docs/sources/packages_api/runtime/todataqueryerror.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toDataQueryError" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## toDataQueryError() function - -### toDataQueryError() function - -Convert an object into a DataQueryError -- if this is an HTTP response, it will put the correct values in the error field - -Signature - -```typescript -export declare function toDataQueryError(err: any): DataQueryError; -``` -Import - -```typescript -import { toDataQueryError } from '@grafana/runtime'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| err | any | | - -Returns: - -`DataQueryError` - diff --git a/docs/sources/packages_api/runtime/todataqueryresponse.md b/docs/sources/packages_api/runtime/todataqueryresponse.md deleted file mode 100644 index 45a78333e7e..00000000000 --- a/docs/sources/packages_api/runtime/todataqueryresponse.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "toDataQueryResponse" -keywords = ["grafana","documentation","sdk","@grafana/runtime"] -type = "docs" -+++ - -## toDataQueryResponse() function - -### toDataQueryResponse() function - -Parse the results from \`/api/ds/query - -Signature - -```typescript -export declare function toDataQueryResponse(res: any): DataQueryResponse; -``` -Import - -```typescript -import { toDataQueryResponse } from '@grafana/runtime'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| res | any | | - -Returns: - -`DataQueryResponse` - diff --git a/docs/sources/packages_api/ui/_index.md b/docs/sources/packages_api/ui/_index.md deleted file mode 100644 index b055871a978..00000000000 --- a/docs/sources/packages_api/ui/_index.md +++ /dev/null @@ -1,278 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "@grafana/ui" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## @grafana/ui package - -A library containing the different design components of the Grafana ecosystem. - -## Classes - -| Class | Description | -| --- | --- | -| [ansicolor](./ansicolor/) | Represents an ANSI-escaped string. | -| [BarGauge](./bargauge/) | | -| [BigValue](./bigvalue/) | | -| [Cascader](./cascader/) | | -| [ClickOutsideWrapper](./clickoutsidewrapper/) | | -| [ClipboardButton](./clipboardbutton/) | | -| [CustomScrollbar](./customscrollbar/) | Wraps component into component from react-custom-scrollbars | -| [ErrorBoundary](./errorboundary/) | | -| [ErrorBoundaryAlert](./errorboundaryalert/) | | -| [Gauge](./gauge/) | | -| [Graph](./graph/) | | -| [GraphSeriesToggler](./graphseriestoggler/) | | -| [JsonExplorer](./jsonexplorer/) | JsonExplorerJsonExplorer allows you to render JSON objects in HTML with a \*\*collapsible\*\* navigation. | -| [JSONFormatter](./jsonformatter/) | | -| [List](./list/) | | -| [ModalsProvider](./modalsprovider/) | | -| [PieChart](./piechart/) | | -| [Popover](./popover/) | | -| [PopoverController](./popovercontroller/) | | -| [Portal](./portal/) | | -| [QueryField](./queryfield/) | Renders an editor field. Pass initial value as initialQuery and listen to changes in props.onValueChanged. This component can only process strings. Internally it uses Slate Value. Implement props.onTypeahead to use suggestions, see PromQueryField.tsx as an example. | -| [SelectValueEditor](./selectvalueeditor/) | | -| [SetInterval](./setinterval/) | | -| [StatsPicker](./statspicker/) | | -| [StringArrayEditor](./stringarrayeditor/) | | -| [TableInputCSV](./tableinputcsv/) | Expects the container div to have size set and will fill it 100% | -| [TagsInput](./tagsinput/) | | -| [ToggleButtonGroup](./togglebuttongroup/) | | -| [UnitPicker](./unitpicker/) | | -| [VizRepeater](./vizrepeater/) | | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [BarGaugeDisplayMode](./bargaugedisplaymode/) | | -| [BigValueColorMode](./bigvaluecolormode/) | | -| [BigValueGraphMode](./bigvaluegraphmode/) | | -| [BigValueJustifyMode](./bigvaluejustifymode/) | | -| [CompletionItemKind](./completionitemkind/) | | -| [EventsWithValidation](./eventswithvalidation/) | | -| [LegacyInputStatus](./legacyinputstatus/) | | -| [LegendDisplayMode](./legenddisplaymode/) | | -| [PieChartType](./piecharttype/) | | -| [TableCellDisplayMode](./tablecelldisplaymode/) | | - -## Functions - -| Function | Description | -| --- | --- | -| [AsyncMultiSelect(props)](./asyncmultiselect/) | | -| [AsyncSelect(props)](./asyncselect/) | | -| [BracesPlugin()](./bracesplugin/) | | -| [ButtonSelect({ placeholder, icon, variant, size, className, disabled, ...selectProps })](./buttonselect/) | | -| [calculateFontSize(text, width, height, lineHeight, maxSize)](./calculatefontsize/) | | -| [ClearPlugin()](./clearplugin/) | | -| [ClipboardPlugin()](./clipboardplugin/) | | -| [convertOldAngularValueMapping(panel)](./convertoldangularvaluemapping/) | Convert the angular single stat mapping to new react style | -| [FadeTransition(props)](./fadetransition/) | | -| [Form({ defaultValues, onSubmit, validateOnMount, validateFieldsOnMount, children, validateOn, maxWidth, })](./form/) | | -| [getScrollbarWidth()](./getscrollbarwidth/) | | -| [getTagColor(index)](./gettagcolor/) | | -| [getTagColorsFromName(name)](./gettagcolorsfromname/) | Returns tag badge background and border colors based on hashed tag name. | -| [IndentationPlugin()](./indentationplugin/) | | -| [measureText(text, fontSize)](./measuretext/) | | -| [MultiSelect(props)](./multiselect/) | | -| [NewlinePlugin()](./newlineplugin/) | | -| [RadioButtonGroup({ options, value, onChange, disabled, disabledOptions, size, fullWidth, })](./radiobuttongroup/) | | -| [renderOrCallToRender(itemToRender, props)](./renderorcalltorender/) | Given react node or function returns element accordingly | -| [resetSelectStyles()](./resetselectstyles/) | | -| [RunnerPlugin({ handler })](./runnerplugin/) | | -| [Segment({ options, value, onChange, Component, className, allowCustomValue, placeholder, })](./segment/) | | -| [SegmentAsync({ value, onChange, loadOptions, Component, className, allowCustomValue, placeholder, })](./segmentasync/) | | -| [SegmentInput({ value: initialValue, onChange, Component, className, placeholder, autofocus, })](./segmentinput/) | | -| [SegmentSelect({ value, options, onChange, onClickOutside, width, noOptionsMessage, allowCustomValue, })](./segmentselect/) | | -| [Select(props)](./select/) | | -| [SelectionShortcutsPlugin()](./selectionshortcutsplugin/) | | -| [sharedSingleStatMigrationHandler(panel)](./sharedsinglestatmigrationhandler/) | | -| [sharedSingleStatPanelChangedHandler(panel, prevPluginId, prevOptions)](./sharedsinglestatpanelchangedhandler/) | | -| [SlatePrism(optsParam)](./slateprism/) | A Slate plugin to highlight code syntax. | -| [SlideOutTransition(props)](./slideouttransition/) | | -| [stylesFactory(stylesCreator)](./stylesfactory/) | Creates memoized version of styles creator | -| [SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, })](./suggestionsplugin/) | | -| [useTheme()](./usetheme/) | | -| [ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, })](./valuepicker/) | | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [BadgeProps](./badgeprops/) | | -| [BigValueSparkline](./bigvaluesparkline/) | | -| [CascaderOption](./cascaderoption/) | | -| [CompletionItem](./completionitem/) | | -| [CompletionItemGroup](./completionitemgroup/) | | -| [ContextMenuGroup](./contextmenugroup/) | | -| [ContextMenuItem](./contextmenuitem/) | | -| [ContextMenuProps](./contextmenuprops/) | | -| [GraphSeriesTogglerAPI](./graphseriestogglerapi/) | | -| [GraphTooltipOptions](./graphtooltipoptions/) | | -| [LegendBasicOptions](./legendbasicoptions/) | | -| [LegendItem](./legenditem/) | | -| [LegendOptions](./legendoptions/) | | -| [LegendRenderOptions](./legendrenderoptions/) | | -| [SingleStatBaseOptions](./singlestatbaseoptions/) | | -| [StyleProps](./styleprops/) | | -| [SuggestionsState](./suggestionsstate/) | | -| [TableSortByFieldState](./tablesortbyfieldstate/) | | -| [Themeable](./themeable/) | | -| [Token](./token/) | | -| [TypeaheadInput](./typeaheadinput/) | | -| [TypeaheadOutput](./typeaheadoutput/) | | -| [ValidationEvents](./validationevents/) | | -| [ValidationRule](./validationrule/) | | -| [VizRepeaterRenderValueProps](./vizrepeaterrendervalueprops/) | | - -## Namespaces - -| Namespace | Description | -| --- | --- | -| [DOMUtil](./domutil/) | | -| [RadioButtonGroup](./radiobuttongroup/) | | -| [styleMixins](./stylemixins/) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [Alert](./alert/) | | -| [ALERTING\_COLOR](./alerting_color/) | | -| [AlphaNotice](./alphanotice/) | | -| [Badge](./badge/) | | -| [Button](./button/) | | -| [ButtonCascader](./buttoncascader/) | | -| [CallToActionCard](./calltoactioncard/) | | -| [Chart](./chart/) | | -| [Checkbox](./checkbox/) | | -| [CodeEditor](./codeeditor/) | | -| [Collapse](./collapse/) | | -| [ColorPicker](./colorpicker/) | | -| [colors](./colors/) | | -| [ConfirmButton](./confirmbutton/) | | -| [ConfirmModal](./confirmmodal/) | | -| [Container](./container/) | | -| [ContextMenu](./contextmenu/) | | -| [ControlledCollapse](./controlledcollapse/) | | -| [Counter](./counter/) | | -| [DataLinkInput](./datalinkinput/) | | -| [DataLinksContextMenu](./datalinkscontextmenu/) | | -| [DataLinksInlineEditor](./datalinksinlineeditor/) | | -| [DataSourceHttpSettings](./datasourcehttpsettings/) | | -| [DEFAULT\_ANNOTATION\_COLOR](./default_annotation_color/) | | -| [DeleteButton](./deletebutton/) | | -| [Drawer](./drawer/) | | -| [EmptySearchResult](./emptysearchresult/) | | -| [ErrorWithStack](./errorwithstack/) | | -| [FeatureInfoBox](./featureinfobox/) | | -| [Field](./field/) | | -| [FieldConfigItemHeaderTitle](./fieldconfigitemheadertitle/) | | -| [fieldMatchersUI](./fieldmatchersui/) | | -| [FieldSet](./fieldset/) | | -| [FileUpload](./fileupload/) | | -| [FilterPill](./filterpill/) | | -| [FullWidthButtonContainer](./fullwidthbuttoncontainer/) | | -| [getAvailableIcons](./getavailableicons/) | | -| [getButtonStyles](./getbuttonstyles/) | | -| [getFormStyles](./getformstyles/) | | -| [getLogRowStyles](./getlogrowstyles/) | | -| [getStandardFieldConfigs](./getstandardfieldconfigs/) | Returns collection of common field config properties definitions | -| [getStandardOptionEditors](./getstandardoptioneditors/) | Returns collection of standard option editors definitions | -| [getTheme](./gettheme/) | | -| [GraphContextMenu](./graphcontextmenu/) | | -| [GraphLegend](./graphlegend/) | | -| [graphTickFormatter](./graphtickformatter/) | | -| [graphTimeFormat](./graphtimeformat/) | | -| [GraphWithLegend](./graphwithlegend/) | | -| [hasValidationEvent](./hasvalidationevent/) | | -| [HorizontalGroup](./horizontalgroup/) | | -| [Icon](./icon/) | | -| [IconButton](./iconbutton/) | | -| [InlineFormLabel](./inlineformlabel/) | | -| [Input](./input/) | | -| [Label](./label/) | | -| [LegacyForms](./legacyforms/) | | -| [Legend](./legend/) | | -| [LegendList](./legendlist/) | | -| [LegendTable](./legendtable/) | | -| [LinkButton](./linkbutton/) | | -| [linkModelToContextMenuItems](./linkmodeltocontextmenuitems/) | Delays creating links until we need to open the ContextMenu | -| [LoadingPlaceholder](./loadingplaceholder/) | | -| [LogLabels](./loglabels/) | | -| [LogRows](./logrows/) | | -| [makeFragment](./makefragment/) | | -| [makeValue](./makevalue/) | | -| [mockTheme](./mocktheme/) | | -| [mockThemeContext](./mockthemecontext/) | Enables theme context mocking | -| [Modal](./modal/) | | -| [ModalHeader](./modalheader/) | | -| [ModalRoot](./modalroot/) | | -| [ModalsController](./modalscontroller/) | | -| [ModalTabContent](./modaltabcontent/) | | -| [ModalTabsHeader](./modaltabsheader/) | | -| [NO\_DATA\_COLOR](./no_data_color/) | | -| [NumberValueEditor](./numbervalueeditor/) | | -| [OK\_COLOR](./ok_color/) | | -| [Pagination](./pagination/) | | -| [PALETTE\_COLUMNS](./palette_columns/) | | -| [PALETTE\_ROWS](./palette_rows/) | | -| [PanelOptionsGrid](./paneloptionsgrid/) | | -| [PanelOptionsGroup](./paneloptionsgroup/) | | -| [PENDING\_COLOR](./pending_color/) | | -| [RefreshPicker](./refreshpicker/) | | -| [regexValidation](./regexvalidation/) | | -| [REGION\_FILL\_ALPHA](./region_fill_alpha/) | | -| [SCHEMA](./schema/) | | -| [selectThemeVariant](./selectthemevariant/) | | -| [SeriesColorPicker](./seriescolorpicker/) | | -| [SeriesColorPickerPopover](./seriescolorpickerpopover/) | | -| [SeriesColorPickerPopoverWithTheme](./seriescolorpickerpopoverwiththeme/) | | -| [SeriesIcon](./seriesicon/) | | -| [Slider](./slider/) | | -| [sortedColors](./sortedcolors/) | | -| [Spinner](./spinner/) | | -| [StringValueEditor](./stringvalueeditor/) | | -| [Switch](./switch/) | | -| [Tab](./tab/) | | -| [TabContent](./tabcontent/) | | -| [Table](./table/) | | -| [TabsBar](./tabsbar/) | | -| [Tag](./tag/) | | -| [TagList](./taglist/) | | -| [TextArea](./textarea/) | | -| [ThemeContext](./themecontext/) | | -| [TimeOfDayPicker](./timeofdaypicker/) | | -| [TimeRangePicker](./timerangepicker/) | | -| [TimeZonePicker](./timezonepicker/) | | -| [ToggleButton](./togglebutton/) | | -| [Tooltip](./tooltip/) | | -| [useStyles](./usestyles/) | Hook for using memoized styles with access to the theme. | -| [validate](./validate/) | | -| [VerticalGroup](./verticalgroup/) | | -| [withTheme](./withtheme/) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AlertVariant](./alertvariant/) | | -| [BadgeColor](./badgecolor/) | | -| [ButtonProps](./buttonprops/) | | -| [ButtonVariant](./buttonvariant/) | | -| [FormAPI](./formapi/) | | -| [FormInputSize](./forminputsize/) | | -| [IconName](./iconname/) | | -| [IconSize](./iconsize/) | | -| [IconType](./icontype/) | | -| [LegendPlacement](./legendplacement/) | | -| [PopoverContent](./popovercontent/) | | -| [Renderable](./renderable/) | | -| [RenderFunction](./renderfunction/) | | - diff --git a/docs/sources/packages_api/ui/alert.md b/docs/sources/packages_api/ui/alert.md deleted file mode 100644 index 7fbdc99f40f..00000000000 --- a/docs/sources/packages_api/ui/alert.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Alert" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Alert variable - -### Alert variable - -Signature - -```typescript -Alert: FC -``` -Import - -```typescript -import { Alert } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/alerting_color.md b/docs/sources/packages_api/ui/alerting_color.md deleted file mode 100644 index 1b8f5842729..00000000000 --- a/docs/sources/packages_api/ui/alerting_color.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ALERTING_COLOR" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ALERTING\_COLOR variable - -### ALERTING\_COLOR variable - -Signature - -```typescript -ALERTING_COLOR = "rgba(237, 46, 24, 1)" -``` -Import - -```typescript -import { ALERTING_COLOR } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/alertvariant.md b/docs/sources/packages_api/ui/alertvariant.md deleted file mode 100644 index e4031baf49c..00000000000 --- a/docs/sources/packages_api/ui/alertvariant.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AlertVariant" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## AlertVariant type - -### AlertVariant type - -Signature - -```typescript -export declare type AlertVariant = 'success' | 'warning' | 'error' | 'info'; -``` -Import - -```typescript -import { AlertVariant } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/alphanotice.md b/docs/sources/packages_api/ui/alphanotice.md deleted file mode 100644 index 9827cd1113b..00000000000 --- a/docs/sources/packages_api/ui/alphanotice.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AlphaNotice" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## AlphaNotice variable - -### AlphaNotice variable - -Signature - -```typescript -AlphaNotice: FC -``` -Import - -```typescript -import { AlphaNotice } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/ansicolor.md b/docs/sources/packages_api/ui/ansicolor.md deleted file mode 100644 index 779d1524dc3..00000000000 --- a/docs/sources/packages_api/ui/ansicolor.md +++ /dev/null @@ -1,211 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ansicolor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ansicolor class - -Represents an ANSI-escaped string. - -Signature - -```typescript -export default class Colors -``` -Import - -```typescript -import { ansicolor } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(s)](#constructor-s) | | Constructs a new instance of the Colors class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [asChromeConsoleLogArguments](#aschromeconsolelogarguments-property) | | any[] | | -| [browserConsoleArguments](#browserconsolearguments-property) | | any[] | | -| [names](#names-property) | static | (string | number)[] | | -| [nice](#nice-property) | static | typeof Colors | installs String prototype extensions | -| [parsed](#parsed-property) | | Colors & {
spans: any[];
} | | -| [rgb](#rgb-property) | static | {
black: number[];
darkGray: number[];
lightGray: number[];
white: number[];
red: number[];
lightRed: number[];
green: number[];
lightGreen: number[];
yellow: number[];
lightYellow: number[];
blue: number[];
lightBlue: number[];
magenta: number[];
lightMagenta: number[];
cyan: number[];
lightCyan: number[];
} | | -| [spans](#spans-property) | | any[] | | -| [str](#str-property) | | any | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [\[Symbol.iterator\]()](#_symbol.iterator_-method) | | | -| [parse(s)](#parse-method) | static | parses a string containing ANSI escape codes {Colors} parsed representation. | -| [strip(s)](#strip-method) | static | strips ANSI codes from a string | - -### constructor(s) - -Constructs a new instance of the `Colors` class - -Signature - -```typescript -constructor(s?: string); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| s | string | a string containing ANSI escape codes. | - -### asChromeConsoleLogArguments property - -Signature - -```typescript -get asChromeConsoleLogArguments(): any[]; -``` - -### browserConsoleArguments property - -Signature - -```typescript -get browserConsoleArguments(): any[]; -``` - -### names property - -Signature - -```typescript -static names: (string | number)[]; -``` - -### nice property - - installs String prototype extensions - -Signature - -```typescript -static get nice(): typeof Colors; -``` - -## Example - -require ('ansicolor').nice console.log ('foo'.bright.red) - -### parsed property - -Signature - -```typescript -get parsed(): Colors & { - spans: any[]; - }; -``` - -### rgb property - -Signature - -```typescript -static rgb: { - black: number[]; - darkGray: number[]; - lightGray: number[]; - white: number[]; - red: number[]; - lightRed: number[]; - green: number[]; - lightGreen: number[]; - yellow: number[]; - lightYellow: number[]; - blue: number[]; - lightBlue: number[]; - magenta: number[]; - lightMagenta: number[]; - cyan: number[]; - lightCyan: number[]; - }; -``` - -### spans property - -Signature - -```typescript -spans: any[]; -``` - -### str property - -Signature - -```typescript -get str(): any; -``` - -### \[Symbol.iterator\] method - -Signature - -```typescript -[Symbol.iterator](): IterableIterator; -``` -Returns: - -`IterableIterator` - -## Example - -const spans = \[...ansi.parse ('\\u001b\[7m\\u001b\[7mfoo\\u001b\[7mbar\\u001b\[27m')\] - -### parse method - - parses a string containing ANSI escape codes {Colors} parsed representation. - -Signature - -```typescript -static parse(s: string): Colors & { - spans: any[]; - }; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| s | string | | - -Returns: - -`Colors & { - spans: any[]; - }` - -### strip method - - strips ANSI codes from a string - -Signature - -```typescript -static strip(s: string): string; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| s | string | a string containing ANSI escape codes. {string} clean string. | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/ui/asyncmultiselect.md b/docs/sources/packages_api/ui/asyncmultiselect.md deleted file mode 100644 index ee4c00f2030..00000000000 --- a/docs/sources/packages_api/ui/asyncmultiselect.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AsyncMultiSelect" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## AsyncMultiSelect() function - -### AsyncMultiSelect() function - -Signature - -```typescript -export declare function AsyncMultiSelect(props: AsyncMultiSelectProps): JSX.Element; -``` -Import - -```typescript -import { AsyncMultiSelect } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | AsyncMultiSelectProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/asyncselect.md b/docs/sources/packages_api/ui/asyncselect.md deleted file mode 100644 index aef0d36fda0..00000000000 --- a/docs/sources/packages_api/ui/asyncselect.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "AsyncSelect" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## AsyncSelect() function - -### AsyncSelect() function - -Signature - -```typescript -export declare function AsyncSelect(props: AsyncSelectProps): JSX.Element; -``` -Import - -```typescript -import { AsyncSelect } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | AsyncSelectProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/badge.md b/docs/sources/packages_api/ui/badge.md deleted file mode 100644 index 4c686359120..00000000000 --- a/docs/sources/packages_api/ui/badge.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Badge" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Badge variable - -### Badge variable - -Signature - -```typescript -Badge: React.NamedExoticComponent -``` -Import - -```typescript -import { Badge } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/badgecolor.md b/docs/sources/packages_api/ui/badgecolor.md deleted file mode 100644 index 4c88f04efd9..00000000000 --- a/docs/sources/packages_api/ui/badgecolor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BadgeColor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BadgeColor type - -### BadgeColor type - -Signature - -```typescript -export declare type BadgeColor = 'blue' | 'red' | 'green' | 'orange' | 'purple'; -``` -Import - -```typescript -import { BadgeColor } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/badgeprops.md b/docs/sources/packages_api/ui/badgeprops.md deleted file mode 100644 index 4e544c25a81..00000000000 --- a/docs/sources/packages_api/ui/badgeprops.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BadgeProps" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BadgeProps interface - -Signature - -```typescript -export interface BadgeProps -``` -Import - -```typescript -import { BadgeProps } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | BadgeColor | | -| [icon](#icon-property) | IconName | | -| [text](#text-property) | string | | -| [tooltip](#tooltip-property) | string | | - -### color property - -Signature - -```typescript -color: BadgeColor; -``` - -### icon property - -Signature - -```typescript -icon?: IconName; -``` - -### text property - -Signature - -```typescript -text: string; -``` - -### tooltip property - -Signature - -```typescript -tooltip?: string; -``` diff --git a/docs/sources/packages_api/ui/bargauge.md b/docs/sources/packages_api/ui/bargauge.md deleted file mode 100644 index 47917ecc7b6..00000000000 --- a/docs/sources/packages_api/ui/bargauge.md +++ /dev/null @@ -1,106 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BarGauge" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BarGauge class - -Signature - -```typescript -export declare class BarGauge extends PureComponent -``` -Import - -```typescript -import { BarGauge } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | Partial<Props> | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [getCellColor(positionValue)](#getcellcolor-method) | | | -| [render()](#render-method) | | | -| [renderBarAndValue()](#renderbarandvalue-method) | | | -| [renderBasicAndGradientBars()](#renderbasicandgradientbars-method) | | | -| [renderRetroBars()](#renderretrobars-method) | | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### getCellColor method - -Signature - -```typescript -getCellColor(positionValue: TimeSeriesValue): CellColors; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| positionValue | TimeSeriesValue | | - -Returns: - -`CellColors` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - -### renderBarAndValue method - -Signature - -```typescript -renderBarAndValue(): React.ReactNode; -``` -Returns: - -`React.ReactNode` - -### renderBasicAndGradientBars method - -Signature - -```typescript -renderBasicAndGradientBars(): ReactNode; -``` -Returns: - -`ReactNode` - -### renderRetroBars method - -Signature - -```typescript -renderRetroBars(): ReactNode; -``` -Returns: - -`ReactNode` - diff --git a/docs/sources/packages_api/ui/bargaugedisplaymode.md b/docs/sources/packages_api/ui/bargaugedisplaymode.md deleted file mode 100644 index d2f177d2d02..00000000000 --- a/docs/sources/packages_api/ui/bargaugedisplaymode.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BarGaugeDisplayMode" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BarGaugeDisplayMode enum - -### BarGaugeDisplayMode enum - -Signature - -```typescript -export declare enum BarGaugeDisplayMode -``` -Import - -```typescript -import { BarGaugeDisplayMode } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Basic | "basic" | | -| Gradient | "gradient" | | -| Lcd | "lcd" | | - diff --git a/docs/sources/packages_api/ui/bigvalue.md b/docs/sources/packages_api/ui/bigvalue.md deleted file mode 100644 index faffb9f1565..00000000000 --- a/docs/sources/packages_api/ui/bigvalue.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BigValue" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BigValue class - -Signature - -```typescript -export declare class BigValue extends PureComponent -``` -Import - -```typescript -import { BigValue } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | Partial<Props> | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/bigvaluecolormode.md b/docs/sources/packages_api/ui/bigvaluecolormode.md deleted file mode 100644 index 16f2d0dc0eb..00000000000 --- a/docs/sources/packages_api/ui/bigvaluecolormode.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BigValueColorMode" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BigValueColorMode enum - -### BigValueColorMode enum - -Signature - -```typescript -export declare enum BigValueColorMode -``` -Import - -```typescript -import { BigValueColorMode } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Background | "background" | | -| Value | "value" | | - diff --git a/docs/sources/packages_api/ui/bigvaluegraphmode.md b/docs/sources/packages_api/ui/bigvaluegraphmode.md deleted file mode 100644 index 240c8109c3b..00000000000 --- a/docs/sources/packages_api/ui/bigvaluegraphmode.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BigValueGraphMode" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BigValueGraphMode enum - -### BigValueGraphMode enum - -Signature - -```typescript -export declare enum BigValueGraphMode -``` -Import - -```typescript -import { BigValueGraphMode } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Area | "area" | | -| Line | "line" | | -| None | "none" | | - diff --git a/docs/sources/packages_api/ui/bigvaluejustifymode.md b/docs/sources/packages_api/ui/bigvaluejustifymode.md deleted file mode 100644 index a6db149d217..00000000000 --- a/docs/sources/packages_api/ui/bigvaluejustifymode.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BigValueJustifyMode" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BigValueJustifyMode enum - -### BigValueJustifyMode enum - -Signature - -```typescript -export declare enum BigValueJustifyMode -``` -Import - -```typescript -import { BigValueJustifyMode } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Auto | "auto" | | -| Center | "center" | | - diff --git a/docs/sources/packages_api/ui/bigvaluesparkline.md b/docs/sources/packages_api/ui/bigvaluesparkline.md deleted file mode 100644 index 74082c3a582..00000000000 --- a/docs/sources/packages_api/ui/bigvaluesparkline.md +++ /dev/null @@ -1,79 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BigValueSparkline" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BigValueSparkline interface - -Signature - -```typescript -export interface BigValueSparkline -``` -Import - -```typescript -import { BigValueSparkline } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data](#data-property) | GraphSeriesValue[][] | | -| [highlightIndex](#highlightindex-property) | number | | -| [xMax](#xmax-property) | number | null | | -| [xMin](#xmin-property) | number | null | | -| [yMax](#ymax-property) | number | null | | -| [yMin](#ymin-property) | number | null | | - -### data property - -Signature - -```typescript -data: GraphSeriesValue[][]; -``` - -### highlightIndex property - -Signature - -```typescript -highlightIndex?: number; -``` - -### xMax property - -Signature - -```typescript -xMax?: number | null; -``` - -### xMin property - -Signature - -```typescript -xMin?: number | null; -``` - -### yMax property - -Signature - -```typescript -yMax?: number | null; -``` - -### yMin property - -Signature - -```typescript -yMin?: number | null; -``` diff --git a/docs/sources/packages_api/ui/bracesplugin.md b/docs/sources/packages_api/ui/bracesplugin.md deleted file mode 100644 index 69dd8d69710..00000000000 --- a/docs/sources/packages_api/ui/bracesplugin.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "BracesPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## BracesPlugin() function - -### BracesPlugin() function - -Signature - -```typescript -export declare function BracesPlugin(): Plugin; -``` -Import - -```typescript -import { BracesPlugin } from '@grafana/ui'; -``` -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/button.md b/docs/sources/packages_api/ui/button.md deleted file mode 100644 index 3585d01ff6c..00000000000 --- a/docs/sources/packages_api/ui/button.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Button" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Button variable - -### Button variable - -Signature - -```typescript -Button: React.ForwardRefExoticComponent & React.RefAttributes> -``` -Import - -```typescript -import { Button } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/buttoncascader.md b/docs/sources/packages_api/ui/buttoncascader.md deleted file mode 100644 index b812b655fb5..00000000000 --- a/docs/sources/packages_api/ui/buttoncascader.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ButtonCascader" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ButtonCascader variable - -### ButtonCascader variable - -Signature - -```typescript -ButtonCascader: React.FC -``` -Import - -```typescript -import { ButtonCascader } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/buttonprops.md b/docs/sources/packages_api/ui/buttonprops.md deleted file mode 100644 index a3a6eb2e731..00000000000 --- a/docs/sources/packages_api/ui/buttonprops.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ButtonProps" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ButtonProps type - -### ButtonProps type - -Signature - -```typescript -export declare type ButtonProps = CommonProps & ButtonHTMLAttributes; -``` -Import - -```typescript -import { ButtonProps } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/buttonselect.md b/docs/sources/packages_api/ui/buttonselect.md deleted file mode 100644 index 566e9e68a8a..00000000000 --- a/docs/sources/packages_api/ui/buttonselect.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ButtonSelect" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ButtonSelect() function - -### ButtonSelect() function - -Signature - -```typescript -export declare function ButtonSelect({ placeholder, icon, variant, size, className, disabled, ...selectProps }: ButtonSelectProps): JSX.Element; -``` -Import - -```typescript -import { ButtonSelect } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { placeholder, icon, variant, size, className, disabled, ...selectProps } | ButtonSelectProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/buttonvariant.md b/docs/sources/packages_api/ui/buttonvariant.md deleted file mode 100644 index e19d11cb2d2..00000000000 --- a/docs/sources/packages_api/ui/buttonvariant.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ButtonVariant" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ButtonVariant type - -### ButtonVariant type - -Signature - -```typescript -export declare type ButtonVariant = 'primary' | 'secondary' | 'destructive' | 'link'; -``` -Import - -```typescript -import { ButtonVariant } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/calculatefontsize.md b/docs/sources/packages_api/ui/calculatefontsize.md deleted file mode 100644 index 1b963c48d26..00000000000 --- a/docs/sources/packages_api/ui/calculatefontsize.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "calculateFontSize" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## calculateFontSize() function - -### calculateFontSize() function - -Signature - -```typescript -export declare function calculateFontSize(text: string, width: number, height: number, lineHeight: number, maxSize?: number): number; -``` -Import - -```typescript -import { calculateFontSize } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | | -| width | number | | -| height | number | | -| lineHeight | number | | -| maxSize | number | | - -Returns: - -`number` - diff --git a/docs/sources/packages_api/ui/calltoactioncard.md b/docs/sources/packages_api/ui/calltoactioncard.md deleted file mode 100644 index 77af50a10b3..00000000000 --- a/docs/sources/packages_api/ui/calltoactioncard.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CallToActionCard" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CallToActionCard variable - -### CallToActionCard variable - -Signature - -```typescript -CallToActionCard: React.FunctionComponent -``` -Import - -```typescript -import { CallToActionCard } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/cascader.md b/docs/sources/packages_api/ui/cascader.md deleted file mode 100644 index f00a8f402fe..00000000000 --- a/docs/sources/packages_api/ui/cascader.md +++ /dev/null @@ -1,152 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Cascader" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Cascader class - -Signature - -```typescript -export declare class Cascader extends React.PureComponent -``` -Import - -```typescript -import { Cascader } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the Cascader class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [flattenOptions](#flattenoptions-property) | | (options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue<string[]>[] | | -| [onBlur](#onblur-property) | | () => void | | -| [onBlurCascade](#onblurcascade-property) | | () => void | | -| [onChange](#onchange-property) | | (value: string[], selectedOptions: CascaderOption[]) => void | | -| [onCreateOption](#oncreateoption-property) | | (value: string) => void | | -| [onInputKeyDown](#oninputkeydown-property) | | (e: React.KeyboardEvent<HTMLInputElement>) => void | | -| [onSelect](#onselect-property) | | (obj: SelectableValue<string[]>) => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | -| [setInitialValue(searchableOptions, initValue)](#setinitialvalue-method) | | | - -### constructor(props) - -Constructs a new instance of the `Cascader` class - -Signature - -```typescript -constructor(props: CascaderProps); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | CascaderProps | | - -### flattenOptions property - -Signature - -```typescript -flattenOptions: (options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue[]; -``` - -### onBlur property - -Signature - -```typescript -onBlur: () => void; -``` - -### onBlurCascade property - -Signature - -```typescript -onBlurCascade: () => void; -``` - -### onChange property - -Signature - -```typescript -onChange: (value: string[], selectedOptions: CascaderOption[]) => void; -``` - -### onCreateOption property - -Signature - -```typescript -onCreateOption: (value: string) => void; -``` - -### onInputKeyDown property - -Signature - -```typescript -onInputKeyDown: (e: React.KeyboardEvent) => void; -``` - -### onSelect property - -Signature - -```typescript -onSelect: (obj: SelectableValue) => void; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - -### setInitialValue method - -Signature - -```typescript -setInitialValue(searchableOptions: Array>, initValue?: string): { - rcValue: string[]; - activeLabel: any; - }; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| searchableOptions | Array<SelectableValue<string[]>> | | -| initValue | string | | - -Returns: - -`{ - rcValue: string[]; - activeLabel: any; - }` - diff --git a/docs/sources/packages_api/ui/cascaderoption.md b/docs/sources/packages_api/ui/cascaderoption.md deleted file mode 100644 index 25323f2f72c..00000000000 --- a/docs/sources/packages_api/ui/cascaderoption.md +++ /dev/null @@ -1,89 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CascaderOption" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CascaderOption interface - -Signature - -```typescript -export interface CascaderOption -``` -Import - -```typescript -import { CascaderOption } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [children](#children-property) | CascaderOption[] | Children will be shown in a submenu. Use 'items' instead, as 'children' exist to ensure backwards compatibility. | -| [disabled](#disabled-property) | boolean | | -| [items](#items-property) | CascaderOption[] | Items will be just flattened into the main list of items recursively. | -| [label](#label-property) | string | The label to display in the UI | -| [title](#title-property) | string | Avoid using | -| [value](#value-property) | any | The value used under the hood | - -### children property - -Children will be shown in a submenu. Use 'items' instead, as 'children' exist to ensure backwards compatibility. - -Signature - -```typescript -children?: CascaderOption[]; -``` - -### disabled property - -Signature - -```typescript -disabled?: boolean; -``` - -### items property - -Items will be just flattened into the main list of items recursively. - -Signature - -```typescript -items?: CascaderOption[]; -``` - -### label property - -The label to display in the UI - -Signature - -```typescript -label: string; -``` - -### title property - -Avoid using - -Signature - -```typescript -title?: string; -``` - -### value property - -The value used under the hood - -Signature - -```typescript -value: any; -``` diff --git a/docs/sources/packages_api/ui/chart.md b/docs/sources/packages_api/ui/chart.md deleted file mode 100644 index d5ea1dad169..00000000000 --- a/docs/sources/packages_api/ui/chart.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Chart" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Chart variable - -### Chart variable - -Signature - -```typescript -Chart: { - Tooltip: import("react").FC; -} -``` -Import - -```typescript -import { Chart } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/checkbox.md b/docs/sources/packages_api/ui/checkbox.md deleted file mode 100644 index 3dd8fd24fae..00000000000 --- a/docs/sources/packages_api/ui/checkbox.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Checkbox" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Checkbox variable - -### Checkbox variable - -Signature - -```typescript -Checkbox: React.ForwardRefExoticComponent & React.RefAttributes> -``` -Import - -```typescript -import { Checkbox } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/clearplugin.md b/docs/sources/packages_api/ui/clearplugin.md deleted file mode 100644 index 3a11627ad16..00000000000 --- a/docs/sources/packages_api/ui/clearplugin.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ClearPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ClearPlugin() function - -### ClearPlugin() function - -Signature - -```typescript -export declare function ClearPlugin(): Plugin; -``` -Import - -```typescript -import { ClearPlugin } from '@grafana/ui'; -``` -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/clickoutsidewrapper.md b/docs/sources/packages_api/ui/clickoutsidewrapper.md deleted file mode 100644 index 74630f958b4..00000000000 --- a/docs/sources/packages_api/ui/clickoutsidewrapper.md +++ /dev/null @@ -1,98 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ClickOutsideWrapper" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ClickOutsideWrapper class - -Signature - -```typescript -export declare class ClickOutsideWrapper extends PureComponent -``` -Import - -```typescript -import { ClickOutsideWrapper } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | {
includeButtonPress: boolean;
} | | -| [onOutsideClick](#onoutsideclick-property) | | (event: any) => void | | -| [state](#state-property) | | {
hasEventListener: boolean;
} | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentWillUnmount()](#componentwillunmount-method) | | | -| [render()](#render-method) | | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: { - includeButtonPress: boolean; - }; -``` - -### onOutsideClick property - -Signature - -```typescript -onOutsideClick: (event: any) => void; -``` - -### state property - -Signature - -```typescript -state: { - hasEventListener: boolean; - }; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentWillUnmount method - -Signature - -```typescript -componentWillUnmount(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): import("react").ReactNode; -``` -Returns: - -`import("react").ReactNode` - diff --git a/docs/sources/packages_api/ui/clipboardbutton.md b/docs/sources/packages_api/ui/clipboardbutton.md deleted file mode 100644 index 9ef29483655..00000000000 --- a/docs/sources/packages_api/ui/clipboardbutton.md +++ /dev/null @@ -1,76 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ClipboardButton" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ClipboardButton class - -Signature - -```typescript -export declare class ClipboardButton extends PureComponent -``` -Import - -```typescript -import { ClipboardButton } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [setRef](#setref-property) | | (elem: HTMLButtonElement) => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentWillUnmount()](#componentwillunmount-method) | | | -| [render()](#render-method) | | | - -### setRef property - -Signature - -```typescript -setRef: (elem: HTMLButtonElement) => void; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentWillUnmount method - -Signature - -```typescript -componentWillUnmount(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/clipboardplugin.md b/docs/sources/packages_api/ui/clipboardplugin.md deleted file mode 100644 index d3d714671ea..00000000000 --- a/docs/sources/packages_api/ui/clipboardplugin.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ClipboardPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ClipboardPlugin() function - -### ClipboardPlugin() function - -Signature - -```typescript -export declare function ClipboardPlugin(): Plugin; -``` -Import - -```typescript -import { ClipboardPlugin } from '@grafana/ui'; -``` -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/codeeditor.md b/docs/sources/packages_api/ui/codeeditor.md deleted file mode 100644 index 7efd1c8f599..00000000000 --- a/docs/sources/packages_api/ui/codeeditor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CodeEditor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CodeEditor variable - -### CodeEditor variable - -Signature - -```typescript -CodeEditor: React.FC -``` -Import - -```typescript -import { CodeEditor } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/collapse.md b/docs/sources/packages_api/ui/collapse.md deleted file mode 100644 index 2e03693fa04..00000000000 --- a/docs/sources/packages_api/ui/collapse.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Collapse" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Collapse variable - -### Collapse variable - -Signature - -```typescript -Collapse: FunctionComponent -``` -Import - -```typescript -import { Collapse } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/colorpicker.md b/docs/sources/packages_api/ui/colorpicker.md deleted file mode 100644 index 9db04b5efbb..00000000000 --- a/docs/sources/packages_api/ui/colorpicker.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ColorPicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ColorPicker variable - -### ColorPicker variable - -Signature - -```typescript -ColorPicker: React.FunctionComponent & { - children?: ColorPickerTriggerRenderer | undefined; -}, "color" | "onChange" | "children" | "onColorChange" | "enableNamedColors" | "customPickers" | "updatePopperPosition">> -``` -Import - -```typescript -import { ColorPicker } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/colors.md b/docs/sources/packages_api/ui/colors.md deleted file mode 100644 index 5c5f9620751..00000000000 --- a/docs/sources/packages_api/ui/colors.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "colors" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## colors variable - -### colors variable - -Signature - -```typescript -colors: string[] -``` -Import - -```typescript -import { colors } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/completionitem.md b/docs/sources/packages_api/ui/completionitem.md deleted file mode 100644 index 363d1ff7cd2..00000000000 --- a/docs/sources/packages_api/ui/completionitem.md +++ /dev/null @@ -1,124 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CompletionItem" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CompletionItem interface - -Signature - -```typescript -export interface CompletionItem -``` -Import - -```typescript -import { CompletionItem } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deleteBackwards](#deletebackwards-property) | number | Delete number of characters before the caret position, by default the letters from the beginning of the word. | -| [detail](#detail-property) | string | A human-readable string with additional information about this item, like type or symbol information. | -| [documentation](#documentation-property) | string | A human-readable string, can be Markdown, that represents a doc-comment. | -| [filterText](#filtertext-property) | string | A string that should be used when filtering a set of completion items. When falsy the label is used. | -| [insertText](#inserttext-property) | string | A string or snippet that should be inserted in a document when selecting this completion. When falsy the label is used. | -| [kind](#kind-property) | CompletionItemKind | string | The kind of this completion item. An icon is chosen by the editor based on the kind. | -| [label](#label-property) | string | The label of this completion item. By default this is also the text that is inserted when selecting this completion. | -| [move](#move-property) | number | Number of steps to move after the insertion, can be negative. | -| [sortText](#sorttext-property) | string | A string that should be used when comparing this item with other items. When falsy the label is used. | - -### deleteBackwards property - -Delete number of characters before the caret position, by default the letters from the beginning of the word. - -Signature - -```typescript -deleteBackwards?: number; -``` - -### detail property - -A human-readable string with additional information about this item, like type or symbol information. - -Signature - -```typescript -detail?: string; -``` - -### documentation property - -A human-readable string, can be Markdown, that represents a doc-comment. - -Signature - -```typescript -documentation?: string; -``` - -### filterText property - -A string that should be used when filtering a set of completion items. When `falsy` the `label` is used. - -Signature - -```typescript -filterText?: string; -``` - -### insertText property - -A string or snippet that should be inserted in a document when selecting this completion. When `falsy` the `label` is used. - -Signature - -```typescript -insertText?: string; -``` - -### kind property - -The kind of this completion item. An icon is chosen by the editor based on the kind. - -Signature - -```typescript -kind?: CompletionItemKind | string; -``` - -### label property - -The label of this completion item. By default this is also the text that is inserted when selecting this completion. - -Signature - -```typescript -label: string; -``` - -### move property - -Number of steps to move after the insertion, can be negative. - -Signature - -```typescript -move?: number; -``` - -### sortText property - -A string that should be used when comparing this item with other items. When `falsy` the `label` is used. - -Signature - -```typescript -sortText?: string; -``` diff --git a/docs/sources/packages_api/ui/completionitemgroup.md b/docs/sources/packages_api/ui/completionitemgroup.md deleted file mode 100644 index 570d8e6bc85..00000000000 --- a/docs/sources/packages_api/ui/completionitemgroup.md +++ /dev/null @@ -1,80 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CompletionItemGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CompletionItemGroup interface - -Signature - -```typescript -export interface CompletionItemGroup -``` -Import - -```typescript -import { CompletionItemGroup } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [items](#items-property) | CompletionItem[] | List of suggestions of this group. | -| [label](#label-property) | string | Label that will be displayed for all entries of this group. | -| [prefixMatch](#prefixmatch-property) | boolean | If true, match only by prefix (and not mid-word). | -| [skipFilter](#skipfilter-property) | boolean | If true, do not filter items in this group based on the search. | -| [skipSort](#skipsort-property) | boolean | If true, do not sort items. | - -### items property - -List of suggestions of this group. - -Signature - -```typescript -items: CompletionItem[]; -``` - -### label property - -Label that will be displayed for all entries of this group. - -Signature - -```typescript -label: string; -``` - -### prefixMatch property - -If true, match only by prefix (and not mid-word). - -Signature - -```typescript -prefixMatch?: boolean; -``` - -### skipFilter property - -If true, do not filter items in this group based on the search. - -Signature - -```typescript -skipFilter?: boolean; -``` - -### skipSort property - -If true, do not sort items. - -Signature - -```typescript -skipSort?: boolean; -``` diff --git a/docs/sources/packages_api/ui/completionitemkind.md b/docs/sources/packages_api/ui/completionitemkind.md deleted file mode 100644 index ec57744b5b3..00000000000 --- a/docs/sources/packages_api/ui/completionitemkind.md +++ /dev/null @@ -1,30 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CompletionItemKind" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CompletionItemKind enum - -### CompletionItemKind enum - -Signature - -```typescript -export declare enum CompletionItemKind -``` -Import - -```typescript -import { CompletionItemKind } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| GroupTitle | "GroupTitle" | | - diff --git a/docs/sources/packages_api/ui/confirmbutton.md b/docs/sources/packages_api/ui/confirmbutton.md deleted file mode 100644 index 0a80ee544d5..00000000000 --- a/docs/sources/packages_api/ui/confirmbutton.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ConfirmButton" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ConfirmButton variable - -### ConfirmButton variable - -Signature - -```typescript -ConfirmButton: React.FunctionComponent> -``` -Import - -```typescript -import { ConfirmButton } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/confirmmodal.md b/docs/sources/packages_api/ui/confirmmodal.md deleted file mode 100644 index 2f435984741..00000000000 --- a/docs/sources/packages_api/ui/confirmmodal.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ConfirmModal" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ConfirmModal variable - -### ConfirmModal variable - -Signature - -```typescript -ConfirmModal: FC -``` -Import - -```typescript -import { ConfirmModal } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/container.md b/docs/sources/packages_api/ui/container.md deleted file mode 100644 index 33497ade431..00000000000 --- a/docs/sources/packages_api/ui/container.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Container" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Container variable - -### Container variable - -Signature - -```typescript -Container: React.FC -``` -Import - -```typescript -import { Container } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/contextmenu.md b/docs/sources/packages_api/ui/contextmenu.md deleted file mode 100644 index ee22d4077a0..00000000000 --- a/docs/sources/packages_api/ui/contextmenu.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ContextMenu" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ContextMenu variable - -### ContextMenu variable - -Signature - -```typescript -ContextMenu: React.FC -``` -Import - -```typescript -import { ContextMenu } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/contextmenugroup.md b/docs/sources/packages_api/ui/contextmenugroup.md deleted file mode 100644 index ed3dcd71e15..00000000000 --- a/docs/sources/packages_api/ui/contextmenugroup.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ContextMenuGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ContextMenuGroup interface - -Signature - -```typescript -export interface ContextMenuGroup -``` -Import - -```typescript -import { ContextMenuGroup } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [items](#items-property) | ContextMenuItem[] | | -| [label](#label-property) | string | | - -### items property - -Signature - -```typescript -items: ContextMenuItem[]; -``` - -### label property - -Signature - -```typescript -label?: string; -``` diff --git a/docs/sources/packages_api/ui/contextmenuitem.md b/docs/sources/packages_api/ui/contextmenuitem.md deleted file mode 100644 index ca8cd2d59f0..00000000000 --- a/docs/sources/packages_api/ui/contextmenuitem.md +++ /dev/null @@ -1,79 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ContextMenuItem" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ContextMenuItem interface - -Signature - -```typescript -export interface ContextMenuItem -``` -Import - -```typescript -import { ContextMenuItem } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [group](#group-property) | string | | -| [icon](#icon-property) | string | | -| [label](#label-property) | string | | -| [onClick](#onclick-property) | (event?: React.SyntheticEvent<HTMLElement>) => void | | -| [target](#target-property) | LinkTarget | | -| [url](#url-property) | string | | - -### group property - -Signature - -```typescript -group?: string; -``` - -### icon property - -Signature - -```typescript -icon?: string; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### onClick property - -Signature - -```typescript -onClick?: (event?: React.SyntheticEvent) => void; -``` - -### target property - -Signature - -```typescript -target?: LinkTarget; -``` - -### url property - -Signature - -```typescript -url?: string; -``` diff --git a/docs/sources/packages_api/ui/contextmenuprops.md b/docs/sources/packages_api/ui/contextmenuprops.md deleted file mode 100644 index dd90a73e7c6..00000000000 --- a/docs/sources/packages_api/ui/contextmenuprops.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ContextMenuProps" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ContextMenuProps interface - -Signature - -```typescript -export interface ContextMenuProps -``` -Import - -```typescript -import { ContextMenuProps } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [items](#items-property) | ContextMenuGroup[] | | -| [onClose](#onclose-property) | () => void | | -| [renderHeader](#renderheader-property) | () => React.ReactNode | | -| [x](#x-property) | number | | -| [y](#y-property) | number | | - -### items property - -Signature - -```typescript -items?: ContextMenuGroup[]; -``` - -### onClose property - -Signature - -```typescript -onClose: () => void; -``` - -### renderHeader property - -Signature - -```typescript -renderHeader?: () => React.ReactNode; -``` - -### x property - -Signature - -```typescript -x: number; -``` - -### y property - -Signature - -```typescript -y: number; -``` diff --git a/docs/sources/packages_api/ui/controlledcollapse.md b/docs/sources/packages_api/ui/controlledcollapse.md deleted file mode 100644 index 9bee307469e..00000000000 --- a/docs/sources/packages_api/ui/controlledcollapse.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ControlledCollapse" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ControlledCollapse variable - -### ControlledCollapse variable - -Signature - -```typescript -ControlledCollapse: FunctionComponent -``` -Import - -```typescript -import { ControlledCollapse } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/convertoldangularvaluemapping.md b/docs/sources/packages_api/ui/convertoldangularvaluemapping.md deleted file mode 100644 index ac3942047a2..00000000000 --- a/docs/sources/packages_api/ui/convertoldangularvaluemapping.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "convertOldAngularValueMapping" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## convertOldAngularValueMapping() function - -### convertOldAngularValueMapping() function - -Convert the angular single stat mapping to new react style - -Signature - -```typescript -export declare function convertOldAngularValueMapping(panel: any): ValueMapping[]; -``` -Import - -```typescript -import { convertOldAngularValueMapping } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| panel | any | | - -Returns: - -`ValueMapping[]` - diff --git a/docs/sources/packages_api/ui/counter.md b/docs/sources/packages_api/ui/counter.md deleted file mode 100644 index aa6376c2bd7..00000000000 --- a/docs/sources/packages_api/ui/counter.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Counter" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Counter variable - -### Counter variable - -Signature - -```typescript -Counter: FC -``` -Import - -```typescript -import { Counter } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/customscrollbar.md b/docs/sources/packages_api/ui/customscrollbar.md deleted file mode 100644 index 7120d343257..00000000000 --- a/docs/sources/packages_api/ui/customscrollbar.md +++ /dev/null @@ -1,186 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "CustomScrollbar" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## CustomScrollbar class - -Wraps component into component from `react-custom-scrollbars` - -Signature - -```typescript -export declare class CustomScrollbar extends Component -``` -Import - -```typescript -import { CustomScrollbar } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the CustomScrollbar class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | Partial<Props> | | -| [renderThumb](#renderthumb-property) | | (thumb: 'thumb-horizontal' | 'thumb-vertical', passedProps: any) => JSX.Element | | -| [renderThumbHorizontal](#renderthumbhorizontal-property) | | (passedProps: any) => JSX.Element | | -| [renderThumbVertical](#renderthumbvertical-property) | | (passedProps: any) => JSX.Element | | -| [renderTrack](#rendertrack-property) | | (track: 'track-vertical' | 'track-horizontal', hideTrack: boolean | undefined, passedProps: any) => JSX.Element | | -| [renderTrackHorizontal](#rendertrackhorizontal-property) | | (passedProps: any) => JSX.Element | | -| [renderTrackVertical](#rendertrackvertical-property) | | (passedProps: any) => JSX.Element | | -| [renderView](#renderview-property) | | (passedProps: any) => JSX.Element | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate()](#componentdidupdate-method) | | | -| [render()](#render-method) | | | -| [updateAfterMount()](#updateaftermount-method) | | | -| [updateScroll()](#updatescroll-method) | | | - -### constructor(props) - -Constructs a new instance of the `CustomScrollbar` class - -Signature - -```typescript -constructor(props: Props); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### renderThumb property - -Signature - -```typescript -renderThumb: (thumb: 'thumb-horizontal' | 'thumb-vertical', passedProps: any) => JSX.Element; -``` - -### renderThumbHorizontal property - -Signature - -```typescript -renderThumbHorizontal: (passedProps: any) => JSX.Element; -``` - -### renderThumbVertical property - -Signature - -```typescript -renderThumbVertical: (passedProps: any) => JSX.Element; -``` - -### renderTrack property - -Signature - -```typescript -renderTrack: (track: 'track-vertical' | 'track-horizontal', hideTrack: boolean | undefined, passedProps: any) => JSX.Element; -``` - -### renderTrackHorizontal property - -Signature - -```typescript -renderTrackHorizontal: (passedProps: any) => JSX.Element; -``` - -### renderTrackVertical property - -Signature - -```typescript -renderTrackVertical: (passedProps: any) => JSX.Element; -``` - -### renderView property - -Signature - -```typescript -renderView: (passedProps: any) => JSX.Element; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - -### updateAfterMount method - -Signature - -```typescript -updateAfterMount(): void; -``` -Returns: - -`void` - -### updateScroll method - -Signature - -```typescript -updateScroll(): void; -``` -Returns: - -`void` - diff --git a/docs/sources/packages_api/ui/datalinkinput.md b/docs/sources/packages_api/ui/datalinkinput.md deleted file mode 100644 index c983f8380a0..00000000000 --- a/docs/sources/packages_api/ui/datalinkinput.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLinkInput" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DataLinkInput variable - -### DataLinkInput variable - -Signature - -```typescript -DataLinkInput: React.FC -``` -Import - -```typescript -import { DataLinkInput } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/datalinkscontextmenu.md b/docs/sources/packages_api/ui/datalinkscontextmenu.md deleted file mode 100644 index 26e63ac19ed..00000000000 --- a/docs/sources/packages_api/ui/datalinkscontextmenu.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLinksContextMenu" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DataLinksContextMenu variable - -### DataLinksContextMenu variable - -Signature - -```typescript -DataLinksContextMenu: React.FC -``` -Import - -```typescript -import { DataLinksContextMenu } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/datalinksinlineeditor.md b/docs/sources/packages_api/ui/datalinksinlineeditor.md deleted file mode 100644 index 708d6351082..00000000000 --- a/docs/sources/packages_api/ui/datalinksinlineeditor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataLinksInlineEditor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DataLinksInlineEditor variable - -### DataLinksInlineEditor variable - -Signature - -```typescript -DataLinksInlineEditor: React.FC -``` -Import - -```typescript -import { DataLinksInlineEditor } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/datasourcehttpsettings.md b/docs/sources/packages_api/ui/datasourcehttpsettings.md deleted file mode 100644 index b1caec16b20..00000000000 --- a/docs/sources/packages_api/ui/datasourcehttpsettings.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DataSourceHttpSettings" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DataSourceHttpSettings variable - -### DataSourceHttpSettings variable - -Signature - -```typescript -DataSourceHttpSettings: React.FC -``` -Import - -```typescript -import { DataSourceHttpSettings } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/default_annotation_color.md b/docs/sources/packages_api/ui/default_annotation_color.md deleted file mode 100644 index 0094ff50faa..00000000000 --- a/docs/sources/packages_api/ui/default_annotation_color.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DEFAULT_ANNOTATION_COLOR" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DEFAULT\_ANNOTATION\_COLOR variable - -### DEFAULT\_ANNOTATION\_COLOR variable - -Signature - -```typescript -DEFAULT_ANNOTATION_COLOR = "rgba(0, 211, 255, 1)" -``` -Import - -```typescript -import { DEFAULT_ANNOTATION_COLOR } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/deletebutton.md b/docs/sources/packages_api/ui/deletebutton.md deleted file mode 100644 index c8f2da80fd7..00000000000 --- a/docs/sources/packages_api/ui/deletebutton.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DeleteButton" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DeleteButton variable - -### DeleteButton variable - -Signature - -```typescript -DeleteButton: FC -``` -Import - -```typescript -import { DeleteButton } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/domutil.md b/docs/sources/packages_api/ui/domutil.md deleted file mode 100644 index 4aa35df2a3d..00000000000 --- a/docs/sources/packages_api/ui/domutil.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "DOMUtil" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DOMUtil namespace - -> 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. -> - -### DOMUtil namespace - -Import - -```typescript -import { DOMUtil } from '@grafana/ui'; -``` - -## Functions - -| Function | Description | -| --- | --- | -| [getNextCharacter(global)](./getnextcharacter/) | | -| [getPreviousCousin(node, selector)](./getpreviouscousin/) | | - diff --git a/docs/sources/packages_api/ui/domutil/getnextcharacter.md b/docs/sources/packages_api/ui/domutil/getnextcharacter.md deleted file mode 100644 index ac4d8e2e7c0..00000000000 --- a/docs/sources/packages_api/ui/domutil/getnextcharacter.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getNextCharacter" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DOMUtil.getNextCharacter() function - -### DOMUtil.getNextCharacter() function - -Signature - -```typescript -export declare function getNextCharacter(global?: any): any; -``` -Import - -```typescript -import { DOMUtil } from '@grafana/ui'; -const { getNextCharacter } = DOMUtil; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| global | any | | - -Returns: - -`any` - diff --git a/docs/sources/packages_api/ui/domutil/getpreviouscousin.md b/docs/sources/packages_api/ui/domutil/getpreviouscousin.md deleted file mode 100644 index 5b6e63c47ef..00000000000 --- a/docs/sources/packages_api/ui/domutil/getpreviouscousin.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getPreviousCousin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## DOMUtil.getPreviousCousin() function - -### DOMUtil.getPreviousCousin() function - -Signature - -```typescript -export declare function getPreviousCousin(node: any, selector: string): any; -``` -Import - -```typescript -import { DOMUtil } from '@grafana/ui'; -const { getPreviousCousin } = DOMUtil; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| node | any | | -| selector | string | | - -Returns: - -`any` - diff --git a/docs/sources/packages_api/ui/drawer.md b/docs/sources/packages_api/ui/drawer.md deleted file mode 100644 index 32b290a826b..00000000000 --- a/docs/sources/packages_api/ui/drawer.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Drawer" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Drawer variable - -### Drawer variable - -Signature - -```typescript -Drawer: FC -``` -Import - -```typescript -import { Drawer } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/emptysearchresult.md b/docs/sources/packages_api/ui/emptysearchresult.md deleted file mode 100644 index 0180ee785fe..00000000000 --- a/docs/sources/packages_api/ui/emptysearchresult.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EmptySearchResult" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## EmptySearchResult variable - -### EmptySearchResult variable - -Signature - -```typescript -EmptySearchResult: FC -``` -Import - -```typescript -import { EmptySearchResult } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/errorboundary.md b/docs/sources/packages_api/ui/errorboundary.md deleted file mode 100644 index a3d2b330a46..00000000000 --- a/docs/sources/packages_api/ui/errorboundary.md +++ /dev/null @@ -1,71 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ErrorBoundary" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ErrorBoundary class - -Signature - -```typescript -export declare class ErrorBoundary extends PureComponent -``` -Import - -```typescript -import { ErrorBoundary } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [state](#state-property) | | State | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidCatch(error, errorInfo)](#componentdidcatch-method) | | | -| [render()](#render-method) | | | - -### state property - -Signature - -```typescript -readonly state: State; -``` - -### componentDidCatch method - -Signature - -```typescript -componentDidCatch(error: Error, errorInfo: ErrorInfo): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| errorInfo | ErrorInfo | | - -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): React.ReactNode; -``` -Returns: - -`React.ReactNode` - diff --git a/docs/sources/packages_api/ui/errorboundaryalert.md b/docs/sources/packages_api/ui/errorboundaryalert.md deleted file mode 100644 index 56208be95dc..00000000000 --- a/docs/sources/packages_api/ui/errorboundaryalert.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ErrorBoundaryAlert" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ErrorBoundaryAlert class - -Signature - -```typescript -export declare class ErrorBoundaryAlert extends PureComponent -``` -Import - -```typescript -import { ErrorBoundaryAlert } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | Partial<WithAlertBoxProps> | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/errorwithstack.md b/docs/sources/packages_api/ui/errorwithstack.md deleted file mode 100644 index dea6d37da99..00000000000 --- a/docs/sources/packages_api/ui/errorwithstack.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ErrorWithStack" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ErrorWithStack variable - -### ErrorWithStack variable - -Signature - -```typescript -ErrorWithStack: FunctionComponent -``` -Import - -```typescript -import { ErrorWithStack } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/eventswithvalidation.md b/docs/sources/packages_api/ui/eventswithvalidation.md deleted file mode 100644 index 6c4c03937a2..00000000000 --- a/docs/sources/packages_api/ui/eventswithvalidation.md +++ /dev/null @@ -1,32 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "EventsWithValidation" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## EventsWithValidation enum - -### EventsWithValidation enum - -Signature - -```typescript -export declare enum EventsWithValidation -``` -Import - -```typescript -import { EventsWithValidation } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| onBlur | "onBlur" | | -| onChange | "onChange" | | -| onFocus | "onFocus" | | - diff --git a/docs/sources/packages_api/ui/fadetransition.md b/docs/sources/packages_api/ui/fadetransition.md deleted file mode 100644 index 95735c6d61d..00000000000 --- a/docs/sources/packages_api/ui/fadetransition.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FadeTransition" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FadeTransition() function - -### FadeTransition() function - -Signature - -```typescript -export declare function FadeTransition(props: Props): JSX.Element; -``` -Import - -```typescript -import { FadeTransition } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/featureinfobox.md b/docs/sources/packages_api/ui/featureinfobox.md deleted file mode 100644 index 12cdee4a972..00000000000 --- a/docs/sources/packages_api/ui/featureinfobox.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FeatureInfoBox" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FeatureInfoBox variable - -### FeatureInfoBox variable - -Signature - -```typescript -FeatureInfoBox: React.MemoExoticComponent>> -``` -Import - -```typescript -import { FeatureInfoBox } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/field.md b/docs/sources/packages_api/ui/field.md deleted file mode 100644 index 187b78509b9..00000000000 --- a/docs/sources/packages_api/ui/field.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Field" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Field variable - -### Field variable - -Signature - -```typescript -Field: React.FC -``` -Import - -```typescript -import { Field } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/fieldconfigitemheadertitle.md b/docs/sources/packages_api/ui/fieldconfigitemheadertitle.md deleted file mode 100644 index 51d3ff5160f..00000000000 --- a/docs/sources/packages_api/ui/fieldconfigitemheadertitle.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldConfigItemHeaderTitle" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FieldConfigItemHeaderTitle variable - -### FieldConfigItemHeaderTitle variable - -Signature - -```typescript -FieldConfigItemHeaderTitle: React.FC -``` -Import - -```typescript -import { FieldConfigItemHeaderTitle } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/fieldmatchersui.md b/docs/sources/packages_api/ui/fieldmatchersui.md deleted file mode 100644 index 6e70db021b9..00000000000 --- a/docs/sources/packages_api/ui/fieldmatchersui.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "fieldMatchersUI" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## fieldMatchersUI variable - -### fieldMatchersUI variable - -Signature - -```typescript -fieldMatchersUI: Registry> -``` -Import - -```typescript -import { fieldMatchersUI } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/fieldset.md b/docs/sources/packages_api/ui/fieldset.md deleted file mode 100644 index 3f7353a4bc8..00000000000 --- a/docs/sources/packages_api/ui/fieldset.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FieldSet" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FieldSet variable - -### FieldSet variable - -Signature - -```typescript -FieldSet: FC -``` -Import - -```typescript -import { FieldSet } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/fileupload.md b/docs/sources/packages_api/ui/fileupload.md deleted file mode 100644 index 6d558f77aef..00000000000 --- a/docs/sources/packages_api/ui/fileupload.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FileUpload" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FileUpload variable - -### FileUpload variable - -Signature - -```typescript -FileUpload: FC -``` -Import - -```typescript -import { FileUpload } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/filterpill.md b/docs/sources/packages_api/ui/filterpill.md deleted file mode 100644 index 437650b8182..00000000000 --- a/docs/sources/packages_api/ui/filterpill.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FilterPill" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FilterPill variable - -### FilterPill variable - -Signature - -```typescript -FilterPill: React.FC -``` -Import - -```typescript -import { FilterPill } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/form.md b/docs/sources/packages_api/ui/form.md deleted file mode 100644 index 42a848e8a84..00000000000 --- a/docs/sources/packages_api/ui/form.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Form" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Form() function - -### Form() function - -Signature - -```typescript -export declare function Form({ defaultValues, onSubmit, validateOnMount, validateFieldsOnMount, children, validateOn, maxWidth, }: FormProps): JSX.Element; -``` -Import - -```typescript -import { Form } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { defaultValues, onSubmit, validateOnMount, validateFieldsOnMount, children, validateOn, maxWidth, } | FormProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/formapi.md b/docs/sources/packages_api/ui/formapi.md deleted file mode 100644 index e77e58470f0..00000000000 --- a/docs/sources/packages_api/ui/formapi.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FormAPI" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FormAPI type - -### FormAPI type - -Signature - -```typescript -export declare type FormAPI = Pick, 'register' | 'errors' | 'control' | 'formState' | 'getValues' | 'watch'>; -``` -Import - -```typescript -import { FormAPI } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/forminputsize.md b/docs/sources/packages_api/ui/forminputsize.md deleted file mode 100644 index 559635ccfef..00000000000 --- a/docs/sources/packages_api/ui/forminputsize.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FormInputSize" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FormInputSize type - -### FormInputSize type - -Signature - -```typescript -export declare type FormInputSize = 'sm' | 'md' | 'lg' | 'auto'; -``` -Import - -```typescript -import { FormInputSize } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/fullwidthbuttoncontainer.md b/docs/sources/packages_api/ui/fullwidthbuttoncontainer.md deleted file mode 100644 index df6caced098..00000000000 --- a/docs/sources/packages_api/ui/fullwidthbuttoncontainer.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "FullWidthButtonContainer" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## FullWidthButtonContainer variable - -### FullWidthButtonContainer variable - -Signature - -```typescript -FullWidthButtonContainer: FC -``` -Import - -```typescript -import { FullWidthButtonContainer } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/gauge.md b/docs/sources/packages_api/ui/gauge.md deleted file mode 100644 index 2481f6af706..00000000000 --- a/docs/sources/packages_api/ui/gauge.md +++ /dev/null @@ -1,142 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Gauge" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Gauge class - -Signature - -```typescript -export declare class Gauge extends PureComponent -``` -Import - -```typescript -import { Gauge } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [canvasElement](#canvaselement-property) | | any | | -| [defaultProps](#defaultprops-property) | static | Partial<Props> | | -| [renderVisualization](#rendervisualization-property) | | () => JSX.Element | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate()](#componentdidupdate-method) | | | -| [draw()](#draw-method) | | | -| [getFontScale(length)](#getfontscale-method) | | | -| [getFormattedThresholds(decimals)](#getformattedthresholds-method) | | | -| [render()](#render-method) | | | - -### canvasElement property - -Signature - -```typescript -canvasElement: any; -``` - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### renderVisualization property - -Signature - -```typescript -renderVisualization: () => JSX.Element; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(): void; -``` -Returns: - -`void` - -### draw method - -Signature - -```typescript -draw(): void; -``` -Returns: - -`void` - -### getFontScale method - -Signature - -```typescript -getFontScale(length: number): number; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| length | number | | - -Returns: - -`number` - -### getFormattedThresholds method - -Signature - -```typescript -getFormattedThresholds(decimals: number): Threshold[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| decimals | number | | - -Returns: - -`Threshold[]` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/getavailableicons.md b/docs/sources/packages_api/ui/getavailableicons.md deleted file mode 100644 index 532aea4b862..00000000000 --- a/docs/sources/packages_api/ui/getavailableicons.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getAvailableIcons" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getAvailableIcons variable - -### getAvailableIcons variable - -Signature - -```typescript -getAvailableIcons: () => IconName[] -``` -Import - -```typescript -import { getAvailableIcons } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/getbuttonstyles.md b/docs/sources/packages_api/ui/getbuttonstyles.md deleted file mode 100644 index 4bdab9a8a1c..00000000000 --- a/docs/sources/packages_api/ui/getbuttonstyles.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getButtonStyles" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getButtonStyles variable - -### getButtonStyles variable - -Signature - -```typescript -getButtonStyles: (props: StyleProps) => { - button: string; - iconButton: string; - iconWrap: string; -} -``` -Import - -```typescript -import { getButtonStyles } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/getformstyles.md b/docs/sources/packages_api/ui/getformstyles.md deleted file mode 100644 index 4b51d39f668..00000000000 --- a/docs/sources/packages_api/ui/getformstyles.md +++ /dev/null @@ -1,67 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getFormStyles" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getFormStyles variable - -### getFormStyles variable - -Signature - -```typescript -getFormStyles: (theme: GrafanaTheme, options: { - variant: ButtonVariant; - size: ComponentSize; - invalid: boolean; -}) => { - label: { - label: string; - labelContent: string; - description: string; - categories: string; - chevron: string; - }; - legend: { - legend: string; - }; - fieldValidationMessage: { - fieldValidationMessage: string; - fieldValidationMessageIcon: string; - }; - button: { - button: string; - iconButton: string; - iconWrap: string; - }; - input: { - wrapper: string; - inputWrapper: string; - input: string; - inputDisabled: string; - addon: string; - prefix: string; - suffix: string; - loadingIndicator: string; - }; - switch: { - switch: string; - }; - checkbox: { - label: string; - description: string; - wrapper: string; - input: string; - checkmark: string; - }; -} -``` -Import - -```typescript -import { getFormStyles } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/getlogrowstyles.md b/docs/sources/packages_api/ui/getlogrowstyles.md deleted file mode 100644 index 761b2f6aab0..00000000000 --- a/docs/sources/packages_api/ui/getlogrowstyles.md +++ /dev/null @@ -1,42 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getLogRowStyles" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getLogRowStyles variable - -### getLogRowStyles variable - -Signature - -```typescript -getLogRowStyles: (theme: GrafanaTheme, logLevel?: LogLevel | undefined) => { - logsRowMatchHighLight: string; - logsRowMatchHighLightPreview: string; - logsRowsTable: string; - logsRowsHorizontalScroll: string; - context: string; - logsRow: string; - logsRowDuplicates: string; - logsRowLevel: string; - logsRowToggleDetails: string; - logsRowLocalTime: string; - logsRowLabels: string; - logsRowMessage: string; - logDetailsContainer: string; - logDetailsTable: string; - logsDetailsIcon: string; - logDetailsLabel: string; - logDetailsHeading: string; - logDetailsValue: string; -} -``` -Import - -```typescript -import { getLogRowStyles } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/getscrollbarwidth.md b/docs/sources/packages_api/ui/getscrollbarwidth.md deleted file mode 100644 index 5cd181acae8..00000000000 --- a/docs/sources/packages_api/ui/getscrollbarwidth.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getScrollbarWidth" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getScrollbarWidth() function - -### getScrollbarWidth() function - -Signature - -```typescript -export declare function getScrollbarWidth(): number; -``` -Import - -```typescript -import { getScrollbarWidth } from '@grafana/ui'; -``` -Returns: - -`number` - diff --git a/docs/sources/packages_api/ui/getstandardfieldconfigs.md b/docs/sources/packages_api/ui/getstandardfieldconfigs.md deleted file mode 100644 index 0c596738799..00000000000 --- a/docs/sources/packages_api/ui/getstandardfieldconfigs.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getStandardFieldConfigs" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getStandardFieldConfigs variable - -### getStandardFieldConfigs variable - -Returns collection of common field config properties definitions - -Signature - -```typescript -getStandardFieldConfigs: () => (FieldConfigPropertyItem | FieldConfigPropertyItem | FieldConfigPropertyItem | FieldConfigPropertyItem | FieldConfigPropertyItem[], StringFieldConfigSettings>)[] -``` -Import - -```typescript -import { getStandardFieldConfigs } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/getstandardoptioneditors.md b/docs/sources/packages_api/ui/getstandardoptioneditors.md deleted file mode 100644 index 5911af675d6..00000000000 --- a/docs/sources/packages_api/ui/getstandardoptioneditors.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getStandardOptionEditors" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getStandardOptionEditors variable - -### getStandardOptionEditors variable - -Returns collection of standard option editors definitions - -Signature - -```typescript -getStandardOptionEditors: () => (StandardEditorsRegistryItem | StandardEditorsRegistryItem | StandardEditorsRegistryItem | StandardEditorsRegistryItem | StandardEditorsRegistryItem | StandardEditorsRegistryItem | StandardEditorsRegistryItem[], any> | StandardEditorsRegistryItem)[] -``` -Import - -```typescript -import { getStandardOptionEditors } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/gettagcolor.md b/docs/sources/packages_api/ui/gettagcolor.md deleted file mode 100644 index 40589494282..00000000000 --- a/docs/sources/packages_api/ui/gettagcolor.md +++ /dev/null @@ -1,39 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTagColor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getTagColor() function - -### getTagColor() function - -Signature - -```typescript -export declare function getTagColor(index: number): { - color: string; - borderColor: string; -}; -``` -Import - -```typescript -import { getTagColor } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -`{ - color: string; - borderColor: string; -}` - diff --git a/docs/sources/packages_api/ui/gettagcolorsfromname.md b/docs/sources/packages_api/ui/gettagcolorsfromname.md deleted file mode 100644 index d95be15e266..00000000000 --- a/docs/sources/packages_api/ui/gettagcolorsfromname.md +++ /dev/null @@ -1,41 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTagColorsFromName" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getTagColorsFromName() function - -### getTagColorsFromName() function - -Returns tag badge background and border colors based on hashed tag name. - -Signature - -```typescript -export declare function getTagColorsFromName(name?: string): { - color: string; - borderColor: string; -}; -``` -Import - -```typescript -import { getTagColorsFromName } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | tag name | - -Returns: - -`{ - color: string; - borderColor: string; -}` - diff --git a/docs/sources/packages_api/ui/gettheme.md b/docs/sources/packages_api/ui/gettheme.md deleted file mode 100644 index 5f1808aec54..00000000000 --- a/docs/sources/packages_api/ui/gettheme.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "getTheme" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## getTheme variable - -### getTheme variable - -Signature - -```typescript -getTheme: (name?: string | undefined) => GrafanaTheme -``` -Import - -```typescript -import { getTheme } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/graph.md b/docs/sources/packages_api/ui/graph.md deleted file mode 100644 index 146b43be684..00000000000 --- a/docs/sources/packages_api/ui/graph.md +++ /dev/null @@ -1,237 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Graph" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Graph class - -Signature - -```typescript -export declare class Graph extends PureComponent -``` -Import - -```typescript -import { Graph } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [$element](#_element-property) | | any | | -| [defaultProps](#defaultprops-property) | static | {
showLines: boolean;
showPoints: boolean;
showBars: boolean;
isStacked: boolean;
lineWidth: number;
} | | -| [element](#element-property) | | HTMLElement | null | | -| [getBarWidth](#getbarwidth-property) | | () => number | | -| [onPlotClick](#onplotclick-property) | | (event: JQueryEventObject, contextPos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void | | -| [onPlotHover](#onplothover-property) | | (event: JQueryEventObject, pos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void | | -| [onPlotSelected](#onplotselected-property) | | (event: JQueryEventObject, ranges: {
xaxis: {
from: number;
to: number;
};
}) => void | | -| [renderContextMenu](#rendercontextmenu-property) | | () => JSX.Element | null | | -| [renderTooltip](#rendertooltip-property) | | () => React.ReactElement<TooltipProps, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null | | -| [state](#state-property) | | GraphState | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate(prevProps, prevState)](#componentdidupdate-method) | | | -| [componentWillUnmount()](#componentwillunmount-method) | | | -| [draw()](#draw-method) | | | -| [getYAxes(series)](#getyaxes-method) | | | -| [render()](#render-method) | | | - -### $element property - -Signature - -```typescript -$element: any; -``` - -### defaultProps property - -Signature - -```typescript -static defaultProps: { - showLines: boolean; - showPoints: boolean; - showBars: boolean; - isStacked: boolean; - lineWidth: number; - }; -``` - -### element property - -Signature - -```typescript -element: HTMLElement | null; -``` - -### getBarWidth property - -Signature - -```typescript -getBarWidth: () => number; -``` - -### onPlotClick property - -Signature - -```typescript -onPlotClick: (event: JQueryEventObject, contextPos: FlotPosition, item?: FlotItem | undefined) => void; -``` - -### onPlotHover property - -Signature - -```typescript -onPlotHover: (event: JQueryEventObject, pos: FlotPosition, item?: FlotItem | undefined) => void; -``` - -### onPlotSelected property - -Signature - -```typescript -onPlotSelected: (event: JQueryEventObject, ranges: { - xaxis: { - from: number; - to: number; - }; - }) => void; -``` - -### renderContextMenu property - -Signature - -```typescript -renderContextMenu: () => JSX.Element | null; -``` - -### renderTooltip property - -Signature - -```typescript -renderTooltip: () => React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | null; -``` - -### state property - -Signature - -```typescript -state: GraphState; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: GraphProps, prevState: GraphState): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | GraphProps | | -| prevState | GraphState | | - -Returns: - -`void` - -### componentWillUnmount method - -Signature - -```typescript -componentWillUnmount(): void; -``` -Returns: - -`void` - -### draw method - -Signature - -```typescript -draw(): void; -``` -Returns: - -`void` - -### getYAxes method - -Signature - -```typescript -getYAxes(series: GraphSeriesXY[]): { - show: boolean; - index: number; - position: string; - min: import("@grafana/data").DecimalCount; - tickDecimals: import("@grafana/data").DecimalCount; - }[] | { - show: boolean; - min: number; - max: number; - }[]; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| series | GraphSeriesXY[] | | - -Returns: - -`{ - show: boolean; - index: number; - position: string; - min: import("@grafana/data").DecimalCount; - tickDecimals: import("@grafana/data").DecimalCount; - }[] | { - show: boolean; - min: number; - max: number; - }[]` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/graphcontextmenu.md b/docs/sources/packages_api/ui/graphcontextmenu.md deleted file mode 100644 index a11234d2c8d..00000000000 --- a/docs/sources/packages_api/ui/graphcontextmenu.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphContextMenu" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## GraphContextMenu variable - -### GraphContextMenu variable - -Signature - -```typescript -GraphContextMenu: React.FC -``` -Import - -```typescript -import { GraphContextMenu } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/graphlegend.md b/docs/sources/packages_api/ui/graphlegend.md deleted file mode 100644 index e151633e79c..00000000000 --- a/docs/sources/packages_api/ui/graphlegend.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphLegend" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## GraphLegend variable - -### GraphLegend variable - -Signature - -```typescript -GraphLegend: React.FunctionComponent -``` -Import - -```typescript -import { GraphLegend } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/graphseriestoggler.md b/docs/sources/packages_api/ui/graphseriestoggler.md deleted file mode 100644 index 2dace4275fb..00000000000 --- a/docs/sources/packages_api/ui/graphseriestoggler.md +++ /dev/null @@ -1,96 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphSeriesToggler" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## GraphSeriesToggler class - -Signature - -```typescript -export declare class GraphSeriesToggler extends React.Component -``` -Import - -```typescript -import { GraphSeriesToggler } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the GraphSeriesToggler class | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidUpdate(prevProps)](#componentdidupdate-method) | | | -| [onSeriesToggle(label, event)](#onseriestoggle-method) | | | -| [render()](#render-method) | | | - -### constructor(props) - -Constructs a new instance of the `GraphSeriesToggler` class - -Signature - -```typescript -constructor(props: GraphSeriesTogglerProps); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | GraphSeriesTogglerProps | | - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: Readonly): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | Readonly<GraphSeriesTogglerProps> | | - -Returns: - -`void` - -### onSeriesToggle method - -Signature - -```typescript -onSeriesToggle(label: string, event: React.MouseEvent): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| label | string | | -| event | React.MouseEvent<HTMLElement> | | - -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/graphseriestogglerapi.md b/docs/sources/packages_api/ui/graphseriestogglerapi.md deleted file mode 100644 index 09fd73f61eb..00000000000 --- a/docs/sources/packages_api/ui/graphseriestogglerapi.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphSeriesTogglerAPI" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## GraphSeriesTogglerAPI interface - -Signature - -```typescript -export interface GraphSeriesTogglerAPI -``` -Import - -```typescript -import { GraphSeriesTogglerAPI } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [onSeriesToggle](#onseriestoggle-property) | (label: string, event: React.MouseEvent<HTMLElement>) => void | | -| [toggledSeries](#toggledseries-property) | GraphSeriesXY[] | | - -### onSeriesToggle property - -Signature - -```typescript -onSeriesToggle: (label: string, event: React.MouseEvent) => void; -``` - -### toggledSeries property - -Signature - -```typescript -toggledSeries: GraphSeriesXY[]; -``` diff --git a/docs/sources/packages_api/ui/graphtickformatter.md b/docs/sources/packages_api/ui/graphtickformatter.md deleted file mode 100644 index 8dd8f0ddc9d..00000000000 --- a/docs/sources/packages_api/ui/graphtickformatter.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "graphTickFormatter" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## graphTickFormatter variable - -### graphTickFormatter variable - -Signature - -```typescript -graphTickFormatter: (epoch: number, axis: any) => string -``` -Import - -```typescript -import { graphTickFormatter } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/graphtimeformat.md b/docs/sources/packages_api/ui/graphtimeformat.md deleted file mode 100644 index cb0ae8162f8..00000000000 --- a/docs/sources/packages_api/ui/graphtimeformat.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "graphTimeFormat" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## graphTimeFormat variable - -### graphTimeFormat variable - -Signature - -```typescript -graphTimeFormat: (ticks: number | null, min: number | null, max: number | null) => string -``` -Import - -```typescript -import { graphTimeFormat } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/graphtooltipoptions.md b/docs/sources/packages_api/ui/graphtooltipoptions.md deleted file mode 100644 index 9b6c84462fb..00000000000 --- a/docs/sources/packages_api/ui/graphtooltipoptions.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphTooltipOptions" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## GraphTooltipOptions interface - -Signature - -```typescript -export interface GraphTooltipOptions -``` -Import - -```typescript -import { GraphTooltipOptions } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [mode](#mode-property) | TooltipMode | | - -### mode property - -Signature - -```typescript -mode: TooltipMode; -``` diff --git a/docs/sources/packages_api/ui/graphwithlegend.md b/docs/sources/packages_api/ui/graphwithlegend.md deleted file mode 100644 index d0c301532a5..00000000000 --- a/docs/sources/packages_api/ui/graphwithlegend.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "GraphWithLegend" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## GraphWithLegend variable - -### GraphWithLegend variable - -Signature - -```typescript -GraphWithLegend: React.FunctionComponent -``` -Import - -```typescript -import { GraphWithLegend } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/hasvalidationevent.md b/docs/sources/packages_api/ui/hasvalidationevent.md deleted file mode 100644 index 395441f6062..00000000000 --- a/docs/sources/packages_api/ui/hasvalidationevent.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "hasValidationEvent" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## hasValidationEvent variable - -### hasValidationEvent variable - -Signature - -```typescript -hasValidationEvent: (event: EventsWithValidation, validationEvents: ValidationEvents | undefined) => ValidationRule[] | undefined -``` -Import - -```typescript -import { hasValidationEvent } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/horizontalgroup.md b/docs/sources/packages_api/ui/horizontalgroup.md deleted file mode 100644 index d32025f63e7..00000000000 --- a/docs/sources/packages_api/ui/horizontalgroup.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "HorizontalGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## HorizontalGroup variable - -### HorizontalGroup variable - -Signature - -```typescript -HorizontalGroup: React.FC> -``` -Import - -```typescript -import { HorizontalGroup } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/icon.md b/docs/sources/packages_api/ui/icon.md deleted file mode 100644 index b2ef4579d32..00000000000 --- a/docs/sources/packages_api/ui/icon.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Icon" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Icon variable - -### Icon variable - -Signature - -```typescript -Icon: React.ForwardRefExoticComponent> -``` -Import - -```typescript -import { Icon } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/iconbutton.md b/docs/sources/packages_api/ui/iconbutton.md deleted file mode 100644 index 3960e28ae6e..00000000000 --- a/docs/sources/packages_api/ui/iconbutton.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "IconButton" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## IconButton variable - -### IconButton variable - -Signature - -```typescript -IconButton: React.ForwardRefExoticComponent> -``` -Import - -```typescript -import { IconButton } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/iconname.md b/docs/sources/packages_api/ui/iconname.md deleted file mode 100644 index 40ecf50cdff..00000000000 --- a/docs/sources/packages_api/ui/iconname.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "IconName" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## IconName type - -### IconName type - -Signature - -```typescript -export declare type IconName = 'fa fa-spinner' | 'grafana' | 'question-circle' | 'angle-up' | 'history' | 'angle-down' | 'filter' | 'angle-left' | 'angle-right' | 'pen' | 'envelope' | 'percentage' | 'rocket' | 'power' | 'trash-alt' | 'slack' | 'download-alt' | 'mobile-android' | 'plus-square' | 'folder-plus' | 'folder-open' | 'folder' | 'file-copy-alt' | 'file-alt' | 'exchange-alt' | 'import' | 'exclamation-triangle' | 'times' | 'signin' | 'cloud-upload' | 'step-backward' | 'square-shape' | 'share-alt' | 'tag-alt' | 'forward' | 'check' | 'check-circle' | 'copy' | 'lock' | 'unlock' | 'panel-add' | 'arrow-random' | 'arrow-down' | 'arrows-h' | 'comment-alt' | 'code-branch' | 'arrow-right' | 'circle' | 'arrow-up' | 'arrow-from-right' | 'keyboard' | 'search' | 'chart-line' | 'search-minus' | 'clock-nine' | 'sync' | 'sign-in-alt' | 'cloud-download' | 'cog' | 'bars' | 'save' | 'apps' | 'link' | 'upload' | 'columns' | 'home-alt' | 'channel-add' | 'calendar-alt' | 'play' | 'pause' | 'calculator-alt' | 'compass' | 'sliders-v-alt' | 'bell' | 'database' | 'user' | 'camera' | 'plug' | 'shield' | 'key-skeleton-alt' | 'users-alt' | 'graph-bar' | 'book' | 'bolt' | 'comments-alt' | 'document-info' | 'info-circle' | 'bug' | 'cube' | 'star' | 'list-ul' | 'edit' | 'eye' | 'eye-slash' | 'monitor' | 'plus-circle' | 'arrow-left' | 'repeat' | 'external-link-alt' | 'minus' | 'signal' | 'search-plus' | 'minus-circle' | 'table' | 'plus' | 'heart' | 'heart-break' | 'ellipsis-v' | 'favorite' | 'line-alt' | 'sort-amount-down' | 'cloud'; -``` -Import - -```typescript -import { IconName } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/iconsize.md b/docs/sources/packages_api/ui/iconsize.md deleted file mode 100644 index 96e4b9456d1..00000000000 --- a/docs/sources/packages_api/ui/iconsize.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "IconSize" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## IconSize type - -### IconSize type - -Signature - -```typescript -export declare type IconSize = ComponentSize | 'xl' | 'xxl' | 'xxxl'; -``` -Import - -```typescript -import { IconSize } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/icontype.md b/docs/sources/packages_api/ui/icontype.md deleted file mode 100644 index ff19a8b8f1e..00000000000 --- a/docs/sources/packages_api/ui/icontype.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "IconType" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## IconType type - -### IconType type - -Signature - -```typescript -export declare type IconType = 'mono' | 'default'; -``` -Import - -```typescript -import { IconType } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/indentationplugin.md b/docs/sources/packages_api/ui/indentationplugin.md deleted file mode 100644 index 103772d0668..00000000000 --- a/docs/sources/packages_api/ui/indentationplugin.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "IndentationPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## IndentationPlugin() function - -### IndentationPlugin() function - -Signature - -```typescript -export declare function IndentationPlugin(): Plugin; -``` -Import - -```typescript -import { IndentationPlugin } from '@grafana/ui'; -``` -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/inlineformlabel.md b/docs/sources/packages_api/ui/inlineformlabel.md deleted file mode 100644 index 62f1a915030..00000000000 --- a/docs/sources/packages_api/ui/inlineformlabel.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "InlineFormLabel" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## InlineFormLabel variable - -### InlineFormLabel variable - -Signature - -```typescript -FormLabel: FunctionComponent -``` -Import - -```typescript -import { InlineFormLabel } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/input.md b/docs/sources/packages_api/ui/input.md deleted file mode 100644 index f26f731b1ff..00000000000 --- a/docs/sources/packages_api/ui/input.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Input" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Input variable - -### Input variable - -Signature - -```typescript -Input: React.ForwardRefExoticComponent & React.RefAttributes> -``` -Import - -```typescript -import { Input } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/jsonexplorer.md b/docs/sources/packages_api/ui/jsonexplorer.md deleted file mode 100644 index c807043d22a..00000000000 --- a/docs/sources/packages_api/ui/jsonexplorer.md +++ /dev/null @@ -1,188 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "JsonExplorer" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## JsonExplorer class - - JsonExplorer - -JsonExplorer allows you to render JSON objects in HTML with a \*\*collapsible\*\* navigation. - -Signature - -```typescript -export declare class JsonExplorer -``` -Import - -```typescript -import { JsonExplorer } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(json, open, config, key)](#constructor-jsonopenconfigkey) | | Constructs a new instance of the JsonExplorer class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [json](#json-property) | | any | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [appendChildren(animated)](#appendchildren-method) | | Appends all the children to children element Animated option is used when user triggers this via a click | -| [isNumberArray()](#isnumberarray-method) | | | -| [openAtDepth(depth)](#openatdepth-method) | | Open all children up to a certain depth. Allows actions such as expand all/collapse all | -| [removeChildren(animated)](#removechildren-method) | | Removes all the children from children element Animated option is used when user triggers this via a click | -| [render(skipRoot)](#render-method) | | Renders an HTML element and installs event listeners | -| [renderArray()](#renderarray-method) | | | -| [toggleOpen()](#toggleopen-method) | | Toggles isOpen state | - -### constructor(json, open, config, key) - -Constructs a new instance of the `JsonExplorer` class - -Signature - -```typescript -constructor(json: any, open?: number, config?: JsonExplorerConfig, key?: string | undefined); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| json | any | The JSON object you want to render. It has to be an object or array. Do NOT pass raw JSON string. | -| open | number | his number indicates up to how many levels the rendered tree should expand. Set it to 0 to make the whole tree collapsed or set it to Infinity to expand the tree deeply | -| config | JsonExplorerConfig | defaultConfig = { hoverPreviewEnabled: false, hoverPreviewArrayCount: 100, hoverPreviewFieldCount: 5 }Available configurations: \#\#\#\#\#Hover Preview \* hoverPreviewEnabled: enable preview on hover \* hoverPreviewArrayCount: number of array items to show in preview Any array larger than this number will be shown as Array[XXX] where XXX is length of the array. \* hoverPreviewFieldCount: number of object properties to show for object preview. Any object with more properties that thin number will be truncated. | -| key | string | undefined | The key that this object in it's parent context | - -### json property - -Signature - -```typescript -json: any; -``` - -### appendChildren method - -Appends all the children to children element Animated option is used when user triggers this via a click - -Signature - -```typescript -appendChildren(animated?: boolean): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| animated | boolean | | - -Returns: - -`void` - -### isNumberArray method - -Signature - -```typescript -isNumberArray(): boolean; -``` -Returns: - -`boolean` - -### openAtDepth method - -Open all children up to a certain depth. Allows actions such as expand all/collapse all - -Signature - -```typescript -openAtDepth(depth?: number): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| depth | number | | - -Returns: - -`void` - -### removeChildren method - -Removes all the children from children element Animated option is used when user triggers this via a click - -Signature - -```typescript -removeChildren(animated?: boolean): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| animated | boolean | | - -Returns: - -`void` - -### render method - -Renders an HTML element and installs event listeners - -Signature - -```typescript -render(skipRoot?: boolean): HTMLDivElement; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| skipRoot | boolean | | - -Returns: - -`HTMLDivElement` - -{HTMLDivElement} - -### renderArray method - -Signature - -```typescript -renderArray(): Element; -``` -Returns: - -`Element` - -### toggleOpen method - -Toggles `isOpen` state - -Signature - -```typescript -toggleOpen(): void; -``` -Returns: - -`void` - diff --git a/docs/sources/packages_api/ui/jsonformatter.md b/docs/sources/packages_api/ui/jsonformatter.md deleted file mode 100644 index 91e9a338169..00000000000 --- a/docs/sources/packages_api/ui/jsonformatter.md +++ /dev/null @@ -1,90 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "JSONFormatter" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## JSONFormatter class - -Signature - -```typescript -export declare class JSONFormatter extends PureComponent -``` -Import - -```typescript -import { JSONFormatter } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | {
open: number;
config: {
animateOpen: boolean;
};
} | | -| [renderJson](#renderjson-property) | | () => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate()](#componentdidupdate-method) | | | -| [render()](#render-method) | | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: { - open: number; - config: { - animateOpen: boolean; - }; - }; -``` - -### renderJson property - -Signature - -```typescript -renderJson: () => void; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/label.md b/docs/sources/packages_api/ui/label.md deleted file mode 100644 index 31a5bee1366..00000000000 --- a/docs/sources/packages_api/ui/label.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Label" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Label variable - -### Label variable - -Signature - -```typescript -Label: React.FC -``` -Import - -```typescript -import { Label } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/legacyforms.md b/docs/sources/packages_api/ui/legacyforms.md deleted file mode 100644 index d0d2c040bc2..00000000000 --- a/docs/sources/packages_api/ui/legacyforms.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegacyForms" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegacyForms variable - -### LegacyForms variable - -Signature - -```typescript -LegacyForms: { - SecretFormField: import("react").FunctionComponent; - FormField: import("react").FunctionComponent; - Select: typeof Select; - AsyncSelect: typeof AsyncSelect; - IndicatorsContainer: (props: any) => JSX.Element; - NoOptionsMessage: (props: any) => JSX.Element; - ButtonSelect: typeof ButtonSelect; - Input: typeof Input; - Switch: typeof Switch; -} -``` -Import - -```typescript -import { LegacyForms } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/legacyinputstatus.md b/docs/sources/packages_api/ui/legacyinputstatus.md deleted file mode 100644 index 18e0aab5f44..00000000000 --- a/docs/sources/packages_api/ui/legacyinputstatus.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegacyInputStatus" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegacyInputStatus enum - -### LegacyInputStatus enum - -Signature - -```typescript -export declare enum LegacyInputStatus -``` -Import - -```typescript -import { LegacyInputStatus } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Invalid | "invalid" | | -| Valid | "valid" | | - diff --git a/docs/sources/packages_api/ui/legend.md b/docs/sources/packages_api/ui/legend.md deleted file mode 100644 index 17daa08e140..00000000000 --- a/docs/sources/packages_api/ui/legend.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Legend" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Legend variable - -### Legend variable - -Signature - -```typescript -Legend: React.FC -``` -Import - -```typescript -import { Legend } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/legendbasicoptions.md b/docs/sources/packages_api/ui/legendbasicoptions.md deleted file mode 100644 index 78e12720587..00000000000 --- a/docs/sources/packages_api/ui/legendbasicoptions.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendBasicOptions" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendBasicOptions interface - -Signature - -```typescript -export interface LegendBasicOptions -``` -Import - -```typescript -import { LegendBasicOptions } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asTable](#astable-property) | boolean | | -| [isVisible](#isvisible-property) | boolean | | - -### asTable property - -Signature - -```typescript -asTable: boolean; -``` - -### isVisible property - -Signature - -```typescript -isVisible: boolean; -``` diff --git a/docs/sources/packages_api/ui/legenddisplaymode.md b/docs/sources/packages_api/ui/legenddisplaymode.md deleted file mode 100644 index 0d730d14139..00000000000 --- a/docs/sources/packages_api/ui/legenddisplaymode.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendDisplayMode" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendDisplayMode enum - -### LegendDisplayMode enum - -Signature - -```typescript -export declare enum LegendDisplayMode -``` -Import - -```typescript -import { LegendDisplayMode } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| List | "list" | | -| Table | "table" | | - diff --git a/docs/sources/packages_api/ui/legenditem.md b/docs/sources/packages_api/ui/legenditem.md deleted file mode 100644 index f2ab44958c7..00000000000 --- a/docs/sources/packages_api/ui/legenditem.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendItem" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendItem interface - -Signature - -```typescript -export interface LegendItem -``` -Import - -```typescript -import { LegendItem } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [color](#color-property) | string | | -| [displayValues](#displayvalues-property) | DisplayValue[] | | -| [isVisible](#isvisible-property) | boolean | | -| [label](#label-property) | string | | -| [yAxis](#yaxis-property) | number | | - -### color property - -Signature - -```typescript -color: string; -``` - -### displayValues property - -Signature - -```typescript -displayValues?: DisplayValue[]; -``` - -### isVisible property - -Signature - -```typescript -isVisible: boolean; -``` - -### label property - -Signature - -```typescript -label: string; -``` - -### yAxis property - -Signature - -```typescript -yAxis: number; -``` diff --git a/docs/sources/packages_api/ui/legendlist.md b/docs/sources/packages_api/ui/legendlist.md deleted file mode 100644 index 0d879e15371..00000000000 --- a/docs/sources/packages_api/ui/legendlist.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendList" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendList variable - -### LegendList variable - -Signature - -```typescript -LegendList: React.FunctionComponent -``` -Import - -```typescript -import { LegendList } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/legendoptions.md b/docs/sources/packages_api/ui/legendoptions.md deleted file mode 100644 index a277bdaa4b7..00000000000 --- a/docs/sources/packages_api/ui/legendoptions.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendOptions" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendOptions interface - -Signature - -```typescript -export interface LegendOptions extends LegendBasicOptions, LegendRenderOptions -``` -Import - -```typescript -import { LegendOptions } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/legendplacement.md b/docs/sources/packages_api/ui/legendplacement.md deleted file mode 100644 index d1dbec37e95..00000000000 --- a/docs/sources/packages_api/ui/legendplacement.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendPlacement" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendPlacement type - -### LegendPlacement type - -Signature - -```typescript -export declare type LegendPlacement = 'under' | 'right' | 'over'; -``` -Import - -```typescript -import { LegendPlacement } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/legendrenderoptions.md b/docs/sources/packages_api/ui/legendrenderoptions.md deleted file mode 100644 index 454d2fdb5f0..00000000000 --- a/docs/sources/packages_api/ui/legendrenderoptions.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendRenderOptions" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendRenderOptions interface - -Signature - -```typescript -export interface LegendRenderOptions -``` -Import - -```typescript -import { LegendRenderOptions } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hideEmpty](#hideempty-property) | boolean | | -| [hideZero](#hidezero-property) | boolean | | -| [placement](#placement-property) | LegendPlacement | | - -### hideEmpty property - -Signature - -```typescript -hideEmpty?: boolean; -``` - -### hideZero property - -Signature - -```typescript -hideZero?: boolean; -``` - -### placement property - -Signature - -```typescript -placement: LegendPlacement; -``` diff --git a/docs/sources/packages_api/ui/legendtable.md b/docs/sources/packages_api/ui/legendtable.md deleted file mode 100644 index e80416117ed..00000000000 --- a/docs/sources/packages_api/ui/legendtable.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LegendTable" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LegendTable variable - -### LegendTable variable - -Signature - -```typescript -LegendTable: React.FunctionComponent -``` -Import - -```typescript -import { LegendTable } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/linkbutton.md b/docs/sources/packages_api/ui/linkbutton.md deleted file mode 100644 index 868544d2536..00000000000 --- a/docs/sources/packages_api/ui/linkbutton.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LinkButton" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LinkButton variable - -### LinkButton variable - -Signature - -```typescript -LinkButton: React.ForwardRefExoticComponent & React.AnchorHTMLAttributes & React.RefAttributes> -``` -Import - -```typescript -import { LinkButton } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/linkmodeltocontextmenuitems.md b/docs/sources/packages_api/ui/linkmodeltocontextmenuitems.md deleted file mode 100644 index bddb3ad5716..00000000000 --- a/docs/sources/packages_api/ui/linkmodeltocontextmenuitems.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "linkModelToContextMenuItems" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## linkModelToContextMenuItems variable - -### linkModelToContextMenuItems variable - -Delays creating links until we need to open the ContextMenu - -Signature - -```typescript -linkModelToContextMenuItems: (links: () => LinkModel[]) => ContextMenuItem[] -``` -Import - -```typescript -import { linkModelToContextMenuItems } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/list.md b/docs/sources/packages_api/ui/list.md deleted file mode 100644 index 95f6ca5ffb1..00000000000 --- a/docs/sources/packages_api/ui/list.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "List" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## List class - -Signature - -```typescript -export declare class List extends React.PureComponent> -``` -Import - -```typescript -import { List } from '@grafana/ui'; -``` -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/loadingplaceholder.md b/docs/sources/packages_api/ui/loadingplaceholder.md deleted file mode 100644 index 532221e10ac..00000000000 --- a/docs/sources/packages_api/ui/loadingplaceholder.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LoadingPlaceholder" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LoadingPlaceholder variable - -### LoadingPlaceholder variable - -Signature - -```typescript -LoadingPlaceholder: SFC -``` -Import - -```typescript -import { LoadingPlaceholder } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/loglabels.md b/docs/sources/packages_api/ui/loglabels.md deleted file mode 100644 index 4dfad003113..00000000000 --- a/docs/sources/packages_api/ui/loglabels.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogLabels" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LogLabels variable - -### LogLabels variable - -Signature - -```typescript -LogLabels: React.FunctionComponent> -``` -Import - -```typescript -import { LogLabels } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/logrows.md b/docs/sources/packages_api/ui/logrows.md deleted file mode 100644 index e5dc2eef371..00000000000 --- a/docs/sources/packages_api/ui/logrows.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "LogRows" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## LogRows variable - -### LogRows variable - -Signature - -```typescript -LogRows: React.FunctionComponent> -``` -Import - -```typescript -import { LogRows } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/makefragment.md b/docs/sources/packages_api/ui/makefragment.md deleted file mode 100644 index 4ce7a3d0e18..00000000000 --- a/docs/sources/packages_api/ui/makefragment.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "makeFragment" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## makeFragment variable - -### makeFragment variable - -Signature - -```typescript -makeFragment: (text: string, syntax?: string | undefined) => Document -``` -Import - -```typescript -import { makeFragment } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/makevalue.md b/docs/sources/packages_api/ui/makevalue.md deleted file mode 100644 index 1faf80131c4..00000000000 --- a/docs/sources/packages_api/ui/makevalue.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "makeValue" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## makeValue variable - -### makeValue variable - -Signature - -```typescript -makeValue: (text: string, syntax?: string | undefined) => Value -``` -Import - -```typescript -import { makeValue } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/measuretext.md b/docs/sources/packages_api/ui/measuretext.md deleted file mode 100644 index c722d81167d..00000000000 --- a/docs/sources/packages_api/ui/measuretext.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "measureText" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## measureText() function - -### measureText() function - -Signature - -```typescript -export declare function measureText(text: string, fontSize: number): TextMetrics; -``` -Import - -```typescript -import { measureText } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| text | string | | -| fontSize | number | | - -Returns: - -`TextMetrics` - diff --git a/docs/sources/packages_api/ui/mocktheme.md b/docs/sources/packages_api/ui/mocktheme.md deleted file mode 100644 index 30e2a358720..00000000000 --- a/docs/sources/packages_api/ui/mocktheme.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "mockTheme" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## mockTheme variable - -### mockTheme variable - -Signature - -```typescript -mockTheme: (mock: (name?: string | undefined) => GrafanaTheme) => () => void -``` -Import - -```typescript -import { mockTheme } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/mockthemecontext.md b/docs/sources/packages_api/ui/mockthemecontext.md deleted file mode 100644 index a806bfa12fa..00000000000 --- a/docs/sources/packages_api/ui/mockthemecontext.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "mockThemeContext" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## mockThemeContext variable - -### mockThemeContext variable - -Enables theme context mocking - -Signature - -```typescript -mockThemeContext: (theme: Partial) => () => void -``` -Import - -```typescript -import { mockThemeContext } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/modal.md b/docs/sources/packages_api/ui/modal.md deleted file mode 100644 index cc76dea2fc8..00000000000 --- a/docs/sources/packages_api/ui/modal.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Modal" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Modal variable - -### Modal variable - -Signature - -```typescript -Modal: React.FunctionComponent> -``` -Import - -```typescript -import { Modal } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/modalheader.md b/docs/sources/packages_api/ui/modalheader.md deleted file mode 100644 index a6c0694f53f..00000000000 --- a/docs/sources/packages_api/ui/modalheader.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ModalHeader" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ModalHeader variable - -### ModalHeader variable - -Signature - -```typescript -ModalHeader: React.FC -``` -Import - -```typescript -import { ModalHeader } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/modalroot.md b/docs/sources/packages_api/ui/modalroot.md deleted file mode 100644 index 7a9b151570a..00000000000 --- a/docs/sources/packages_api/ui/modalroot.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ModalRoot" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ModalRoot variable - -### ModalRoot variable - -Signature - -```typescript -ModalRoot: () => JSX.Element -``` -Import - -```typescript -import { ModalRoot } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/modalscontroller.md b/docs/sources/packages_api/ui/modalscontroller.md deleted file mode 100644 index cb253285755..00000000000 --- a/docs/sources/packages_api/ui/modalscontroller.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ModalsController" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ModalsController variable - -### ModalsController variable - -Signature - -```typescript -ModalsController: React.Consumer -``` -Import - -```typescript -import { ModalsController } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/modalsprovider.md b/docs/sources/packages_api/ui/modalsprovider.md deleted file mode 100644 index 1c35174439b..00000000000 --- a/docs/sources/packages_api/ui/modalsprovider.md +++ /dev/null @@ -1,82 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ModalsProvider" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ModalsProvider class - -Signature - -```typescript -export declare class ModalsProvider extends React.Component -``` -Import - -```typescript -import { ModalsProvider } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the ModalsProvider class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [hideModal](#hidemodal-property) | | () => void | | -| [showModal](#showmodal-property) | | (component: React.ComponentType<any>, props: any) => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### constructor(props) - -Constructs a new instance of the `ModalsProvider` class - -Signature - -```typescript -constructor(props: ModalsProviderProps); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | ModalsProviderProps | | - -### hideModal property - -Signature - -```typescript -hideModal: () => void; -``` - -### showModal property - -Signature - -```typescript -showModal: (component: React.ComponentType, props: any) => void; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/modaltabcontent.md b/docs/sources/packages_api/ui/modaltabcontent.md deleted file mode 100644 index 4e2afbd245e..00000000000 --- a/docs/sources/packages_api/ui/modaltabcontent.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ModalTabContent" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ModalTabContent variable - -### ModalTabContent variable - -Signature - -```typescript -ModalTabContent: React.FC -``` -Import - -```typescript -import { ModalTabContent } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/modaltabsheader.md b/docs/sources/packages_api/ui/modaltabsheader.md deleted file mode 100644 index 70b6e361a47..00000000000 --- a/docs/sources/packages_api/ui/modaltabsheader.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ModalTabsHeader" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ModalTabsHeader variable - -### ModalTabsHeader variable - -Signature - -```typescript -ModalTabsHeader: React.FC -``` -Import - -```typescript -import { ModalTabsHeader } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/multiselect.md b/docs/sources/packages_api/ui/multiselect.md deleted file mode 100644 index 3cdd195e92b..00000000000 --- a/docs/sources/packages_api/ui/multiselect.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "MultiSelect" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## MultiSelect() function - -### MultiSelect() function - -Signature - -```typescript -export declare function MultiSelect(props: MultiSelectCommonProps): JSX.Element; -``` -Import - -```typescript -import { MultiSelect } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | MultiSelectCommonProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/newlineplugin.md b/docs/sources/packages_api/ui/newlineplugin.md deleted file mode 100644 index 8d335fa6440..00000000000 --- a/docs/sources/packages_api/ui/newlineplugin.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NewlinePlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## NewlinePlugin() function - -### NewlinePlugin() function - -Signature - -```typescript -export declare function NewlinePlugin(): Plugin; -``` -Import - -```typescript -import { NewlinePlugin } from '@grafana/ui'; -``` -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/no_data_color.md b/docs/sources/packages_api/ui/no_data_color.md deleted file mode 100644 index 0cecf9b0475..00000000000 --- a/docs/sources/packages_api/ui/no_data_color.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NO_DATA_COLOR" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## NO\_DATA\_COLOR variable - -### NO\_DATA\_COLOR variable - -Signature - -```typescript -NO_DATA_COLOR = "rgba(150, 150, 150, 1)" -``` -Import - -```typescript -import { NO_DATA_COLOR } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/numbervalueeditor.md b/docs/sources/packages_api/ui/numbervalueeditor.md deleted file mode 100644 index b70ac73a4f2..00000000000 --- a/docs/sources/packages_api/ui/numbervalueeditor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "NumberValueEditor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## NumberValueEditor variable - -### NumberValueEditor variable - -Signature - -```typescript -NumberValueEditor: React.FC> -``` -Import - -```typescript -import { NumberValueEditor } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/ok_color.md b/docs/sources/packages_api/ui/ok_color.md deleted file mode 100644 index 9849734e85a..00000000000 --- a/docs/sources/packages_api/ui/ok_color.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "OK_COLOR" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## OK\_COLOR variable - -### OK\_COLOR variable - -Signature - -```typescript -OK_COLOR = "rgba(11, 237, 50, 1)" -``` -Import - -```typescript -import { OK_COLOR } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/pagination.md b/docs/sources/packages_api/ui/pagination.md deleted file mode 100644 index 82e921f3123..00000000000 --- a/docs/sources/packages_api/ui/pagination.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Pagination" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Pagination variable - -### Pagination variable - -Signature - -```typescript -Pagination: React.FC -``` -Import - -```typescript -import { Pagination } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/palette_columns.md b/docs/sources/packages_api/ui/palette_columns.md deleted file mode 100644 index 6f0f7de593b..00000000000 --- a/docs/sources/packages_api/ui/palette_columns.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PALETTE_COLUMNS" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PALETTE\_COLUMNS variable - -### PALETTE\_COLUMNS variable - -Signature - -```typescript -PALETTE_COLUMNS = 14 -``` -Import - -```typescript -import { PALETTE_COLUMNS } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/palette_rows.md b/docs/sources/packages_api/ui/palette_rows.md deleted file mode 100644 index a689807136c..00000000000 --- a/docs/sources/packages_api/ui/palette_rows.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PALETTE_ROWS" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PALETTE\_ROWS variable - -### PALETTE\_ROWS variable - -Signature - -```typescript -PALETTE_ROWS = 4 -``` -Import - -```typescript -import { PALETTE_ROWS } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/paneloptionsgrid.md b/docs/sources/packages_api/ui/paneloptionsgrid.md deleted file mode 100644 index 7cf9625c5db..00000000000 --- a/docs/sources/packages_api/ui/paneloptionsgrid.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionsGrid" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PanelOptionsGrid variable - -### PanelOptionsGrid variable - -Signature - -```typescript -PanelOptionsGrid: SFC -``` -Import - -```typescript -import { PanelOptionsGrid } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/paneloptionsgroup.md b/docs/sources/packages_api/ui/paneloptionsgroup.md deleted file mode 100644 index 1d82f27cbaf..00000000000 --- a/docs/sources/packages_api/ui/paneloptionsgroup.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PanelOptionsGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PanelOptionsGroup variable - -### PanelOptionsGroup variable - -Signature - -```typescript -PanelOptionsGroup: FunctionComponent -``` -Import - -```typescript -import { PanelOptionsGroup } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/pending_color.md b/docs/sources/packages_api/ui/pending_color.md deleted file mode 100644 index 93dbd23db27..00000000000 --- a/docs/sources/packages_api/ui/pending_color.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PENDING_COLOR" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PENDING\_COLOR variable - -### PENDING\_COLOR variable - -Signature - -```typescript -PENDING_COLOR = "rgba(247, 149, 32, 1)" -``` -Import - -```typescript -import { PENDING_COLOR } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/piechart.md b/docs/sources/packages_api/ui/piechart.md deleted file mode 100644 index 0251fd7b432..00000000000 --- a/docs/sources/packages_api/ui/piechart.md +++ /dev/null @@ -1,130 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PieChart" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PieChart class - -Signature - -```typescript -export declare class PieChart extends PureComponent -``` -Import - -```typescript -import { PieChart } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [containerElement](#containerelement-property) | | any | | -| [defaultProps](#defaultprops-property) | static | {
pieType: string;
format: string;
stat: string;
strokeWidth: number;
theme: GrafanaThemeType;
} | | -| [svgElement](#svgelement-property) | | any | | -| [tooltipElement](#tooltipelement-property) | | any | | -| [tooltipValueElement](#tooltipvalueelement-property) | | any | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate()](#componentdidupdate-method) | | | -| [draw()](#draw-method) | | | -| [render()](#render-method) | | | - -### containerElement property - -Signature - -```typescript -containerElement: any; -``` - -### defaultProps property - -Signature - -```typescript -static defaultProps: { - pieType: string; - format: string; - stat: string; - strokeWidth: number; - theme: GrafanaThemeType; - }; -``` - -### svgElement property - -Signature - -```typescript -svgElement: any; -``` - -### tooltipElement property - -Signature - -```typescript -tooltipElement: any; -``` - -### tooltipValueElement property - -Signature - -```typescript -tooltipValueElement: any; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(): void; -``` -Returns: - -`void` - -### draw method - -Signature - -```typescript -draw(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/piecharttype.md b/docs/sources/packages_api/ui/piecharttype.md deleted file mode 100644 index 74da3c41f57..00000000000 --- a/docs/sources/packages_api/ui/piecharttype.md +++ /dev/null @@ -1,31 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PieChartType" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PieChartType enum - -### PieChartType enum - -Signature - -```typescript -export declare enum PieChartType -``` -Import - -```typescript -import { PieChartType } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| DONUT | "donut" | | -| PIE | "pie" | | - diff --git a/docs/sources/packages_api/ui/popover.md b/docs/sources/packages_api/ui/popover.md deleted file mode 100644 index ee484a1bbc1..00000000000 --- a/docs/sources/packages_api/ui/popover.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Popover" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Popover class - -Signature - -```typescript -declare class Popover extends PureComponent -``` -Import - -```typescript -import { Popover } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | Partial<Props> | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/popovercontent.md b/docs/sources/packages_api/ui/popovercontent.md deleted file mode 100644 index 1cd67e9b9ff..00000000000 --- a/docs/sources/packages_api/ui/popovercontent.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PopoverContent" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PopoverContent type - -### PopoverContent type - -Signature - -```typescript -export declare type PopoverContent = string | React.ReactElement | ((props: PopoverContentProps) => JSX.Element); -``` -Import - -```typescript -import { PopoverContent } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/popovercontroller.md b/docs/sources/packages_api/ui/popovercontroller.md deleted file mode 100644 index 9d31c4a43c8..00000000000 --- a/docs/sources/packages_api/ui/popovercontroller.md +++ /dev/null @@ -1,72 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "PopoverController" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## PopoverController class - -Signature - -```typescript -declare class PopoverController extends React.Component -``` -Import - -```typescript -import { PopoverController } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [hidePopper](#hidepopper-property) | | () => void | | -| [showPopper](#showpopper-property) | | () => void | | -| [state](#state-property) | | {
show: boolean;
} | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### hidePopper property - -Signature - -```typescript -hidePopper: () => void; -``` - -### showPopper property - -Signature - -```typescript -showPopper: () => void; -``` - -### state property - -Signature - -```typescript -state: { - show: boolean; - }; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/portal.md b/docs/sources/packages_api/ui/portal.md deleted file mode 100644 index 4d0e6116b78..00000000000 --- a/docs/sources/packages_api/ui/portal.md +++ /dev/null @@ -1,94 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Portal" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Portal class - -Signature - -```typescript -export declare class Portal extends PureComponent -``` -Import - -```typescript -import { Portal } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the Portal class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [node](#node-property) | | HTMLElement | | -| [portalRoot](#portalroot-property) | | HTMLElement | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentWillUnmount()](#componentwillunmount-method) | | | -| [render()](#render-method) | | | - -### constructor(props) - -Constructs a new instance of the `Portal` class - -Signature - -```typescript -constructor(props: Props); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -### node property - -Signature - -```typescript -node: HTMLElement; -``` - -### portalRoot property - -Signature - -```typescript -portalRoot: HTMLElement; -``` - -### componentWillUnmount method - -Signature - -```typescript -componentWillUnmount(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): React.ReactPortal; -``` -Returns: - -`React.ReactPortal` - diff --git a/docs/sources/packages_api/ui/queryfield.md b/docs/sources/packages_api/ui/queryfield.md deleted file mode 100644 index bd72a4eb39d..00000000000 --- a/docs/sources/packages_api/ui/queryfield.md +++ /dev/null @@ -1,204 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "QueryField" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## QueryField class - -Renders an editor field. Pass initial value as initialQuery and listen to changes in props.onValueChanged. This component can only process strings. Internally it uses Slate Value. Implement props.onTypeahead to use suggestions, see PromQueryField.tsx as an example. - -Signature - -```typescript -export declare class QueryField extends React.PureComponent -``` -Import - -```typescript -import { QueryField } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props, context)](#constructor-propscontext) | | Constructs a new instance of the QueryField class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [editor](#editor-property) | | Editor | null | | -| [handleBlur](#handleblur-property) | | (event: Event, editor: CoreEditor, next: Function) => any | We need to handle blur events here mainly because of dashboard panels which expect to have query executed on blur. | -| [lastExecutedValue](#lastexecutedvalue-property) | | Value | null | | -| [mounted](#mounted-property) | | boolean | | -| [onChange](#onchange-property) | | (value: Value, runQuery?: boolean | undefined) => void | Update local state, propagate change upstream and optionally run the query afterwards. | -| [plugins](#plugins-property) | | Plugin[] | | -| [runOnChange](#runonchange-property) | | () => void | | -| [runOnChangeAndRunQuery](#runonchangeandrunquery-property) | | () => void | | -| [runOnChangeDebounced](#runonchangedebounced-property) | | Function | | -| [runOnRunQuery](#runonrunquery-property) | | () => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate(prevProps, prevState)](#componentdidupdate-method) | | | -| [componentWillUnmount()](#componentwillunmount-method) | | | -| [render()](#render-method) | | | - -### constructor(props, context) - -Constructs a new instance of the `QueryField` class - -Signature - -```typescript -constructor(props: QueryFieldProps, context: Context); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | QueryFieldProps | | -| context | Context<any> | | - -### editor property - -Signature - -```typescript -editor: Editor | null; -``` - -### handleBlur property - -We need to handle blur events here mainly because of dashboard panels which expect to have query executed on blur. - -Signature - -```typescript -handleBlur: (event: Event, editor: CoreEditor, next: Function) => any; -``` - -### lastExecutedValue property - -Signature - -```typescript -lastExecutedValue: Value | null; -``` - -### mounted property - -Signature - -```typescript -mounted: boolean; -``` - -### onChange property - -Update local state, propagate change upstream and optionally run the query afterwards. - -Signature - -```typescript -onChange: (value: Value, runQuery?: boolean | undefined) => void; -``` - -### plugins property - -Signature - -```typescript -plugins: Plugin[]; -``` - -### runOnChange property - -Signature - -```typescript -runOnChange: () => void; -``` - -### runOnChangeAndRunQuery property - -Signature - -```typescript -runOnChangeAndRunQuery: () => void; -``` - -### runOnChangeDebounced property - -Signature - -```typescript -runOnChangeDebounced: Function; -``` - -### runOnRunQuery property - -Signature - -```typescript -runOnRunQuery: () => void; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: QueryFieldProps, prevState: QueryFieldState): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | QueryFieldProps | | -| prevState | QueryFieldState | | - -Returns: - -`void` - -### componentWillUnmount method - -Signature - -```typescript -componentWillUnmount(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/radiobuttongroup.md b/docs/sources/packages_api/ui/radiobuttongroup.md deleted file mode 100644 index 2e00111bbee..00000000000 --- a/docs/sources/packages_api/ui/radiobuttongroup.md +++ /dev/null @@ -1,30 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RadioButtonGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## RadioButtonGroup namespace - -### RadioButtonGroup namespace - -Signature - -```typescript -export declare namespace RadioButtonGroup -``` -Import - -```typescript -import { RadioButtonGroup } from '@grafana/ui'; -``` - -## Variables - -| Variable | Description | -| --- | --- | -| [displayName](./displayname/) | | - diff --git a/docs/sources/packages_api/ui/radiobuttongroup/displayname.md b/docs/sources/packages_api/ui/radiobuttongroup/displayname.md deleted file mode 100644 index e8c6632a486..00000000000 --- a/docs/sources/packages_api/ui/radiobuttongroup/displayname.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "displayName" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## RadioButtonGroup.displayName variable - -### RadioButtonGroup.displayName variable - -Signature - -```typescript -displayName: string -``` -Import - -```typescript -import { RadioButtonGroup } from '@grafana/ui'; -const { displayName } = RadioButtonGroup; -``` diff --git a/docs/sources/packages_api/ui/refreshpicker.md b/docs/sources/packages_api/ui/refreshpicker.md deleted file mode 100644 index a5dd63aa3bb..00000000000 --- a/docs/sources/packages_api/ui/refreshpicker.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RefreshPicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## RefreshPicker variable - -### RefreshPicker variable - -Signature - -```typescript -RefreshPicker: React.FunctionComponent> & { - offOption: typeof RefreshPickerBase.offOption; - liveOption: typeof RefreshPickerBase.liveOption; - isLive: typeof RefreshPickerBase.isLive; -} -``` -Import - -```typescript -import { RefreshPicker } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/regexvalidation.md b/docs/sources/packages_api/ui/regexvalidation.md deleted file mode 100644 index 3a273bdbe60..00000000000 --- a/docs/sources/packages_api/ui/regexvalidation.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "regexValidation" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## regexValidation variable - -### regexValidation variable - -Signature - -```typescript -regexValidation: (pattern: string | RegExp, errorMessage?: string | undefined) => ValidationRule -``` -Import - -```typescript -import { regexValidation } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/region_fill_alpha.md b/docs/sources/packages_api/ui/region_fill_alpha.md deleted file mode 100644 index 2509159645c..00000000000 --- a/docs/sources/packages_api/ui/region_fill_alpha.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "REGION_FILL_ALPHA" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## REGION\_FILL\_ALPHA variable - -### REGION\_FILL\_ALPHA variable - -Signature - -```typescript -REGION_FILL_ALPHA = 0.09 -``` -Import - -```typescript -import { REGION_FILL_ALPHA } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/renderable.md b/docs/sources/packages_api/ui/renderable.md deleted file mode 100644 index 2404bbe8006..00000000000 --- a/docs/sources/packages_api/ui/renderable.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Renderable" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Renderable type - -### Renderable type - -Signature - -```typescript -export declare type Renderable = React.ComponentType | JSX.Element; -``` -Import - -```typescript -import { Renderable } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/renderfunction.md b/docs/sources/packages_api/ui/renderfunction.md deleted file mode 100644 index df216e3af50..00000000000 --- a/docs/sources/packages_api/ui/renderfunction.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RenderFunction" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## RenderFunction type - -### RenderFunction type - -Signature - -```typescript -export declare type RenderFunction = () => Renderable | Renderable[]; -``` -Import - -```typescript -import { RenderFunction } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/renderorcalltorender.md b/docs/sources/packages_api/ui/renderorcalltorender.md deleted file mode 100644 index 0a784e5a9c6..00000000000 --- a/docs/sources/packages_api/ui/renderorcalltorender.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "renderOrCallToRender" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## renderOrCallToRender() function - -### renderOrCallToRender() function - -Given react node or function returns element accordingly - -Signature - -```typescript -export declare function renderOrCallToRender(itemToRender: ((props?: TProps) => React.ReactNode) | React.ReactNode, props?: TProps): React.ReactNode; -``` -Import - -```typescript -import { renderOrCallToRender } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| itemToRender | ((props?: TProps) => React.ReactNode) | React.ReactNode | | -| props | TProps | props to be passed to the function if item provided as such | - -Returns: - -`React.ReactNode` - diff --git a/docs/sources/packages_api/ui/resetselectstyles.md b/docs/sources/packages_api/ui/resetselectstyles.md deleted file mode 100644 index 117447bd94b..00000000000 --- a/docs/sources/packages_api/ui/resetselectstyles.md +++ /dev/null @@ -1,79 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "resetSelectStyles" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## resetSelectStyles() function - -### resetSelectStyles() function - -Signature - -```typescript -export default function resetSelectStyles(): { - clearIndicator: () => {}; - container: () => {}; - control: () => {}; - dropdownIndicator: () => {}; - group: () => {}; - groupHeading: () => {}; - indicatorsContainer: () => {}; - indicatorSeparator: () => {}; - input: () => {}; - loadingIndicator: () => {}; - loadingMessage: () => {}; - menu: () => {}; - menuList: ({ maxHeight }: { - maxHeight: number; - }) => { - maxHeight: number; - }; - multiValue: () => {}; - multiValueLabel: () => {}; - multiValueRemove: () => {}; - noOptionsMessage: () => {}; - option: () => {}; - placeholder: () => {}; - singleValue: () => {}; - valueContainer: () => {}; -}; -``` -Import - -```typescript -import { resetSelectStyles } from '@grafana/ui'; -``` -Returns: - -`{ - clearIndicator: () => {}; - container: () => {}; - control: () => {}; - dropdownIndicator: () => {}; - group: () => {}; - groupHeading: () => {}; - indicatorsContainer: () => {}; - indicatorSeparator: () => {}; - input: () => {}; - loadingIndicator: () => {}; - loadingMessage: () => {}; - menu: () => {}; - menuList: ({ maxHeight }: { - maxHeight: number; - }) => { - maxHeight: number; - }; - multiValue: () => {}; - multiValueLabel: () => {}; - multiValueRemove: () => {}; - noOptionsMessage: () => {}; - option: () => {}; - placeholder: () => {}; - singleValue: () => {}; - valueContainer: () => {}; -}` - diff --git a/docs/sources/packages_api/ui/runnerplugin.md b/docs/sources/packages_api/ui/runnerplugin.md deleted file mode 100644 index 03667b863aa..00000000000 --- a/docs/sources/packages_api/ui/runnerplugin.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "RunnerPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## RunnerPlugin() function - -### RunnerPlugin() function - -Signature - -```typescript -export declare function RunnerPlugin({ handler }: any): Plugin; -``` -Import - -```typescript -import { RunnerPlugin } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { handler } | any | | - -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/schema.md b/docs/sources/packages_api/ui/schema.md deleted file mode 100644 index d00c190ddd2..00000000000 --- a/docs/sources/packages_api/ui/schema.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SCHEMA" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SCHEMA variable - -### SCHEMA variable - -Signature - -```typescript -SCHEMA: SchemaProperties -``` -Import - -```typescript -import { SCHEMA } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/segment.md b/docs/sources/packages_api/ui/segment.md deleted file mode 100644 index 2ac2cc2e3d2..00000000000 --- a/docs/sources/packages_api/ui/segment.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Segment" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Segment() function - -### Segment() function - -Signature - -```typescript -export declare function Segment({ options, value, onChange, Component, className, allowCustomValue, placeholder, }: React.PropsWithChildren>): JSX.Element; -``` -Import - -```typescript -import { Segment } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { options, value, onChange, Component, className, allowCustomValue, placeholder, } | React.PropsWithChildren<SegmentSyncProps<T>> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/segmentasync.md b/docs/sources/packages_api/ui/segmentasync.md deleted file mode 100644 index 27ebdbce839..00000000000 --- a/docs/sources/packages_api/ui/segmentasync.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SegmentAsync" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SegmentAsync() function - -### SegmentAsync() function - -Signature - -```typescript -export declare function SegmentAsync({ value, onChange, loadOptions, Component, className, allowCustomValue, placeholder, }: React.PropsWithChildren>): JSX.Element; -``` -Import - -```typescript -import { SegmentAsync } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { value, onChange, loadOptions, Component, className, allowCustomValue, placeholder, } | React.PropsWithChildren<SegmentAsyncProps<T>> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/segmentinput.md b/docs/sources/packages_api/ui/segmentinput.md deleted file mode 100644 index 7fb108319e3..00000000000 --- a/docs/sources/packages_api/ui/segmentinput.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SegmentInput" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SegmentInput() function - -### SegmentInput() function - -Signature - -```typescript -export declare function SegmentInput({ value: initialValue, onChange, Component, className, placeholder, autofocus, }: React.PropsWithChildren>): JSX.Element; -``` -Import - -```typescript -import { SegmentInput } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { value: initialValue, onChange, Component, className, placeholder, autofocus, } | React.PropsWithChildren<SegmentInputProps<T>> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/segmentselect.md b/docs/sources/packages_api/ui/segmentselect.md deleted file mode 100644 index 34e7bc57a3a..00000000000 --- a/docs/sources/packages_api/ui/segmentselect.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SegmentSelect" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SegmentSelect() function - -### SegmentSelect() function - -Signature - -```typescript -export declare function SegmentSelect({ value, options, onChange, onClickOutside, width, noOptionsMessage, allowCustomValue, }: React.PropsWithChildren>): JSX.Element; -``` -Import - -```typescript -import { SegmentSelect } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { value, options, onChange, onClickOutside, width, noOptionsMessage, allowCustomValue, } | React.PropsWithChildren<Props<T>> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/select.md b/docs/sources/packages_api/ui/select.md deleted file mode 100644 index 22831362b13..00000000000 --- a/docs/sources/packages_api/ui/select.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Select" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Select() function - -### Select() function - -Signature - -```typescript -export declare function Select(props: SelectCommonProps): JSX.Element; -``` -Import - -```typescript -import { Select } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | SelectCommonProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/selectionshortcutsplugin.md b/docs/sources/packages_api/ui/selectionshortcutsplugin.md deleted file mode 100644 index e8a3bdb2ccb..00000000000 --- a/docs/sources/packages_api/ui/selectionshortcutsplugin.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SelectionShortcutsPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SelectionShortcutsPlugin() function - -### SelectionShortcutsPlugin() function - -Signature - -```typescript -export declare function SelectionShortcutsPlugin(): Plugin; -``` -Import - -```typescript -import { SelectionShortcutsPlugin } from '@grafana/ui'; -``` -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/selectthemevariant.md b/docs/sources/packages_api/ui/selectthemevariant.md deleted file mode 100644 index 8766ceb1902..00000000000 --- a/docs/sources/packages_api/ui/selectthemevariant.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "selectThemeVariant" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## selectThemeVariant variable - -### selectThemeVariant variable - -Signature - -```typescript -selectThemeVariant: (variants: VariantDescriptor, currentTheme?: GrafanaThemeType | undefined) => string | number -``` -Import - -```typescript -import { selectThemeVariant } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/selectvalueeditor.md b/docs/sources/packages_api/ui/selectvalueeditor.md deleted file mode 100644 index b0c6767e0da..00000000000 --- a/docs/sources/packages_api/ui/selectvalueeditor.md +++ /dev/null @@ -1,91 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SelectValueEditor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SelectValueEditor class - -Signature - -```typescript -export declare class SelectValueEditor extends React.PureComponent, State> -``` -Import - -```typescript -import { SelectValueEditor } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [state](#state-property) | | State<T> | | -| [updateOptions](#updateoptions-property) | | () => Promise<void> | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate(oldProps)](#componentdidupdate-method) | | | -| [render()](#render-method) | | | - -### state property - -Signature - -```typescript -state: State; -``` - -### updateOptions property - -Signature - -```typescript -updateOptions: () => Promise; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(oldProps: Props): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| oldProps | Props<T> | | - -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/seriescolorpicker.md b/docs/sources/packages_api/ui/seriescolorpicker.md deleted file mode 100644 index 825a365c37f..00000000000 --- a/docs/sources/packages_api/ui/seriescolorpicker.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SeriesColorPicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SeriesColorPicker variable - -### SeriesColorPicker variable - -Signature - -```typescript -SeriesColorPicker: React.FunctionComponent> -``` -Import - -```typescript -import { SeriesColorPicker } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/seriescolorpickerpopover.md b/docs/sources/packages_api/ui/seriescolorpickerpopover.md deleted file mode 100644 index cf4180fbea3..00000000000 --- a/docs/sources/packages_api/ui/seriescolorpickerpopover.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SeriesColorPickerPopover" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SeriesColorPickerPopover variable - -### SeriesColorPickerPopover variable - -Signature - -```typescript -SeriesColorPickerPopover: FunctionComponent -``` -Import - -```typescript -import { SeriesColorPickerPopover } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/seriescolorpickerpopoverwiththeme.md b/docs/sources/packages_api/ui/seriescolorpickerpopoverwiththeme.md deleted file mode 100644 index 9e3372e00ea..00000000000 --- a/docs/sources/packages_api/ui/seriescolorpickerpopoverwiththeme.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SeriesColorPickerPopoverWithTheme" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SeriesColorPickerPopoverWithTheme variable - -### SeriesColorPickerPopoverWithTheme variable - -Signature - -```typescript -SeriesColorPickerPopoverWithTheme: React.FunctionComponent> -``` -Import - -```typescript -import { SeriesColorPickerPopoverWithTheme } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/seriesicon.md b/docs/sources/packages_api/ui/seriesicon.md deleted file mode 100644 index ab1f011aa8c..00000000000 --- a/docs/sources/packages_api/ui/seriesicon.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SeriesIcon" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SeriesIcon variable - -### SeriesIcon variable - -Signature - -```typescript -SeriesIcon: React.FunctionComponent -``` -Import - -```typescript -import { SeriesIcon } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/setinterval.md b/docs/sources/packages_api/ui/setinterval.md deleted file mode 100644 index 7cf0e359267..00000000000 --- a/docs/sources/packages_api/ui/setinterval.md +++ /dev/null @@ -1,101 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SetInterval" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SetInterval class - -Signature - -```typescript -export declare class SetInterval extends PureComponent -``` -Import - -```typescript -import { SetInterval } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the SetInterval class | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate(prevProps)](#componentdidupdate-method) | | | -| [componentWillUnmount()](#componentwillunmount-method) | | | -| [render()](#render-method) | | | - -### constructor(props) - -Constructs a new instance of the `SetInterval` class - -Signature - -```typescript -constructor(props: Props); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: Props): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | Props | | - -Returns: - -`void` - -### componentWillUnmount method - -Signature - -```typescript -componentWillUnmount(): void; -``` -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): null; -``` -Returns: - -`null` - diff --git a/docs/sources/packages_api/ui/sharedsinglestatmigrationhandler.md b/docs/sources/packages_api/ui/sharedsinglestatmigrationhandler.md deleted file mode 100644 index 7e03e8b057f..00000000000 --- a/docs/sources/packages_api/ui/sharedsinglestatmigrationhandler.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "sharedSingleStatMigrationHandler" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## sharedSingleStatMigrationHandler() function - -### sharedSingleStatMigrationHandler() function - -Signature - -```typescript -export declare function sharedSingleStatMigrationHandler(panel: PanelModel): SingleStatBaseOptions; -``` -Import - -```typescript -import { sharedSingleStatMigrationHandler } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| panel | PanelModel<SingleStatBaseOptions> | | - -Returns: - -`SingleStatBaseOptions` - diff --git a/docs/sources/packages_api/ui/sharedsinglestatpanelchangedhandler.md b/docs/sources/packages_api/ui/sharedsinglestatpanelchangedhandler.md deleted file mode 100644 index 5ba6b234730..00000000000 --- a/docs/sources/packages_api/ui/sharedsinglestatpanelchangedhandler.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "sharedSingleStatPanelChangedHandler" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## sharedSingleStatPanelChangedHandler() function - -### sharedSingleStatPanelChangedHandler() function - -Signature - -```typescript -export declare function sharedSingleStatPanelChangedHandler(panel: PanelModel> | any, prevPluginId: string, prevOptions: any): any; -``` -Import - -```typescript -import { sharedSingleStatPanelChangedHandler } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| panel | PanelModel<Partial<SingleStatBaseOptions>> | any | | -| prevPluginId | string | | -| prevOptions | any | | - -Returns: - -`any` - diff --git a/docs/sources/packages_api/ui/singlestatbaseoptions.md b/docs/sources/packages_api/ui/singlestatbaseoptions.md deleted file mode 100644 index b3783e61fe0..00000000000 --- a/docs/sources/packages_api/ui/singlestatbaseoptions.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SingleStatBaseOptions" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SingleStatBaseOptions interface - -Signature - -```typescript -export interface SingleStatBaseOptions -``` -Import - -```typescript -import { SingleStatBaseOptions } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [orientation](#orientation-property) | VizOrientation | | -| [reduceOptions](#reduceoptions-property) | ReduceDataOptions | | - -### orientation property - -Signature - -```typescript -orientation: VizOrientation; -``` - -### reduceOptions property - -Signature - -```typescript -reduceOptions: ReduceDataOptions; -``` diff --git a/docs/sources/packages_api/ui/slateprism.md b/docs/sources/packages_api/ui/slateprism.md deleted file mode 100644 index 489c91d3491..00000000000 --- a/docs/sources/packages_api/ui/slateprism.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SlatePrism" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SlatePrism() function - -### SlatePrism() function - -A Slate plugin to highlight code syntax. - -Signature - -```typescript -export declare function SlatePrism(optsParam?: OptionsFormat): Plugin; -``` -Import - -```typescript -import { SlatePrism } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| optsParam | OptionsFormat | | - -Returns: - -`Plugin` - diff --git a/docs/sources/packages_api/ui/slideouttransition.md b/docs/sources/packages_api/ui/slideouttransition.md deleted file mode 100644 index 16dad233c60..00000000000 --- a/docs/sources/packages_api/ui/slideouttransition.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SlideOutTransition" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SlideOutTransition() function - -### SlideOutTransition() function - -Signature - -```typescript -export declare function SlideOutTransition(props: Props): JSX.Element; -``` -Import - -```typescript -import { SlideOutTransition } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/slider.md b/docs/sources/packages_api/ui/slider.md deleted file mode 100644 index 4284f5f691c..00000000000 --- a/docs/sources/packages_api/ui/slider.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Slider" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Slider variable - -### Slider variable - -Signature - -```typescript -Slider: FunctionComponent -``` -Import - -```typescript -import { Slider } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/sortedcolors.md b/docs/sources/packages_api/ui/sortedcolors.md deleted file mode 100644 index d2aaa28ace5..00000000000 --- a/docs/sources/packages_api/ui/sortedcolors.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "sortedColors" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## sortedColors variable - -### sortedColors variable - -Signature - -```typescript -sortedColors: string[] -``` -Import - -```typescript -import { sortedColors } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/spinner.md b/docs/sources/packages_api/ui/spinner.md deleted file mode 100644 index c30e9d5d027..00000000000 --- a/docs/sources/packages_api/ui/spinner.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Spinner" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Spinner variable - -### Spinner variable - -Signature - -```typescript -Spinner: FC -``` -Import - -```typescript -import { Spinner } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/statspicker.md b/docs/sources/packages_api/ui/statspicker.md deleted file mode 100644 index 32c97afbe8e..00000000000 --- a/docs/sources/packages_api/ui/statspicker.md +++ /dev/null @@ -1,100 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StatsPicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## StatsPicker class - -Signature - -```typescript -export declare class StatsPicker extends PureComponent -``` -Import - -```typescript -import { StatsPicker } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [checkInput](#checkinput-property) | | () => void | | -| [defaultProps](#defaultprops-property) | static | Partial<Props> | | -| [onSelectionChange](#onselectionchange-property) | | (item: SelectableValue<string>) => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidMount()](#componentdidmount-method) | | | -| [componentDidUpdate(prevProps)](#componentdidupdate-method) | | | -| [render()](#render-method) | | | - -### checkInput property - -Signature - -```typescript -checkInput: () => void; -``` - -### defaultProps property - -Signature - -```typescript -static defaultProps: Partial; -``` - -### onSelectionChange property - -Signature - -```typescript -onSelectionChange: (item: SelectableValue) => void; -``` - -### componentDidMount method - -Signature - -```typescript -componentDidMount(): void; -``` -Returns: - -`void` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: Props): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | Props | | - -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/stringarrayeditor.md b/docs/sources/packages_api/ui/stringarrayeditor.md deleted file mode 100644 index 97018859abe..00000000000 --- a/docs/sources/packages_api/ui/stringarrayeditor.md +++ /dev/null @@ -1,72 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StringArrayEditor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## StringArrayEditor class - -Signature - -```typescript -export declare class StringArrayEditor extends React.PureComponent -``` -Import - -```typescript -import { StringArrayEditor } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [onRemoveString](#onremovestring-property) | | (index: number) => void | | -| [onValueChange](#onvaluechange-property) | | (e: React.SyntheticEvent, idx: number) => void | | -| [state](#state-property) | | {
showAdd: boolean;
} | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### onRemoveString property - -Signature - -```typescript -onRemoveString: (index: number) => void; -``` - -### onValueChange property - -Signature - -```typescript -onValueChange: (e: React.SyntheticEvent, idx: number) => void; -``` - -### state property - -Signature - -```typescript -state: { - showAdd: boolean; - }; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/stringvalueeditor.md b/docs/sources/packages_api/ui/stringvalueeditor.md deleted file mode 100644 index f9d678cfc5e..00000000000 --- a/docs/sources/packages_api/ui/stringvalueeditor.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StringValueEditor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## StringValueEditor variable - -### StringValueEditor variable - -Signature - -```typescript -StringValueEditor: React.FC> -``` -Import - -```typescript -import { StringValueEditor } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/stylemixins.md b/docs/sources/packages_api/ui/stylemixins.md deleted file mode 100644 index d13c9c6b35c..00000000000 --- a/docs/sources/packages_api/ui/stylemixins.md +++ /dev/null @@ -1,37 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "styleMixins" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## styleMixins namespace - -> 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. -> - -### styleMixins namespace - -Import - -```typescript -import { styleMixins } from '@grafana/ui'; -``` - -## Functions - -| Function | Description | -| --- | --- | -| [cardChrome(theme)](./cardchrome/) | | -| [hoverColor(color, theme)](./hovercolor/) | | -| [listItem(theme)](./listitem/) | | -| [listItemSelected(theme)](./listitemselected/) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [focusCss](./focuscss/) | | - diff --git a/docs/sources/packages_api/ui/stylemixins/cardchrome.md b/docs/sources/packages_api/ui/stylemixins/cardchrome.md deleted file mode 100644 index 982be83ad4d..00000000000 --- a/docs/sources/packages_api/ui/stylemixins/cardchrome.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "cardChrome" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## styleMixins.cardChrome() function - -### styleMixins.cardChrome() function - -Signature - -```typescript -export declare function cardChrome(theme: GrafanaTheme): string; -``` -Import - -```typescript -import { styleMixins } from '@grafana/ui'; -const { cardChrome } = styleMixins; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| theme | GrafanaTheme | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/ui/stylemixins/focuscss.md b/docs/sources/packages_api/ui/stylemixins/focuscss.md deleted file mode 100644 index 98dadadf826..00000000000 --- a/docs/sources/packages_api/ui/stylemixins/focuscss.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "focusCss" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## styleMixins.focusCss variable - -### styleMixins.focusCss variable - -Signature - -```typescript -focusCss: (theme: GrafanaTheme) => string -``` -Import - -```typescript -import { styleMixins } from '@grafana/ui'; -const { focusCss } = styleMixins; -``` diff --git a/docs/sources/packages_api/ui/stylemixins/hovercolor.md b/docs/sources/packages_api/ui/stylemixins/hovercolor.md deleted file mode 100644 index d7b591c9af7..00000000000 --- a/docs/sources/packages_api/ui/stylemixins/hovercolor.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "hoverColor" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## styleMixins.hoverColor() function - -### styleMixins.hoverColor() function - -Signature - -```typescript -export declare function hoverColor(color: string, theme: GrafanaTheme): string; -``` -Import - -```typescript -import { styleMixins } from '@grafana/ui'; -const { hoverColor } = styleMixins; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| color | string | | -| theme | GrafanaTheme | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/ui/stylemixins/listitem.md b/docs/sources/packages_api/ui/stylemixins/listitem.md deleted file mode 100644 index d22718aea98..00000000000 --- a/docs/sources/packages_api/ui/stylemixins/listitem.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "listItem" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## styleMixins.listItem() function - -### styleMixins.listItem() function - -Signature - -```typescript -export declare function listItem(theme: GrafanaTheme): string; -``` -Import - -```typescript -import { styleMixins } from '@grafana/ui'; -const { listItem } = styleMixins; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| theme | GrafanaTheme | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/ui/stylemixins/listitemselected.md b/docs/sources/packages_api/ui/stylemixins/listitemselected.md deleted file mode 100644 index aaa076b332d..00000000000 --- a/docs/sources/packages_api/ui/stylemixins/listitemselected.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "listItemSelected" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## styleMixins.listItemSelected() function - -### styleMixins.listItemSelected() function - -Signature - -```typescript -export declare function listItemSelected(theme: GrafanaTheme): string; -``` -Import - -```typescript -import { styleMixins } from '@grafana/ui'; -const { listItemSelected } = styleMixins; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| theme | GrafanaTheme | | - -Returns: - -`string` - diff --git a/docs/sources/packages_api/ui/styleprops.md b/docs/sources/packages_api/ui/styleprops.md deleted file mode 100644 index b4453e44c99..00000000000 --- a/docs/sources/packages_api/ui/styleprops.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "StyleProps" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## StyleProps interface - -Signature - -```typescript -export interface StyleProps -``` -Import - -```typescript -import { StyleProps } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hasIcon](#hasicon-property) | boolean | | -| [hasText](#hastext-property) | boolean | | -| [size](#size-property) | ComponentSize | | -| [theme](#theme-property) | GrafanaTheme | | -| [variant](#variant-property) | ButtonVariant | | - -### hasIcon property - -Signature - -```typescript -hasIcon: boolean; -``` - -### hasText property - -Signature - -```typescript -hasText: boolean; -``` - -### size property - -Signature - -```typescript -size: ComponentSize; -``` - -### theme property - -Signature - -```typescript -theme: GrafanaTheme; -``` - -### variant property - -Signature - -```typescript -variant: ButtonVariant; -``` diff --git a/docs/sources/packages_api/ui/stylesfactory.md b/docs/sources/packages_api/ui/stylesfactory.md deleted file mode 100644 index 51af772e6de..00000000000 --- a/docs/sources/packages_api/ui/stylesfactory.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "stylesFactory" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## stylesFactory() function - -### stylesFactory() function - -Creates memoized version of styles creator - -Signature - -```typescript -export declare function stylesFactory ReturnType>(stylesCreator: ResultFn): ResultFn; -``` -Import - -```typescript -import { stylesFactory } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| stylesCreator | ResultFn | function accepting dependencies based on which styles are created | - -Returns: - -`ResultFn` - diff --git a/docs/sources/packages_api/ui/suggestionsplugin.md b/docs/sources/packages_api/ui/suggestionsplugin.md deleted file mode 100644 index 0a827b8a7d4..00000000000 --- a/docs/sources/packages_api/ui/suggestionsplugin.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SuggestionsPlugin" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SuggestionsPlugin() function - -### SuggestionsPlugin() function - -Signature - -```typescript -export declare function SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, }: { - onTypeahead?: (typeahead: TypeaheadInput) => Promise; - cleanText?: (text: string) => string; - onWillApplySuggestion?: (suggestion: string, state: SuggestionsState) => string; - portalOrigin: string; -}): SlatePlugin; -``` -Import - -```typescript -import { SuggestionsPlugin } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, } | {
onTypeahead?: (typeahead: TypeaheadInput) => Promise<TypeaheadOutput>;
cleanText?: (text: string) => string;
onWillApplySuggestion?: (suggestion: string, state: SuggestionsState) => string;
portalOrigin: string;
} | | - -Returns: - -`SlatePlugin` - diff --git a/docs/sources/packages_api/ui/suggestionsstate.md b/docs/sources/packages_api/ui/suggestionsstate.md deleted file mode 100644 index b8756228026..00000000000 --- a/docs/sources/packages_api/ui/suggestionsstate.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "SuggestionsState" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## SuggestionsState interface - -Signature - -```typescript -export interface SuggestionsState -``` -Import - -```typescript -import { SuggestionsState } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [groupedItems](#groupeditems-property) | CompletionItemGroup[] | | -| [typeaheadContext](#typeaheadcontext-property) | string | | -| [typeaheadPrefix](#typeaheadprefix-property) | string | | -| [typeaheadText](#typeaheadtext-property) | string | | - -### groupedItems property - -Signature - -```typescript -groupedItems: CompletionItemGroup[]; -``` - -### typeaheadContext property - -Signature - -```typescript -typeaheadContext: string; -``` - -### typeaheadPrefix property - -Signature - -```typescript -typeaheadPrefix: string; -``` - -### typeaheadText property - -Signature - -```typescript -typeaheadText: string; -``` diff --git a/docs/sources/packages_api/ui/switch.md b/docs/sources/packages_api/ui/switch.md deleted file mode 100644 index 70937589a34..00000000000 --- a/docs/sources/packages_api/ui/switch.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Switch" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Switch variable - -### Switch variable - -Signature - -```typescript -Switch: React.ForwardRefExoticComponent & React.RefAttributes> -``` -Import - -```typescript -import { Switch } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/tab.md b/docs/sources/packages_api/ui/tab.md deleted file mode 100644 index e348be982ce..00000000000 --- a/docs/sources/packages_api/ui/tab.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Tab" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Tab variable - -### Tab variable - -Signature - -```typescript -Tab: React.ForwardRefExoticComponent & React.RefAttributes> -``` -Import - -```typescript -import { Tab } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/tabcontent.md b/docs/sources/packages_api/ui/tabcontent.md deleted file mode 100644 index 2db179ee7cc..00000000000 --- a/docs/sources/packages_api/ui/tabcontent.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TabContent" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TabContent variable - -### TabContent variable - -Signature - -```typescript -TabContent: FC -``` -Import - -```typescript -import { TabContent } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/table.md b/docs/sources/packages_api/ui/table.md deleted file mode 100644 index 7bdd62e67bc..00000000000 --- a/docs/sources/packages_api/ui/table.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Table" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Table variable - -### Table variable - -Signature - -```typescript -Table: FC -``` -Import - -```typescript -import { Table } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/tablecelldisplaymode.md b/docs/sources/packages_api/ui/tablecelldisplaymode.md deleted file mode 100644 index 058a979ebf4..00000000000 --- a/docs/sources/packages_api/ui/tablecelldisplaymode.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TableCellDisplayMode" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TableCellDisplayMode enum - -### TableCellDisplayMode enum - -Signature - -```typescript -export declare enum TableCellDisplayMode -``` -Import - -```typescript -import { TableCellDisplayMode } from '@grafana/ui'; -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Auto | "auto" | | -| ColorBackground | "color-background" | | -| ColorText | "color-text" | | -| GradientGauge | "gradient-gauge" | | -| JSONView | "json-view" | | -| LcdGauge | "lcd-gauge" | | - diff --git a/docs/sources/packages_api/ui/tableinputcsv.md b/docs/sources/packages_api/ui/tableinputcsv.md deleted file mode 100644 index 857df1bd57b..00000000000 --- a/docs/sources/packages_api/ui/tableinputcsv.md +++ /dev/null @@ -1,103 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TableInputCSV" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TableInputCSV class - -Expects the container div to have size set and will fill it 100% - -Signature - -```typescript -export declare class TableInputCSV extends React.PureComponent -``` -Import - -```typescript -import { TableInputCSV } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the TableInputCSV class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [onTextChange](#ontextchange-property) | | (event: any) => void | | -| [readCSV](#readcsv-property) | | any | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidUpdate(prevProps, prevState)](#componentdidupdate-method) | | | -| [render()](#render-method) | | | - -### constructor(props) - -Constructs a new instance of the `TableInputCSV` class - -Signature - -```typescript -constructor(props: Props); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -### onTextChange property - -Signature - -```typescript -onTextChange: (event: any) => void; -``` - -### readCSV property - -Signature - -```typescript -readCSV: any; -``` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: Props, prevState: State): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | Props | | -| prevState | State | | - -Returns: - -`void` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/tablesortbyfieldstate.md b/docs/sources/packages_api/ui/tablesortbyfieldstate.md deleted file mode 100644 index b832b5f7e3e..00000000000 --- a/docs/sources/packages_api/ui/tablesortbyfieldstate.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TableSortByFieldState" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TableSortByFieldState interface - -Signature - -```typescript -export interface TableSortByFieldState -``` -Import - -```typescript -import { TableSortByFieldState } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [desc](#desc-property) | boolean | | -| [displayName](#displayname-property) | string | | - -### desc property - -Signature - -```typescript -desc?: boolean; -``` - -### displayName property - -Signature - -```typescript -displayName: string; -``` diff --git a/docs/sources/packages_api/ui/tabsbar.md b/docs/sources/packages_api/ui/tabsbar.md deleted file mode 100644 index 4b3eac1c902..00000000000 --- a/docs/sources/packages_api/ui/tabsbar.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TabsBar" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TabsBar variable - -### TabsBar variable - -Signature - -```typescript -TabsBar: React.ForwardRefExoticComponent> -``` -Import - -```typescript -import { TabsBar } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/tag.md b/docs/sources/packages_api/ui/tag.md deleted file mode 100644 index f838032625f..00000000000 --- a/docs/sources/packages_api/ui/tag.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Tag" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Tag variable - -### Tag variable - -Signature - -```typescript -Tag: React.ForwardRefExoticComponent> -``` -Import - -```typescript -import { Tag } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/taglist.md b/docs/sources/packages_api/ui/taglist.md deleted file mode 100644 index e0612824174..00000000000 --- a/docs/sources/packages_api/ui/taglist.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TagList" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TagList variable - -### TagList variable - -Signature - -```typescript -TagList: FC -``` -Import - -```typescript -import { TagList } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/tagsinput.md b/docs/sources/packages_api/ui/tagsinput.md deleted file mode 100644 index 9895d836263..00000000000 --- a/docs/sources/packages_api/ui/tagsinput.md +++ /dev/null @@ -1,118 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TagsInput" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TagsInput class - -Signature - -```typescript -export declare class TagsInput extends PureComponent -``` -Import - -```typescript -import { TagsInput } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the TagsInput class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [onAdd](#onadd-property) | | (event: React.MouseEvent) => void | | -| [onChange](#onchange-property) | | () => void | | -| [onKeyboardAdd](#onkeyboardadd-property) | | (event: KeyboardEvent) => void | | -| [onNameChange](#onnamechange-property) | | (event: ChangeEvent<HTMLInputElement>) => void | | -| [onRemove](#onremove-property) | | (tagToRemove: string) => void | | -| [setNewTags](#setnewtags-property) | | () => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### constructor(props) - -Constructs a new instance of the `TagsInput` class - -Signature - -```typescript -constructor(props: Props); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props | | - -### onAdd property - -Signature - -```typescript -onAdd: (event: React.MouseEvent) => void; -``` - -### onChange property - -Signature - -```typescript -onChange: () => void; -``` - -### onKeyboardAdd property - -Signature - -```typescript -onKeyboardAdd: (event: KeyboardEvent) => void; -``` - -### onNameChange property - -Signature - -```typescript -onNameChange: (event: ChangeEvent) => void; -``` - -### onRemove property - -Signature - -```typescript -onRemove: (tagToRemove: string) => void; -``` - -### setNewTags property - -Signature - -```typescript -setNewTags: () => void; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/textarea.md b/docs/sources/packages_api/ui/textarea.md deleted file mode 100644 index ae9f05934b2..00000000000 --- a/docs/sources/packages_api/ui/textarea.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TextArea" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TextArea variable - -### TextArea variable - -Signature - -```typescript -TextArea: React.ForwardRefExoticComponent & React.RefAttributes> -``` -Import - -```typescript -import { TextArea } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/themeable.md b/docs/sources/packages_api/ui/themeable.md deleted file mode 100644 index d7fd0aaf755..00000000000 --- a/docs/sources/packages_api/ui/themeable.md +++ /dev/null @@ -1,34 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Themeable" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Themeable interface - -Signature - -```typescript -export interface Themeable -``` -Import - -```typescript -import { Themeable } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [theme](#theme-property) | GrafanaTheme | | - -### theme property - -Signature - -```typescript -theme: GrafanaTheme; -``` diff --git a/docs/sources/packages_api/ui/themecontext.md b/docs/sources/packages_api/ui/themecontext.md deleted file mode 100644 index 5fb0d6f34a6..00000000000 --- a/docs/sources/packages_api/ui/themecontext.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ThemeContext" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ThemeContext variable - -### ThemeContext variable - -Signature - -```typescript -ThemeContext: React.Context -``` -Import - -```typescript -import { ThemeContext } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/timeofdaypicker.md b/docs/sources/packages_api/ui/timeofdaypicker.md deleted file mode 100644 index 49df39c54a9..00000000000 --- a/docs/sources/packages_api/ui/timeofdaypicker.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeOfDayPicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TimeOfDayPicker variable - -### TimeOfDayPicker variable - -Signature - -```typescript -TimeOfDayPicker: FC -``` -Import - -```typescript -import { TimeOfDayPicker } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/timerangepicker.md b/docs/sources/packages_api/ui/timerangepicker.md deleted file mode 100644 index 7168d1f64bd..00000000000 --- a/docs/sources/packages_api/ui/timerangepicker.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeRangePicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TimeRangePicker variable - -### TimeRangePicker variable - -Signature - -```typescript -TimeRangePicker: React.FunctionComponent> -``` -Import - -```typescript -import { TimeRangePicker } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/timezonepicker.md b/docs/sources/packages_api/ui/timezonepicker.md deleted file mode 100644 index eb5ef9ad286..00000000000 --- a/docs/sources/packages_api/ui/timezonepicker.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TimeZonePicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TimeZonePicker variable - -### TimeZonePicker variable - -Signature - -```typescript -TimeZonePicker: React.FC -``` -Import - -```typescript -import { TimeZonePicker } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/togglebutton.md b/docs/sources/packages_api/ui/togglebutton.md deleted file mode 100644 index c4a7adbde31..00000000000 --- a/docs/sources/packages_api/ui/togglebutton.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ToggleButton" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ToggleButton variable - -### ToggleButton variable - -Signature - -```typescript -ToggleButton: FC -``` -Import - -```typescript -import { ToggleButton } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/togglebuttongroup.md b/docs/sources/packages_api/ui/togglebuttongroup.md deleted file mode 100644 index 93cf32864ce..00000000000 --- a/docs/sources/packages_api/ui/togglebuttongroup.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ToggleButtonGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ToggleButtonGroup class - -Signature - -```typescript -export declare class ToggleButtonGroup extends PureComponent -``` -Import - -```typescript -import { ToggleButtonGroup } from '@grafana/ui'; -``` -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/token.md b/docs/sources/packages_api/ui/token.md deleted file mode 100644 index 49a9c2fe561..00000000000 --- a/docs/sources/packages_api/ui/token.md +++ /dev/null @@ -1,82 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Token" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Token interface - -Signature - -```typescript -export interface Token -``` -Import - -```typescript -import { Token } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aliases](#aliases-property) | string[] | | -| [content](#content-property) | string | | -| [next](#next-property) | Token | null | | -| [offsets](#offsets-property) | {
start: number;
end: number;
} | | -| [prev](#prev-property) | Token | null | | -| [types](#types-property) | string[] | | - -### aliases property - -Signature - -```typescript -aliases: string[]; -``` - -### content property - -Signature - -```typescript -content: string; -``` - -### next property - -Signature - -```typescript -next?: Token | null; -``` - -### offsets property - -Signature - -```typescript -offsets?: { - start: number; - end: number; - }; -``` - -### prev property - -Signature - -```typescript -prev?: Token | null; -``` - -### types property - -Signature - -```typescript -types: string[]; -``` diff --git a/docs/sources/packages_api/ui/tooltip.md b/docs/sources/packages_api/ui/tooltip.md deleted file mode 100644 index 851a3430dc5..00000000000 --- a/docs/sources/packages_api/ui/tooltip.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "Tooltip" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## Tooltip variable - -### Tooltip variable - -Signature - -```typescript -Tooltip: ({ children, theme, ...controllerProps }: TooltipProps) => JSX.Element -``` -Import - -```typescript -import { Tooltip } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/typeaheadinput.md b/docs/sources/packages_api/ui/typeaheadinput.md deleted file mode 100644 index 9edc52911d8..00000000000 --- a/docs/sources/packages_api/ui/typeaheadinput.md +++ /dev/null @@ -1,79 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TypeaheadInput" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TypeaheadInput interface - -Signature - -```typescript -export interface TypeaheadInput -``` -Import - -```typescript -import { TypeaheadInput } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [editor](#editor-property) | CoreEditor | | -| [labelKey](#labelkey-property) | string | | -| [prefix](#prefix-property) | string | | -| [text](#text-property) | string | | -| [value](#value-property) | Value | | -| [wrapperClasses](#wrapperclasses-property) | string[] | | - -### editor property - -Signature - -```typescript -editor?: CoreEditor; -``` - -### labelKey property - -Signature - -```typescript -labelKey?: string; -``` - -### prefix property - -Signature - -```typescript -prefix: string; -``` - -### text property - -Signature - -```typescript -text: string; -``` - -### value property - -Signature - -```typescript -value?: Value; -``` - -### wrapperClasses property - -Signature - -```typescript -wrapperClasses: string[]; -``` diff --git a/docs/sources/packages_api/ui/typeaheadoutput.md b/docs/sources/packages_api/ui/typeaheadoutput.md deleted file mode 100644 index 97d38ac7e80..00000000000 --- a/docs/sources/packages_api/ui/typeaheadoutput.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "TypeaheadOutput" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## TypeaheadOutput interface - -Signature - -```typescript -export interface TypeaheadOutput -``` -Import - -```typescript -import { TypeaheadOutput } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](#context-property) | string | | -| [suggestions](#suggestions-property) | CompletionItemGroup[] | | - -### context property - -Signature - -```typescript -context?: string; -``` - -### suggestions property - -Signature - -```typescript -suggestions: CompletionItemGroup[]; -``` diff --git a/docs/sources/packages_api/ui/unitpicker.md b/docs/sources/packages_api/ui/unitpicker.md deleted file mode 100644 index 8a1f277520f..00000000000 --- a/docs/sources/packages_api/ui/unitpicker.md +++ /dev/null @@ -1,52 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "UnitPicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## UnitPicker class - -Signature - -```typescript -export declare class UnitPicker extends PureComponent -``` -Import - -```typescript -import { UnitPicker } from '@grafana/ui'; -``` -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [onChange](#onchange-property) | | (value: SelectableValue<string>) => void | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [render()](#render-method) | | | - -### onChange property - -Signature - -```typescript -onChange: (value: SelectableValue) => void; -``` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/usestyles.md b/docs/sources/packages_api/ui/usestyles.md deleted file mode 100644 index f6902077513..00000000000 --- a/docs/sources/packages_api/ui/usestyles.md +++ /dev/null @@ -1,25 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "useStyles" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## useStyles variable - -### useStyles variable - -Hook for using memoized styles with access to the theme. - -Signature - -```typescript -useStyles: (getStyles: (theme?: GrafanaTheme | undefined) => any) => any -``` -Import - -```typescript -import { useStyles } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/usetheme.md b/docs/sources/packages_api/ui/usetheme.md deleted file mode 100644 index 65f3782dc69..00000000000 --- a/docs/sources/packages_api/ui/usetheme.md +++ /dev/null @@ -1,27 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "useTheme" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## useTheme() function - -### useTheme() function - -Signature - -```typescript -export declare function useTheme(): GrafanaTheme; -``` -Import - -```typescript -import { useTheme } from '@grafana/ui'; -``` -Returns: - -`GrafanaTheme` - diff --git a/docs/sources/packages_api/ui/validate.md b/docs/sources/packages_api/ui/validate.md deleted file mode 100644 index e396ffe3395..00000000000 --- a/docs/sources/packages_api/ui/validate.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "validate" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## validate variable - -### validate variable - -Signature - -```typescript -validate: (value: string, validationRules: ValidationRule[]) => string[] | null -``` -Import - -```typescript -import { validate } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/validationevents.md b/docs/sources/packages_api/ui/validationevents.md deleted file mode 100644 index 1081f9d6b85..00000000000 --- a/docs/sources/packages_api/ui/validationevents.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValidationEvents" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ValidationEvents interface - -Signature - -```typescript -export interface ValidationEvents -``` -Import - -```typescript -import { ValidationEvents } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/validationrule.md b/docs/sources/packages_api/ui/validationrule.md deleted file mode 100644 index a2707ee98da..00000000000 --- a/docs/sources/packages_api/ui/validationrule.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValidationRule" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ValidationRule interface - -Signature - -```typescript -export interface ValidationRule -``` -Import - -```typescript -import { ValidationRule } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errorMessage](#errormessage-property) | string | | -| [rule](#rule-property) | (valueToValidate: string) => boolean | | - -### errorMessage property - -Signature - -```typescript -errorMessage: string; -``` - -### rule property - -Signature - -```typescript -rule: (valueToValidate: string) => boolean; -``` diff --git a/docs/sources/packages_api/ui/valuepicker.md b/docs/sources/packages_api/ui/valuepicker.md deleted file mode 100644 index efed9fb0e05..00000000000 --- a/docs/sources/packages_api/ui/valuepicker.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "ValuePicker" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## ValuePicker() function - -### ValuePicker() function - -Signature - -```typescript -export declare function ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, }: ValuePickerProps): JSX.Element; -``` -Import - -```typescript -import { ValuePicker } from '@grafana/ui'; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| { label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, } | ValuePickerProps<T> | | - -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/verticalgroup.md b/docs/sources/packages_api/ui/verticalgroup.md deleted file mode 100644 index b055055a6f1..00000000000 --- a/docs/sources/packages_api/ui/verticalgroup.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VerticalGroup" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## VerticalGroup variable - -### VerticalGroup variable - -Signature - -```typescript -VerticalGroup: React.FC> -``` -Import - -```typescript -import { VerticalGroup } from '@grafana/ui'; -``` diff --git a/docs/sources/packages_api/ui/vizrepeater.md b/docs/sources/packages_api/ui/vizrepeater.md deleted file mode 100644 index 8d27df461cb..00000000000 --- a/docs/sources/packages_api/ui/vizrepeater.md +++ /dev/null @@ -1,115 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VizRepeater" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## VizRepeater class - -Signature - -```typescript -export declare class VizRepeater extends PureComponent, State> -``` -Import - -```typescript -import { VizRepeater } from '@grafana/ui'; -``` -Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [constructor(props)](#constructor-props) | | Constructs a new instance of the VizRepeater class | - -Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [defaultProps](#defaultprops-property) | static | DefaultProps | | - -Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [componentDidUpdate(prevProps)](#componentdidupdate-method) | | | -| [getOrientation()](#getorientation-method) | | | -| [render()](#render-method) | | | -| [renderGrid()](#rendergrid-method) | | | - -### constructor(props) - -Constructs a new instance of the `VizRepeater` class - -Signature - -```typescript -constructor(props: Props); -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Props<V, D> | | - -### defaultProps property - -Signature - -```typescript -static defaultProps: DefaultProps; -``` - -### componentDidUpdate method - -Signature - -```typescript -componentDidUpdate(prevProps: Props): void; -``` -Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prevProps | Props<V, D> | | - -Returns: - -`void` - -### getOrientation method - -Signature - -```typescript -getOrientation(): VizOrientation; -``` -Returns: - -`VizOrientation` - -### render method - -Signature - -```typescript -render(): JSX.Element; -``` -Returns: - -`JSX.Element` - -### renderGrid method - -Signature - -```typescript -renderGrid(): JSX.Element; -``` -Returns: - -`JSX.Element` - diff --git a/docs/sources/packages_api/ui/vizrepeaterrendervalueprops.md b/docs/sources/packages_api/ui/vizrepeaterrendervalueprops.md deleted file mode 100644 index 657564f09fb..00000000000 --- a/docs/sources/packages_api/ui/vizrepeaterrendervalueprops.md +++ /dev/null @@ -1,70 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "VizRepeaterRenderValueProps" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## VizRepeaterRenderValueProps interface - -Signature - -```typescript -export interface VizRepeaterRenderValueProps -``` -Import - -```typescript -import { VizRepeaterRenderValueProps } from '@grafana/ui'; -``` -Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alignmentFactors](#alignmentfactors-property) | D | | -| [height](#height-property) | number | | -| [orientation](#orientation-property) | VizOrientation | | -| [value](#value-property) | V | | -| [width](#width-property) | number | | - -### alignmentFactors property - -Signature - -```typescript -alignmentFactors: D; -``` - -### height property - -Signature - -```typescript -height: number; -``` - -### orientation property - -Signature - -```typescript -orientation: VizOrientation; -``` - -### value property - -Signature - -```typescript -value: V; -``` - -### width property - -Signature - -```typescript -width: number; -``` diff --git a/docs/sources/packages_api/ui/withtheme.md b/docs/sources/packages_api/ui/withtheme.md deleted file mode 100644 index 8dcaa5cd15f..00000000000 --- a/docs/sources/packages_api/ui/withtheme.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -# ----------------------------------------------------------------------- -# Do not edit this file. It is automatically generated by API Documenter. -# ----------------------------------------------------------------------- -title = "withTheme" -keywords = ["grafana","documentation","sdk","@grafana/ui"] -type = "docs" -+++ - -## withTheme variable - -### withTheme variable - -Signature - -```typescript -withTheme:

(Component: React.ComponentType

) => React.FunctionComponent>> & S -``` -Import - -```typescript -import { withTheme } from '@grafana/ui'; -```