API Reference on Grafana Labs

@grafana/data

Fri, 10 Apr 2026 18:31:50 +0000

@grafana/data package

A library containing most of the core functionality and data types used in Grafana.

Classes

Class	Description
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
ArrayVector
BinaryOperationVector
CircularDataFrame	This dataframe can have values constantly added, and will never exceed the given capacity
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
CSVReader
DataFrameView	*(BETA)* This abstraction will present the contents of a DataFrame as if it were a well typed javascript object Vector.
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
FieldCache
FieldConfigEditorBuilder	Fluent API for declarative creation of field config option editors
FieldConfigOptionsRegistry
FormattedVector
GrafanaPlugin
LanguageProvider
MutableDataFrame
PanelOptionsEditorBuilder	Fluent API for declarative creation of panel options
PanelPlugin
Registry
SortedVector	Values are returned in the order defined by the input parameter
SystemDateFormatsState

Enumerations

Enumeration	Description
BinaryOperationID
CoreApp
CSVHeaderStyle
DataQueryErrorType
DataSourceStatus
DataTopic
DataTransformerID
ExploreMode
FieldColorModeId
FieldConfigProperty
FieldMatcherID
FieldType
FrameMatcherID	Field name matchers
GrafanaThemeType
InternalTimeZones
LiveChannelConnectionState
LiveChannelEventType
LiveChannelScope	The channel id is defined as:${scope}/${namespace}/${path}The scope drives how the namespace is used and controlled
LoadingState	Represent panel data loading state.
LogLevel	Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation.
LogsDedupDescription
LogsDedupStrategy
LogsMetaKind
LogsSortOrder
MappingType
MatcherID
NullValueMode
OrgRole
PluginErrorCode	Describes error code returned from Grafana plugins API call
PluginIncludeType
PluginSignatureStatus	Describes status of plugin signature
PluginState	Describes plugins life cycle status
PluginType	Describes type of plugin
ReducerID
ThresholdsMode	Display mode
VariableOrigin
VariableSuggestionsScope
VizOrientation

Functions

Function	Description
addLogLevelToSeries(series, lineIndex)
applyFieldOverrides(options)	Return a copy of the DataFrame with all rules applied
applyRawFieldOverrides(data)	Return a copy of the DataFrame with raw data
arrowTableToDataFrame(table)
base64StringToArrowTable(text)
buildColorsMapForTheme(theme)
calculateFieldStats(rows, extractor)
calculateLogsLabelStats(rows, label)
calculateStats(values)
doStandardCalcs(field, ignoreNulls, nullAsZero)
eventFactory(name)
findCommonLabels(labelsSets)	Returns a map labels that are common to the given label sets.
findHighlightChunksInText({ searchWords, textToHighlight, })	Adapt findMatchesInText for react-highlight-words findChunks handler. See https://github.com/bvaughn/react-highlight-words#props
findMatchesInText(haystack, needle)	Returns a list of substring regexp matches.
findUniqueLabels(labels, commonLabels)	Returns a map of labels that are in `labels`, but not in `commonLabels`.
formatLabels(labels, defaultValue, withoutBraces)	Serializes the given labels to a string.
formattedValueToString(val)
getActiveThreshold(value, thresholds)
getColorDefinitionByName(name)
getColorForTheme(color, theme)
getColorFromHexRgbOrName(color, type)
getDataFrameRow(data, row)	Wrapper to get an array from each field value
getDecimalsForValue(value, decimalOverride)
getDisplayProcessor(options)
getDisplayValueAlignmentFactors(values)
getFieldColorMode(mode)
getFieldColorModeForField(field)
getFieldDisplayName(field, frame, allFrames)
getFieldMatcher(config)
getFlotPairs({ xField, yField, nullValueMode })
getFlotPairsConstant(seriesData, range)	Returns a constant series based on the first value from the provide series.
getFrameDisplayName(frame, index)	Get an appropriate display title
getFrameMatchers(config)
getLogLevel(line)	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)
getParser(line)
getRawDisplayProcessor()
getScaleCalculator(field, theme)
getValueFormat(id)
getValueFormats()
getValueFormatterIndex()
grafanaDataFrameToArrowTable(data, keepOriginalNames)
guessFieldTypeForField(field)	Looks at the data to guess the column type. This ignores any existing setting
guessFieldTypeFromNameAndValue(name, v)	Given a name and value, this will pick a reasonable field type
guessFieldTypeFromValue(v)	Given a value this will guess the best column typeTODO: better Date/Time support! Look for standard date strings?
hasLinks(field)
isLiveChannelJoinEvent(evt)
isLiveChannelLeaveEvent(evt)
isLiveChannelMessageEvent(evt)
isLiveChannelStatusEvent(evt)
isValidLiveChannelAddress(addr)	Check if the address has a scope, namespace, and path
locale(value, decimals)
localTimeFormat(options, locale, fallback)	localTimeFormat helps to generate date formats for momentjs based on browser’s locale
mapInternalLinkToExplore(link, scopedVars, range, field, options)
matchAllLabels(expect, against)	Check that all labels exist in another set of labels
parseFlags(text)	Converts any mode modifiers in the text to the Javascript equivalent flag
parseLabels(labels)	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)
reduceField(options)
renderMarkdown(str)
reverseDataFrame(data)	Returns a copy with all values reversed
scaledUnits(factor, extArray)
setMarkdownOptions(optionsOverride)
simpleCountUnit(symbol)
sortDataFrame(data, sortIndex, reverse)
sortThresholds(thresholds)	Sorts the thresholds
stringFormater(value)
stringStartsAsRegEx(str)
stringToJsRegex(str)
stringToMs(str)
toCSV(data, config)
toDataFrame(data)	Inspect any object and return the results as a DataFrame
toDataFrameDTO(data)	Returns a copy that does not include functions
toFixed(value, decimals)
toFixedScaled(value, decimals, scaledDecimals, additionalDecimals, ext)
toFixedUnit(unit, asPrefix)
toFloatOrUndefined(value)
toIntegerOrUndefined(value)
toNumberString(value)
transformDataFrame(options, data)	Apply configured transformations to the input data
updateDatasourcePluginOption(props, key, val)
validateFieldConfig(config)	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)	Use functional programming with your vector

Interfaces

Interface	Description
AbsoluteTimeRange
AnnotationEvent
AnnotationEventFieldMapping
AnnotationQuery	This JSON object is stored in the dashboard json model.
AnnotationQueryRequest	Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md
AnnotationSupport	Since Grafana 7.2This offers a generic approach to annotation processing
AppEvent
ApplyFieldOverrideOptions
AppPluginMeta
AppRootProps
ArrowDataFrame
BuildInfo	Describes the build information that will be available via the Grafana configuration.
ColorFieldConfigSettings
Column
ConfigOverrideRule
CreatePlotOverlay
CSVConfig
CSVOptions
CSVParseCallbacks
DataConfigSource	Describes and API for exposing panel specific data configurations.
DataFrame
DataFrameDTO	Like a DataFrame, but fields may be a FieldDTO
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	Callback info for DataLink click events
DataLinksFieldConfigSettings
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
DataQueryRequest
DataQueryResponse
DataQueryTimings
DataSourceConstructor
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
DataSourcePluginComponents
DataSourcePluginMeta
DataSourcePluginOptionsEditorProps
DataSourceSelectItem
DataSourceSettings	Data Source instance edit model. This is returned from: /api/datasources
DataTransformerConfig
DataTransformerInfo	Function that transform data frames (AKA transformer)
DateTime
DateTimeBuiltinFormat
DateTimeDuration
DateTimeLocale
DateTimeOptions	The type describing date and time options. Used for all the helper functions available to parse or format date and time values.
DateTimeOptionsWhenParsing	The type that describes options that can be passed when parsing a date and time value.
DateTimeOptionsWithFormat	The type describing the options that can be passed to the dateTimeFormat helper function to control how the date and time value passed to the function is formatted.
DecimalInfo
Dimension
DisplayValue
DisplayValueAlignmentFactors	These represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues
DynamicConfigValue
ExploreQueryFieldProps
ExploreStartPageProps
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
FieldCalcs
FieldColor
FieldColorMode
FieldConfig	Every property is optionalPlugins may extend this with additional properties. Something like series overrides
FieldConfigEditorConfig
FieldConfigEditorProps
FieldConfigPropertyItem
FieldConfigSource
FieldDisplay
FieldDTO	Like a field, but properties are optional and values may be a simple array
FieldMatcherInfo
FieldOverrideContext
FieldOverrideEditorProps
FieldReducerInfo
FieldState
FieldWithIndex
FlotDataPoint
FormattedValue
FrameMatcherInfo
GetFieldDisplayValuesOptions
GrafanaConfig	Describes all the different Grafana configuration values available for an instance.
GrafanaTheme
GrafanaThemeCommons
GraphSeriesXY	View model projection of a series
GroupedTimeZones
HistoryItem
IntervalValues
Labels
LicenseInfo	Describes the license information about the current running instance of Grafana.
LinkModel	Processed Link Model. The values are ready to use
LinkModelSupplier	Provides a way to produce links on demandTODO: ScopedVars in in GrafanaUI package!
LiveChannelJoinEvent
LiveChannelLeaveEvent
LiveChannelMessageEvent
LogLabelStatsModel
LogRowModel
LogSearchMatch
LogsMetaItem
LogsModel
LogsParser
MatcherConfig
MetadataInspectorProps
MetricFindValue
MutableVector	Vector with standard manipulation functions
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
NavModelItem
NumberFieldConfigSettings
PanelData
PanelEditorProps
PanelModel
PanelOptionsEditorConfig
PanelOptionsEditorItem
PanelOptionsEditorProps
PanelPluginMeta
PanelProps
PluginBuildInfo
PluginConfigPage
PluginConfigPageProps
PluginDependencies
PluginError	Describes error returned from Grafana plugins API call
PluginInclude
PluginMeta
PluginMetaInfo
QueryEditorProps
QueryFix
QueryFixAction
QueryHint
QueryResultBase
QueryResultMeta
QueryResultMetaNotice	QueryResultMetaNotice is a structure that provides user notices for query result data
QueryResultMetaStat
RangeMap
RawTimeRange
ReadWriteVector	Apache arrow vectors are Read/Write
ReduceDataOptions	Options for how to turn DataFrames into an array of display values
RegexpOrNamesMatcherOptions
RegistryItem
RegistryItemWithOptions
ScopedVar
ScopedVars
ScreenshotInfo
SelectableValue	Used in select elements
SelectFieldConfigSettings
StandardEditorContext
StandardEditorProps
StandardEditorsRegistryItem
StringFieldConfigSettings
SystemDateFormatSettings
TableData
TextMatch
Threshold
ThresholdsConfig	Config that is passed to the ThresholdsEditor
ThresholdsFieldConfigSettings
TimeOption
TimeOptions
TimeRange
TimeSeries
TimeZoneCountry
TimeZoneInfo
TransformerRegistyItem
TransformerUIProps
UnitFieldConfigSettings
UserOrgDTO
ValueFormat
ValueFormatCategory
ValueFormatterIndex
ValueLinkConfig
ValueMap
ValueMappingFieldConfigSettings
VariableModel
VariableSuggestion
Vector
YAxis

Namespaces

Namespace	Description
AppEvents
dateMath
PanelEvents
rangeUtil

Variables

Variable	Description
binaryOperators
booleanOverrideProcessor
checkLogsError
classicColors
createDimension
DataLinkBuiltInVars
dataLinksOverrideProcessor
dateTime
dateTimeAsMoment
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.
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.
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.
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.
dateTimeForTimeZone
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. If no format is specified the current system format will be assumed.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.
DEFAULT_FIELD_DISPLAY_VALUES_LIMIT
DefaultTimeRange
DefaultTimeZone
deprecationWarning
escapeStringForRegex
FALLBACK_COLOR
fieldColorModeRegistry
fieldMatchers
fieldReducers
frameMatchers
getAllValuesFromDimension
getColumnFromDimension
getColumnsFromDimension
getDimensionByName
getFieldDisplayValues
getLocale
getLocaleData
getMappedValue
getNamedColorPalette
getSeriesTimeStep	Returns minimal time step from series time field
getTimeField
getTimeZoneGroups
getTimeZoneInfo
getTimeZones
getValueFromDimension
guessFieldTypes
hasMsResolution	Checks if series time field has ms resolution
identityOverrideProcessor
isDataFrame
isDateTime
ISO_8601
isTableData
locationUtil
LogsParsers
MISSING_VALUE
numberOverrideProcessor
objRemoveUndefined
observableTester
onUpdateDatasourceJsonDataOption
onUpdateDatasourceJsonDataOptionChecked
onUpdateDatasourceJsonDataOptionSelect
onUpdateDatasourceOption
onUpdateDatasourceResetOption
onUpdateDatasourceSecureJsonDataOption
onUpdateDatasourceSecureJsonDataOptionSelect
selectOverrideProcessor
setLocale
sortInAscendingOrder
sortInDescendingOrder
sortLogRows
sortLogsResult
standardEditorsRegistry
standardFieldConfigEditorRegistry
standardTransformers
standardTransformersRegistry	Registry of transformation options that can be driven by stored configuration files.
stringOverrideProcessor
systemDateFormats
textUtil
thresholdsOverrideProcessor
TIME_FORMAT
TIME_SERIES_METRIC_FIELD_NAME
TIME_SERIES_TIME_FIELD_NAME
TIME_SERIES_VALUE_FIELD_NAME
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.
timeZoneFormatUserFriendly
toDuration
toLegacyResponseData
toPascalCase
toUtc
unEscapeStringFromRegex
unitOverrideProcessor
updateDatasourcePluginJsonDataOption
updateDatasourcePluginResetOption
updateDatasourcePluginSecureJsonDataOption
urlUtil
valueMappingsOverrideProcessor
VAR_CALC
VAR_CELL_PREFIX
VAR_FIELD_LABELS
VAR_FIELD_NAME
VAR_SERIES_NAME

Type Aliases

Type Alias	Description
AnnotationEventMappings
BinaryOperation
Color
ColorDefinition
DataQueryResponseData
DataSourceOptionsType
DataSourceQueryType
DateTimeInput
DecimalCount
Dimensions
DisplayProcessor
DurationInput
DurationUnit
FieldMatcher
FormatInput
FrameMatcher
GraphSeriesValue
InterpolateFunction
KeyValue
LegacyResponseData	Starting in v6.2 DataFrame can represent both TimeSeries and TableData
LinkTarget
LiveChannelEvent
MutableField
NavIndex
Omit_2
PanelMigrationHandler	Called when a panel is first loaded with current panel model
PanelOptionEditorsRegistry
PanelTypeChangedHandler	Called before a panel is initialized. Allows panel inspection for any updates before changing the panel type.
PreferredVisualisationType
Subtract
TimeFragment
TimeSeriesPoints
TimeSeriesValue
TimeZone
TimeZoneBrowser
TimeZoneResolver	The type to describe the time zone resolver function that will be used to access the default time zone of a user.
TimeZoneUtc
Trace
TraceData
TraceKeyValuePair	All timestamps are in microseconds
TraceLink
TraceLog
TraceProcess
TraceSpan
TraceSpanData
TraceSpanReference
UrlQueryMap	Type to represent the values parsed from the query string.
UrlQueryValue	Type to represent the value of a single query variable.
ValueConverter
ValueFormatter
ValueMapping
VariableType

@grafana/e2e

Fri, 10 Apr 2026 18:31:50 +0000

@grafana/e2e package

A library for writing end-to-end tests for Grafana and its ecosystem.

Variables

Variable	Description
e2e

@grafana/e2e-selectors

Fri, 10 Apr 2026 18:31:50 +0000

@grafana/e2e-selectors package

A library containing the different design components of the Grafana ecosystem.

Interfaces

Interface	Description
Selectors
UrlSelector

Variables

Variable	Description
selectors

Type Aliases

Type Alias	Description
CssSelector
E2ESelectors
FunctionSelector
StringSelector

@grafana/runtime

Fri, 10 Apr 2026 18:31:50 +0000

@grafana/runtime package

A library containing services, configurations etc. used to interact with the Grafana engine.

Classes

Class	Description
DataSourceWithBackend	Extend this class to implement a data source plugin that is depending on the Grafana backend API.
GrafanaBootConfig

Enumerations

Enumeration	Description
EchoEventType	Supported echo event types that can be sent via the EchoSrv.
HealthStatus	Describes the current health status of a data source plugin.
MetaAnalyticsEventName	The meta analytics events that can be added to the echo service.

Functions

Function	Description
frameToMetricFindValue(frame)	Return the first string or non-time field as the value
getAngularLoader()	Used to retrieve the AngularLoader that enables the use of Angular components within a React component.Please see the AngularComponent for a proper example.
getDataSourceSrv()	Used to retrieve the DataSourceSrv that is the entry point for communicating with a datasource that is added as a plugin (both external and internal).
getEchoSrv()	Used to retrieve the EchoSrv that can be used to report events to registered echo backends.
getLocationSrv()	Used to retrieve the LocationSrv that can be used to automatically navigate the user to a new place in Grafana.
loadPluginCss(options)	Use this to load css for a Grafana plugin by specifying a PluginCssOptions containing styling for the dark and the light theme.
toDataQueryError(err)	Convert an object into a DataQueryError – if this is an HTTP response, it will put the correct values in the error field
toDataQueryResponse(res)	Parse the results from `/api/ds/query

Interfaces

Interface	Description
AngularComponent	Used to enable rendering of Angular components within a React component without losing proper typings.
AngularLoader	Used to load an Angular component from the context of a React component. Please see the AngularComponent for a proper example.
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 under the hood to handle all the communication.The request function can be used to perform a remote call by specifying a BackendSrvRequest. 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	Describes the basic dashboard information that can be passed as the meta analytics payload.
DashboardViewEventPayload	Describes the payload of a dashboard view event.
DataRequestEventPayload	Describes the payload of a data request event.
DataRequestInfo	Describes the data request information passed as the meta analytics payload.
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 that have a rich API for communicating with the datasource.
EchoBackend	Describes echo backends that can be registered to receive of events.
EchoEvent	Describes an echo event.
EchoMeta	Describes the meta information that are sent together with each event.
EchoSrv	Used to send events to all the registered backends. This should be accessed via the getEchoSrv() function. Will, by default, flush events to the backends every 10s or when the flush function is triggered.
FetchError	Error type for fetch function in BackendSrv
FetchErrorDataProps	Error type for fetch function in BackendSrv
FetchResponse	Response for fetch function in BackendSrv
HealthCheckResult	Describes the payload returned when checking the health of a data source plugin.
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
MetaAnalyticsEvent	Describes meta analytics event with predefined EchoEventType.MetaAnalytics type.
PluginCssOptions	Option to specify a plugin css that should be applied for the dark and the light theme.
SizeMeta	Describes a size with width/height
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	Use this to access the GrafanaBootConfig for the current running Grafana instance.
getBackendSrv	Used to retrieve the BackendSrv that can be used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc.
getGrafanaLiveSrv	Used to retrieve the GrafanaLiveSrv that allows you to subscribe to server side events and streams– experimental
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	Used to retrieve the TemplateSrv that can be used to fetch available template variables.
registerEchoBackend	Used to register echo backends that will receive Grafana echo events during application runtime.
reportMetaAnalytics	Helper function to report meta analytics to the EchoSrv.

Type Aliases

Type Alias	Description
BackendSrvRequest	Used to initiate a remote call via the BackendSrv
MetaAnalyticsEventPayload	Describes the meta analytics payload passed with the MetaAnalyticsEvent

@grafana/ui

Fri, 10 Apr 2026 18:31:50 +0000

@grafana/ui package

A library containing the different design components of the Grafana ecosystem.

Classes

Class	Description
ansicolor	Represents an ANSI-escaped string.
BarGauge
BigValue
Cascader
ClickOutsideWrapper
ClipboardButton
CustomScrollbar	Wraps component into component from `react-custom-scrollbars`
ErrorBoundary
ErrorBoundaryAlert
Gauge
Graph
GraphSeriesToggler
JsonExplorer	JsonExplorerJsonExplorer allows you to render JSON objects in HTML with a collapsible navigation.
JSONFormatter
List
ModalsProvider
PieChart
Popover
PopoverController
Portal
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
SetInterval
StatsPicker
StringArrayEditor
TableInputCSV	Expects the container div to have size set and will fill it 100%
TagsInput
ToggleButtonGroup
UnitPicker
VizRepeater

Enumerations

Enumeration	Description
AxisSide
BarGaugeDisplayMode
BigValueColorMode
BigValueGraphMode
BigValueJustifyMode
BigValueTextMode	Options for how the value & title are to be displayed
CompletionItemKind
EventsWithValidation
LegacyInputStatus
LegendDisplayMode
PieChartType
TableCellDisplayMode

Functions

Function	Description
AsyncMultiSelect(props)
AsyncSelect(props)
BracesPlugin()
ButtonSelect({ placeholder, icon, variant, size, className, disabled, …selectProps })
calculateFontSize(text, width, height, lineHeight, maxSize)	*(BETA)*
ClearPlugin()
ClipboardPlugin()
convertOldAngularValueMapping(panel)	Convert the angular single stat mapping to new react style
EventsCanvas({ id, events, renderEventMarker, mapEventToXYCoords })
FadeTransition(props)
Form({ defaultValues, onSubmit, validateOnMount, validateFieldsOnMount, children, validateOn, maxWidth, …htmlProps })
getScrollbarWidth()
getTagColor(index)
getTagColorsFromName(name)	Returns tag badge background and border colors based on hashed tag name.
getTextColorForBackground(color)
IndentationPlugin()
measureText(text, fontSize)	*(BETA)*
MultiSelect(props)
NewlinePlugin()
RadioButtonGroup({ options, value, onChange, disabled, disabledOptions, size, fullWidth, })
renderOrCallToRender(itemToRender, props)	Given react node or function returns element accordingly
resetSelectStyles()
RunnerPlugin({ handler })
Segment({ options, value, onChange, Component, className, allowCustomValue, placeholder, …rest })
SegmentAsync({ value, onChange, loadOptions, Component, className, allowCustomValue, placeholder, …rest })
SegmentInput({ value: initialValue, onChange, Component, className, placeholder, autofocus, …rest })
SegmentSelect({ value, options, onChange, onClickOutside, width, noOptionsMessage, allowCustomValue, …rest })
Select(props)
SelectionShortcutsPlugin()
sharedSingleStatMigrationHandler(panel)
sharedSingleStatPanelChangedHandler(panel, prevPluginId, prevOptions)
SlatePrism(optsParam)	A Slate plugin to highlight code syntax.
SlideOutTransition(props)
stylesFactory(stylesCreator)	Creates memoized version of styles creator
SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, })
TabbedContainer(props)
useStyles(getStyles)	Hook for using memoized styles with access to the theme.NOTE: For memoization to work, you need to ensure that the function you pass in doesn’t change, or only if it needs to. (i.e. declare your style creator outside of a function component or use `useCallback()`.)
useTheme()
ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, })

Interfaces

Interface	Description
BadgeProps
BigValueSparkline
CascaderOption
CompletionItem
CompletionItemGroup
ContextMenuGroup
ContextMenuItem
ContextMenuProps
FieldArrayApi
GraphCustomFieldConfig
GraphSeriesTogglerAPI
GraphTooltipOptions
LegendBasicOptions
LegendItem
LegendOptions
LegendRenderOptions
SingleStatBaseOptions
StyleProps
SuggestionsState
TabConfig
TableSortByFieldState
Themeable
Token
TypeaheadInput
TypeaheadOutput
ValidationEvents
ValidationRule
VizRepeaterRenderValueProps

Namespaces

Namespace	Description
DOMUtil
RadioButtonGroup
styleMixins

Variables

Variable	Description
Alert
AlphaNotice
AnnotationsEditorPlugin
Area
Axis
Badge
Button
ButtonCascader
CallToActionCard
Canvas
Chart
Checkbox
ClickPlugin
CodeEditor
CollapsableSection
Collapse
ColorPicker
colors
ConfirmButton
ConfirmModal
Container
ContextMenu
ContextMenuPlugin
ControlledCollapse
Counter
DataLinkInput
DataLinksContextMenu
DataLinksInlineEditor
DataSourceHttpSettings
defaultIntervals
DeleteButton
Drawer
EmptySearchResult
ErrorWithStack
FeatureInfoBox
Field
FieldArray
FieldConfigItemHeaderTitle
fieldMatchersUI
FieldSet
FieldValidationMessage
FileUpload
FilterPill
FullWidthButtonContainer
getAvailableIcons
getButtonStyles
getFormStyles
getLogRowStyles
getStandardFieldConfigs	Returns collection of common field config properties definitions
getStandardOptionEditors	Returns collection of standard option editors definitions
getTheme
GraphContextMenu
GraphLegend
GraphNG
graphTickFormatter
graphTimeFormat
GraphWithLegend
hasValidationEvent
HorizontalGroup
Icon
IconButton
InlineField
InlineFieldRow
InlineFormLabel
InlineLabel
Input
InputControl
Label
LegacyForms
Legend
LegendList
LegendPlugin
LegendTable
Line
LinkButton
linkModelToContextMenuItems	Delays creating links until we need to open the ContextMenu
LoadingPlaceholder
LogLabels
LogRows
makeFragment
makeValue
Marker
mockTheme
mockThemeContext	Enables theme context mocking
Modal
ModalHeader
ModalRoot
ModalsController
ModalTabContent
ModalTabsHeader
NumberValueEditor
Pagination
PanelOptionsGrid
PanelOptionsGroup
Point
RefreshPicker
regexValidation
Scale
SCHEMA
SelectionPlugin
selectThemeVariant
SeriesColorPicker
SeriesColorPickerPopover
SeriesColorPickerPopoverWithTheme
SeriesGeometry
SeriesIcon
Slider
sortedColors
Spinner
StringValueEditor
Switch
Tab
TabContent
Table
TabsBar
Tag
TagList
TextArea
ThemeContext
TimeOfDayPicker
TimeRangeInput
TimeRangePicker
TimeZonePicker
ToggleButton
Tooltip
TooltipContainer
TooltipPlugin
UPlotChart
usePlotConfigContext
usePlotContext
usePlotData
usePlotPluginContext
useRefreshAfterGraphRendered	Forces re-render of a component when uPlots’s draw hook is fired. This hook is usefull in scenarios when you want to reposition XYCanvas elements when i.e. plot size changes
validate
VerticalGroup
WithContextMenu
withTheme
XYCanvas	Renders absolutely positioned element on top of the uPlot’s plotting area (axes are not included!). Useful when you want to render some overlay with canvas-independent elements on top of the plot.
ZoomPlugin

Type Aliases

Type Alias	Description
AlertVariant
BadgeColor
ButtonProps
ButtonVariant
FormAPI
FormInputSize
IconName
IconSize
IconType
LegendPlacement
OnTagClick
PopoverContent
Renderable
RenderFunction