API Reference › @grafana/data

@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

Enumerations

Enumeration Description
BinaryOperationID
ColorScheme
CoreApp
CSVHeaderStyle
DataSourceStatus
DataTransformerID
ExploreMode
FieldColorMode
FieldConfigProperty
FieldMatcherID
FieldType
FrameMatcherID Field name matchers
GrafanaThemeType
InternalTimeZones
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
MappingType
MatcherID
NullValueMode
OrgRole
PluginIncludeType
PluginSignatureStatus
PluginState
PluginType
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
arrowTableToDataFrame(table)
base64StringToArrowTable(text)
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) Serializes the given labels to a string.
formattedValueToString(val)
getActiveThreshold(value, thresholds)
getDataFrameRow(data, row) Wrapper to get an array from each field value
getDecimalsForValue(value, decimalOverride)
getDisplayProcessor(options)
getDisplayValueAlignmentFactors(values)
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)
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)
locale(value, decimals)
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
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
AnnotationQueryRequest Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md
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
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
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!
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
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
ScaledValue
ScopedVar
ScopedVars
ScreenshotInfo
SelectableValue Used in select elements
SelectFieldConfigSettings
StandardEditorContext
StandardEditorProps
StandardEditorsRegistryItem
StringFieldConfigSettings
TableData
TextMatch
Threshold
ThresholdsConfig Config that is passed to the ThresholdsEditor
ThresholdsFieldConfigSettings
TimeOption
TimeOptions
TimeRange
TimeSeries
TimeZoneCountry
TimeZoneInfo
TransformerRegistyItem
TransformerUIProps
UnitFieldConfigSettings
UserOrgDTO
ValueFormat
ValueFormatCategory
ValueLinkConfig
ValueMap
ValueMappingFieldConfigSettings
VariableModel
VariableSuggestion
Vector
YAxis

Namespaces

Namespace Description
AppEvents
dateMath
PanelEvents
rangeUtil

Variables

Variable Description
binaryOperators
booleanOverrideProcessor
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. 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.
DEFAULT_DATE_TIME_FORMAT
DEFAULT_FIELD_DISPLAY_VALUES_LIMIT
DefaultTimeRange
DefaultTimeZone
deprecationWarning
escapeStringForRegex
fieldMatchers
fieldReducers
frameMatchers
getAllValuesFromDimension
getColorByName
getColorDefinition
getColorDefinitionByName
getColorForTheme
getColorFromHexRgbOrName
getColorName
getColumnFromDimension
getColumnsFromDimension
getDimensionByName
getFieldDisplayValues
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
MS_DATE_TIME_FORMAT
numberOverrideProcessor
objRemoveUndefined
onUpdateDatasourceJsonDataOption
onUpdateDatasourceJsonDataOptionChecked
onUpdateDatasourceJsonDataOptionSelect
onUpdateDatasourceOption
onUpdateDatasourceResetOption
onUpdateDatasourceSecureJsonDataOption
onUpdateDatasourceSecureJsonDataOptionSelect
selectOverrideProcessor
setLocale
standardEditorsRegistry
standardFieldConfigEditorRegistry
standardTransformers
standardTransformersRegistry Registry of transformation options that can be driven by stored configuration files.
stringOverrideProcessor
textUtil
thresholdsOverrideProcessor
TIME_FORMAT
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
BinaryOperation
Color
ColorDefinition
DataQueryResponseData
DataSourceOptionsType
DataSourceQueryType
DataTransformer Function that transform data frames (AKA transformer)
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
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
ScaleCalculator
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