API Reference on Grafana Labs

@grafana/data

Sat, 04 Apr 2026 12:26:57 +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
AsNumberVector	This will force all values to be numbers
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
IndexVector	IndexVector is a simple vector implementation that returns the index value for each element in the vector. It is functionally equivolant a vector backed by an array with values: `[0,1,2,…,length-1]`
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
ByNamesMatcherMode	Mode to be able to toggle if the names matcher should match fields in provided list or all except provided names.
CoreApp	The app container that is loading another plugin (panel or query editor)
CSVHeaderStyle
DashboardCursorSync
DataFrameType	See also: https://github.com/grafana/grafana-plugin-sdk-go/blob/main/data/frame_type.go
DataQueryErrorType
DataTopic	Attached to query results (not persisted)
DataTransformerID
ExploreMode
FieldColorModeId
FieldConfigProperty
FieldMatcherID
FieldType
FrameMatcherID	Field name matchers
GrafanaThemeType
InternalTimeZones
LayoutModes
LiveChannelConnectionState
LiveChannelEventType
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
MatcherID
NavMenuItemType
NavSection
NodeGraphDataFrameFieldNames
NullValueMode
OrgRole
PluginErrorCode	Describes error code returned from Grafana plugins API call
PluginIncludeType
PluginSignatureStatus	Describes status of plugin signature
PluginSignatureType	Describes level of plugin signature level
PluginState	Describes plugins life cycle status
PluginType	Describes type of plugin
ReducerID
ThresholdsMode	Display mode
ValueMatcherID
VariableOrigin
VariableSuggestionsScope
VizOrientation

Functions

Function	Description
addDurationToDate(date, duration)	addDurationToDate adds given duration to given date and returns a new Date object
addLogLevelToSeries(series, lineIndex)
anySeriesWithTimeField(data)	Indicates if there is any time field in the array of data frames
applyFieldOverrides(options)	Return a copy of the DataFrame with all rules applied
applyRawFieldOverrides(data)	Return a copy of the DataFrame with raw data
booleanValueFormatter(t, f)
calculateFieldStats(rows, extractor)
calculateLogsLabelStats(rows, label)
calculateStats(values)
compareArrayValues(a, b, cmp)	*(BETA)* Check if all values in two arrays match the compare funciton
compareDataFrameStructures(a, b, skipConfig)	*(BETA)* Returns true if both frames have the same name, fields, labels and configs.
doStandardCalcs(field, ignoreNulls, nullAsZero)
durationToMilliseconds(duration)	durationToMilliseconds convert a duration object to milliseconds
ensureTimeField(field, dateFormat)	Checks the first value. Assumes any number should be time fieldtype. Otherwise attempts to make the fieldtype time.
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)
getColorForTheme(color, theme)
getColorFromHexRgbOrName(color, type)
getDataFrameRow(data, row)	Wrapper to get an array from each field value
getDataSourceRef(ds)	Convert instance settings to a reference
getDataSourceUID(ref)	Get the UID from a string of reference
getDefaultRelativeTimeRange()	Returns the default realtive time range.
getDefaultTimeRange()
getDisplayProcessor(options)
getDisplayValueAlignmentFactors(values)
getFieldColorMode(mode)	*(BETA)*
getFieldColorModeForField(field)	*(BETA)*
getFieldDisplayName(field, frame, allFrames)
getFieldMatcher(config)	Resolves a field matcher from the registry for given config. Will throw an error if matcher can not be resolved.
getFieldTypeFromValue(v)	Check the field type to see what the contents are
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)	Resolves a frame matcher from the registry for given config. Will throw an error if matcher can not be resolved.
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()
getValueMatcher(config)	Resolves a value matcher from the registry for given config. Will throw an error if matcher can not be resolved.
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 typeNOTE: this is will try to see if string values can be mapped to other types (like number)
hasLinks(field)
intervalToAbbreviatedDurationString(interval, includeSeconds)	intervalToAbbreviatedDurationString converts interval to readable duration string
isBooleanUnit(unit)
isDataSourceRef(ref)	Returns true if the argument is a DataSourceRef
isLiveChannelJoinEvent(evt)
isLiveChannelLeaveEvent(evt)
isLiveChannelMessageEvent(evt)
isLiveChannelStatusEvent(evt)
isValidDate(dateString)	isValidDate returns true if given string can be parsed into valid Date object, false otherwise
isValidDuration(durationString)	isValidDuration returns true if the given string can be parsed into a valid Duration object, false otherwise
locale(value, decimals)
localTimeFormat(options, locale, fallback)	localTimeFormat helps to generate date formats for momentjs based on browser’s locale
makeClassES5Compatible(ES6Class)	*(BETA)* Proxies a ES6 class so that it can be used as a base class for an ES5 class
mapInternalLinkToExplore(options)
matchAllLabels(expect, against)	Check that all labels exist in another set of labels
outerJoinDataFrames(options)	This will return a single frame joined by the first matching field. When a join field is not specified, the default will use the first time field
parseDuration(durationString)	parseDuration parses duration string into datefns Duration object
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, options)
renderTextPanelMarkdown(str, options)
reverseDataFrame(data)	Returns a copy with all values reversed
scaledUnits(factor, extArray)
serializeStateToUrlParam(urlState, compact)	Create an string that is used in URL to represent the Explore state. This is basically just a stringified json that is that used as a state of a single Explore pane so it does not represent full Explore URL.
shallowCompare(a, b, cmp)	*(BETA)* Checks if two objects are equal shallowly
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
toFilteredDataFrameDTO(data, fieldPredicate)
toFixed(value, decimals)
toFixedScaled(value, decimals, 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
AnnotationEventUIModel
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
BasicValueMatcherOptions	Describes a basic value matcher option that has a single value.
BuildInfo	Describes the build information that will be available via the Grafana configuration.
BusEventType
ByNamesMatcherOptions	Options to instruct the by names matcher to either match all fields in given list or all except the fields in the list.
CartesianCoords2D	A coordinate on a two dimensional plane.
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
DataSourceRef
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
Dimensions2D	2d object dimensions.
DisplayValue
DisplayValueAlignmentFactors	These represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues
DynamicConfigValue
ExplorePanelsState
ExploreTracePanelState
FeatureToggles	Describes available feature toggles in Grafana. These can be configured via conf/custom.ini to enable features under development or not yet available in stable version.Only enabled values will be returned in this interface
Field
FieldCalcs
FieldColor
FieldColorConfigSettings
FieldColorMode	*(BETA)*
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
FieldNamePickerConfigSettings
FieldOverrideContext
FieldOverrideEditorProps
FieldReducerInfo
FieldSparkline
FieldWithIndex
FlotDataPoint
FormattedValue
FrameMatcherInfo
GetFieldDisplayValuesOptions
GrafanaConfig	Describes all the different Grafana configuration values available for an instance.
GrafanaTheme
GrafanaTheme2	*(BETA)* Next gen theme model introduced in Grafana v8.
GrafanaThemeCommons
GraphSeriesXY	View model projection of a series
GroupedTimeZones
HistoryItem
IntervalValues
Labels
LegacyEmitter
LegacyEventHandler
LegacyGraphHoverEventPayload
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
NumericRange
PanelData
PanelEditorProps
PanelModel
PanelOptionsEditorConfig
PanelOptionsEditorItem
PanelOptionsEditorProps
PanelPluginDataSupport
PanelPluginMeta
PanelProps
PluginBuildInfo
PluginConfigPage
PluginConfigPageProps
PluginDependencies
PluginError	Describes error returned from Grafana plugins API call
PluginInclude
PluginMeta
PluginMetaInfo
QueryEditorHelpProps
QueryEditorProps
QueryFix
QueryFixAction
QueryHint
QueryResultBase
QueryResultMeta
QueryResultMetaNotice	QueryResultMetaNotice is a structure that provides user notices for query result data
QueryResultMetaStat
RangeValueMatcherOptions	Describes a range value matcher option that has a to and a from value to be able to match a range.
RawTimeRange
ReadWriteVector	Apache arrow vectors are Read/Write
ReduceDataOptions	Options for how to turn DataFrames into an array of display values
RegexpOrNamesMatcherOptions
RegistryItem
RegistryItemWithOptions
RenameByRegexTransformerOptions	Options for renameByRegexTransformer
RenderMarkdownOptions
ScopedVar
ScopedVars
ScreenshotInfo
SelectableValue	Used in select elements
SelectFieldConfigSettings
SetFieldConfigOptionsArgs	*(BETA)*
SliderFieldConfigSettings
StandardEditorContext
StandardEditorProps
StandardEditorsRegistryItem
StatsPickerConfigSettings
StringFieldConfigSettings
SynchronousDataTransformerInfo	Many transformations can be called with a simple synchronous function. When a transformer is defined, it should have identical behavior to using the operator
SystemDateFormatSettings
TableData
TextMatch
ThemeBreakpoints	*(BETA)*
ThemeColors	*(BETA)*
ThemeShadows	*(BETA)*
ThemeShape	*(BETA)*
ThemeSpacing	*(BETA)* The different signatures imply different meaning for their arguments that can’t be expressed structurally. We express the difference with variable names. tslint:disable:unified-signatures
ThemeTypography	*(BETA)*
ThemeTypographyVariant
Threshold
ThresholdsConfig	Config that is passed to the ThresholdsEditor
ThresholdsFieldConfigSettings
TimeOption
TimeOptions
TimeRange
TimeSeries
TimeZoneCountry
TimeZoneInfo
TraceSpanRow	This describes the structure of the dataframe that should be returned from a tracing data source to show trace in a TraceView component.
TransformerRegistryItem
TransformerUIProps
UnitFieldConfigSettings
UserOrgDTO
ValueFormat
ValueFormatCategory
ValueFormatterIndex
ValueLinkConfig
ValueMappingFieldConfigSettings
ValueMatcherInfo	Registry item to represent all the different valu matchers supported in the Grafana platform.
ValueMatcherOptions	Describes a empty value matcher option.
VariableModel
VariableSuggestion
Vector
WithAccessControlMetadata	With FGAC, the backend will return additional access control metadata to objects. These metadata will contain user permissions associated to a given resource.For example: { accessControl: { “datasources:read”: true, “datasources:write”: true } }
YAxis

Namespaces

Namespace	Description
arrayUtils
colorManipulator
dateMath
rangeUtil

Variables

Variable	Description
AppEvents
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
DEFAULT_SAML_NAME
DefaultTimeZone
deprecationWarning
displayNameOverrideProcessor
escapeStringForRegex
escapeUnescapedString
FALLBACK_COLOR
fieldMatchers	Registry that contains all of the built in field matchers.
fieldReducers
frameMatchers	Registry that contains all of the built in frame matchers.
GAUGE_DEFAULT_MAXIMUM
GAUGE_DEFAULT_MINIMUM
getAllValuesFromDimension
getColumnFromDimension
getColumnsFromDimension
getDimensionByName
getFieldDisplayValues
getLocale
getLocaleData
getSeriesTimeStep	Returns minimal time step from series time field
getTimeField
getTimeZone	Used to get the current selected time zone. If a valid time zone is passed in the options it will be returned. If no valid time zone is passed either the time zone configured for the user account will be returned or the default for Grafana.
getTimeZoneGroups
getTimeZoneInfo
getTimeZones
getValueFromDimension
getWeekdayIndex
guessFieldTypes
hasMsResolution	Checks if series time field has ms resolution
identityOverrideProcessor
isDataFrame
isDateTime
ISO_8601
isTableData
locationUtil
LogsParsers
MISSING_VALUE
numberOverrideProcessor
objRemoveUndefined
onUpdateDatasourceJsonDataOption
onUpdateDatasourceJsonDataOptionChecked
onUpdateDatasourceJsonDataOptionSelect
onUpdateDatasourceOption
onUpdateDatasourceResetOption
onUpdateDatasourceSecureJsonDataOption
onUpdateDatasourceSecureJsonDataOptionSelect
PanelEvents
selectOverrideProcessor
setLocale
setWeekStart
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
toOption
toPascalCase
toUtc
unEscapeStringFromRegex
unitOverrideProcessor
updateDatasourcePluginJsonDataOption
updateDatasourcePluginResetOption
updateDatasourcePluginSecureJsonDataOption
urlUtil
valueMappingsOverrideProcessor
valueMatchers	Registry that contains all of the built in value matchers.
VAR_CALC
VAR_CELL_PREFIX
VAR_FIELD_LABELS
VAR_FIELD_NAME
VAR_SERIES_NAME

Type Aliases

Type Alias	Description
AlertErrorPayload
AlertPayload
AnnotationEventMappings
BinaryOperation
DataQueryResponseData
DataSourceOptionsType
DataSourceQueryType
DateTimeInput
DecimalCount
Dimensions
DisplayProcessor
DurationInput
DurationUnit
ExploreQueryFieldProps
FieldColorSeriesByMode	*(BETA)*
FieldMatcher
FormatInput
FrameMatcher
GraphSeriesValue
InterpolateFunction
KeyValue
LayoutMode
LegacyResponseData	Starting in v6.2 DataFrame can represent both TimeSeries and TableData
LinkTarget
LiveChannelEvent
MutableField
NavIndex
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
PreloadPlugin	Describes the plugins that should be preloaded prior to start Grafana.
SliderMarks
SplitOpen	SplitOpen type is used in Explore and related components.
StandardOptionConfig	*(BETA)*
ThemeBreakpointsKey	*(BETA)*
ThemeZIndices	*(BETA)*
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
TraceKeyValuePair	Type representing a tag in a trace span or fields of a log.
TraceLog	Type representing a log in a span.
UrlQueryMap	Type to represent the values parsed from the query string.
UrlQueryValue	Type to represent the value of a single query variable.
ValueConverter
ValueFormatter
ValueMatcher	Value matcher type to describe the matcher function
VariableType

@grafana/e2e

Sat, 04 Apr 2026 12:26:57 +0000

@grafana/e2e package

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

Variables

Variable	Description
e2e

@grafana/e2e-selectors

Sat, 04 Apr 2026 12:26:57 +0000

@grafana/e2e-selectors package

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

@grafana/runtime

Sat, 04 Apr 2026 12:26:57 +0000

@grafana/runtime package

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

Classes

Class	Description
CopyPanelEvent	Called to copy a panel JSON into local storage
DataSourceWithBackend	Extend this class to implement a data source plugin that is depending on the Grafana backend API.
GrafanaBootConfig
RefreshEvent	Called when a dashboard is refreshed
ThemeChangedEvent	Called when the theme settings change
TimeRangeUpdatedEvent	Called when time range is updated

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)	*(BETA)* 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.
getAppEvents()	Used to retrieve an event bus that manages application level events
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.
locationSearchToObject(search)	Parses a location search string to an object
logDebug(message, contexts)	Log a message at DEBUG level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
logError(err, contexts)	Log an error. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
logInfo(message, contexts)	Log a message at INFO level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
logWarning(message, contexts)	Log a message at WARNING level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
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, queries)	Parse the results from /api/ds/query into a DataQueryResponse

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.
AzureSettings
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.
ExperimentViewEchoEventPayload	Describes the payload of an experimentview event.
FetchError	Error type for fetch function in BackendSrv
FetchErrorDataProps	Error type for fetch function in BackendSrv
FetchResponse	Response for fetch function in BackendSrv
GetDataSourceListFilters
HealthCheckResult	Describes the payload returned when checking the health of a data source plugin.
InteractionEchoEventPayload	Describes the payload of a user interaction event.
LocationService	A wrapper to help work with browser location and history
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 type.
PageviewEchoEventPayload	Describes the payload of a pageview event.
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.
featureEnabled
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.
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.
isExperimentViewEvent	Experimentview event typeguard.
isInteractionEvent	Interaction event typeguard.
isPageviewEvent	Pageview event typeguard.
locationService
registerEchoBackend	Used to register echo backends that will receive Grafana echo events during application runtime.
reportExperimentView	Helper function to report experimentview events to the EchoSrv.
reportInteraction	Helper function to report interaction events to the EchoSrv.
reportMetaAnalytics	Helper function to report meta analytics to the EchoSrv.
reportPageview	Helper function to report pageview events to the EchoSrv.

Type Aliases

Type Alias	Description
BackendSrvRequest	Used to initiate a remote call via the BackendSrv
ExperimentViewEchoEvent	Describes experimentview event with predefined type.
HealthCheckResultDetails	Describes the details in the payload returned when checking the health of a data source plugin.If the ‘message’ key exists, this will be displayed in the error message in DataSourceSettingsPage If the ‘verboseMessage’ key exists, this will be displayed in the expandable details in the error message in DataSourceSettingsPage
InteractionEchoEvent	Describes interaction event with predefined type.
MetaAnalyticsEventPayload	Describes the meta analytics payload passed with the MetaAnalyticsEvent
PageviewEchoEvent	Describes pageview event with predefined type.
StreamOptionsProvider	This allows data sources to customize the streaming connection query

@grafana/schema

Sat, 04 Apr 2026 12:26:57 +0000

@grafana/schema package

A library containing most of the static shapes required by Grafana.

Enumerations

Enumeration	Description
AxisPlacement
BarAlignment
BarGaugeDisplayMode
BigValueColorMode
BigValueGraphMode
BigValueJustifyMode
BigValueTextMode
GraphDrawStyle
GraphGradientMode
GraphTransform
GraphTresholdsStyleMode
LegendDisplayMode
LineInterpolation
ScaleDirection
ScaleDistribution
ScaleOrientation
SortOrder
StackingMode
TableCellDisplayMode
TooltipDisplayMode
VisibilityMode
VizOrientation

Interfaces

Interface	Description
AxisConfig
BarConfig
FillConfig
GraphFieldConfig
GraphThresholdsStyleConfig
HideableFieldConfig
HideSeriesConfig
LineConfig
LineStyle
OptionsWithLegend
OptionsWithTextFormatting
OptionsWithTooltip
PointsConfig
ReduceDataOptions
ScaleDistributionConfig
SingleStatBaseOptions
StackableFieldConfig
StackingConfig
TableFieldOptions
TableSortByFieldState
VizLegendOptions
VizTextDisplayOptions
VizTooltipOptions

Variables

Variable	Description
defaultTableFieldOptions

Type Aliases

Type Alias	Description
FieldTextAlignment
LegendPlacement

@grafana/ui

Sat, 04 Apr 2026 12:26:57 +0000

@grafana/ui package

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

Classes

Class	Description
BarGauge
BigValue
Cascader
ClickOutsideWrapper
ErrorBoundary
ErrorBoundaryAlert
Gauge
Graph	This is a react wrapper for the angular, flot based graph visualization. Rather than using this component, you should use the `<PanelRender …/> with timeseries panel configs.
GraphNG	“Time as X” core component, expects ascending x
GraphSeriesToggler
JsonExplorer	JsonExplorerJsonExplorer allows you to render JSON objects in HTML with a collapsible navigation.
JSONFormatter
List
ModalsProvider
Popover
PopoverController
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.
RefreshPicker
SelectValueEditor
SetInterval
StatsPicker
StringArrayEditor
UnitPicker
UPlotConfigBuilder
VizRepeater

Enumerations

Enumeration	Description
BarGaugeDisplayMode
BigValueColorMode
BigValueGraphMode
BigValueJustifyMode
BigValueTextMode	Options for how the value & title are to be displayed
CompletionItemKind
EventsWithValidation
LegacyInputStatus
NodeGraphDataFrameFieldNames
SeriesVisibilityChangeBehavior

Functions

Function	Description
AlertingSettings({ alertmanagerDataSources, options, onOptionsChange, })
AsyncMultiSelect(props)
AsyncSelect(props)
BracesPlugin()
buildScaleKey(config)
calculateFontSize(text, width, height, lineHeight, maxSize)	*(BETA)*
ClearPlugin()
ClipboardButton({ onClipboardCopy, onClipboardError, children, getText, …buttonProps })
ClipboardPlugin()
convertOldAngularValueMapping(panel)
EmotionPerfTest()
EventsCanvas({ id, events, renderEventMarker, mapEventToXYCoords, config })
FadeTransition(props)
FileDropzone({ options, children, readAs, onLoad, fileListRenderer })
FileDropzoneDefaultChildren({ primaryText, secondaryText, })
FileListItem({ file: customFile, removeFile })
Form({ defaultValues, onSubmit, validateOnMount, validateFieldsOnMount, children, validateOn, maxWidth, …htmlProps })
getFieldTypeIcon(field)	Get the icon for a given field type
getScrollbarWidth()
getTagColor(index)
getTagColorsFromName(name)	Returns tag badge background and border colors based on hashed tag name.
getTextColorForBackground(color)
IndentationPlugin()
measureText(text, fontSize)	*(BETA)*
Modal(props)
MultiSelect(props)
NewlinePlugin()
Portal(props)
preparePlotFrame(frames, dimFields, timeRange)
RadioButtonGroup({ options, value, onChange, onClick, disabled, disabledOptions, size, className, fullWidth, autoFocus, })
resetSelectStyles(theme)
RunnerPlugin({ handler })
Segment({ options, value, onChange, Component, className, allowCustomValue, allowEmptyValue, placeholder, disabled, inputMinWidth, inputPlaceholder, onExpandedChange, autofocus, …rest })
SegmentAsync({ value, onChange, loadOptions, reloadOptionsOnChange, Component, className, allowCustomValue, allowEmptyValue, disabled, placeholder, inputMinWidth, inputPlaceholder, autofocus, onExpandedChange, noOptionMessageHandler, …rest })
SegmentInput({ value: initialValue, onChange, Component, className, placeholder, inputPlaceholder, disabled, autofocus, onExpandedChange, …rest })
Select(props)
SelectionShortcutsPlugin()
sharedSingleStatMigrationHandler(panel)
sharedSingleStatPanelChangedHandler(panel, prevPluginId, prevOptions)
SlatePrism(optsParam, prismLanguages)	A Slate plugin to highlight code syntax.
SlideOutTransition(props)
stylesFactory(stylesCreator)
SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, })
TabbedContainer(props)
useStyles(getStyles)
useStyles2(getStyles)
useTheme()
useTheme2()
ValuePicker({ label, icon, options, onChange, variant, minWidth, size, isFullWidth, menuPlacement, })
VizLegend({ items, displayMode, sortBy: sortKey, seriesVisibilityChangeBehavior, sortDesc, onLabelClick, onToggleSort, placement, className, itemRenderer, readonly, })
withErrorBoundary(Component, errorBoundaryProps)	HOC for wrapping a component in an error boundary.

Interfaces

Interface	Description
BadgeProps
CardContainerProps
CardProps
CascaderOption
CompletionItem
CompletionItemGroup
ConfirmModalProps
ContextMenuProps
CustomControlProps
DatePickerProps
DatePickerWithInputProps
DropzoneFile
ErrorBoundaryAlertProps	Props for the ErrorBoundaryAlert component
FieldArrayApi
FileDropzoneProps
FileListItemProps
GraphNGProps
GraphSeriesTogglerAPI
LoadingPlaceholderProps
MultiSelectCommonProps
PlotSelection
PluginSignatureBadgeProps
SelectableOptGroup
SelectAsyncProps
SelectBaseProps
SelectCommonProps
SelectContainerProps
SeriesTableProps
SeriesTableRowProps
SingleStatBaseOptions
SuggestionsState
TabConfig
TableSortByFieldState
Themeable
Themeable2
TimeRangePickerProps
Token
TypeaheadInput
TypeaheadOutput
ValidationEvents
ValidationRule
VizLayoutComponentType	*(BETA)*
VizLayoutLegendProps	*(BETA)*
VizLayoutProps	*(BETA)*
VizLegendItem
VizRepeaterRenderValueProps

Namespaces

Namespace	Description
commonOptionsBuilder
DOMUtil
Modal
RadioButtonGroup
ReactUtils
styleMixins
VizLegend

Variables

Variable	Description
Alert
Badge
Button
ButtonCascader
ButtonGroup
ButtonSelect
CallToActionCard
Card	Generic card component
CardContainer
CertificationKey
Checkbox
CodeEditor
CollapsableSection
Collapse
ColorPicker
colors
ConfirmButton
ConfirmModal
Container
ContextMenu
ControlledCollapse
Counter
CustomScrollbar	Wraps component into component from `react-custom-scrollbars`
DataLinkInput
DataLinksContextMenu
DataLinksInlineEditor
DataSourceHttpSettings
DatePicker
DatePickerWithInput
DateTimePicker
defaultIntervals
DeleteButton
Drawer
DropdownIndicator
EmptySearchResult
ErrorWithStack
FeatureBadge
FeatureInfoBox
Field
FieldArray
fieldMatchersUI
FieldSet
FieldValidationMessage
FileUpload
FilterInput
FilterPill
FormattedValueDisplay
FullWidthButtonContainer
getAvailableIcons
getCardStyles
getFormStyles
getInputStyles
getLogRowStyles
getSelectStyles
getStandardFieldConfigs	Returns collection of common field config properties definitions
getTheme
graphTickFormatter
graphTimeFormat
GraphWithLegend
hasValidationEvent
HorizontalGroup
Icon
IconButton
InfoBox
InlineField
InlineFieldRow
InlineFormLabel
InlineLabel
InlineSegmentGroup	*(BETA)*
InlineSwitch
Input
InputControl
Label
LegacyForms
Legend
LinkButton
linkModelToContextMenuItems	Delays creating links until we need to open the ContextMenu
LoadingPlaceholder
LogLabels
LogMessageAnsi
LogRows
makeFragment
makeValue
Marker
mockTheme
mockThemeContext
ModalRoot
ModalsController
ModalTabsHeader
NumberValueEditor
Pagination
PanelContextRoot
PlotLegend
PluginSignatureBadge
RangeSlider	RichHistoryQueriesTab uses this Range Component
regexValidation
SCHEMA
SelectContainer
selectOptionInTest
SeriesColorPicker
SeriesColorPickerPopover
SeriesColorPickerPopoverWithTheme
SeriesIcon
SeriesTable
SeriesTableRow
sharedInputStyle
Slider
SliderValueEditor
sortedColors
Spinner
StringValueEditor
Switch
Tab
TabContent
Table
TableInputCSV
TabsBar
Tag
TagList
TagsInput
TextArea
ThemeContext
TimeOfDayPicker
TimeRangeInput
TimeRangePicker
TimeSeries
TimeZonePicker
TLSAuthSettings
ToolbarButton
ToolbarButtonRow
Tooltip
UPLOT_AXIS_FONT_SIZE
validate
VerticalGroup
VizLayout	*(BETA)*
VizTooltip
VizTooltipContainer
WeekStartPicker
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.

Type Aliases

Type Alias	Description
ActionMeta
AlertVariant
BadgeColor
ButtonProps
ButtonVariant
CodeEditorMonacoOptions
ControlComponent
FormAPI
FormInputSize
IconButtonVariant
IconName
IconSize
IconType
InputActionMeta
Monaco
MonacoEditor
OnTagClick
PopoverContent
Renderable
RenderFunction
ScrollbarPosition
SelectOptions
SelectValue