Classes

EnumerationDescription
BinaryOperationID
Mode to be able to toggle if the names matcher should match fields in provided list or all except provided names.
CoreApp
DashboardCursorSync
See also: https://github.com/grafana/grafana-plugin-sdk-go/blob/main/data/frame_type.go
DataTopicAttached to query results (not persisted)
ExploreMode
FieldConfigProperty
FieldType
Field name matchers
GrafanaThemeType
LayoutModes
LiveChannelEventType
Represent panel data loading state.
LogLevelMapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation.
LogsDedupStrategy
LogsSortOrder
NodeGraphDataFrameFieldNames
OrgRole
Describes error code returned from Grafana plugins API call
PluginIncludeType
Describes status of plugin signature
Describes level of plugin signature level
Describes plugins life cycle status
PluginTypeDescribes
ReducerID
Indicate if the frame is appened or replace– but runtime
ThresholdsModeDisplay mode
VariableOrigin
VizOrientation

Functions

InterfaceDescription
AnnotationEvent
AnnotationEventUIModel
This JSON object is stored in the dashboard json model.
AnnotationQueryRequestOptions passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md
Since Grafana 7.2This offers a generic approach to annotation processing
AppEvent
AppPluginMeta
BasicValueMatcherOptionsDescribes a basic value matcher option that has a single value.
Describes the build information that will be available via the Grafana configuration.
BusEventType
Options to instruct the by names matcher to either match all fields in given list or all except the fields in the list.
CartesianCoords2DA coordinate on a two dimensional plane.
ConfigOverrideRule
CSVConfig
CSVParseCallbacks
Describes and API for exposing panel specific data configurations.
DataFrame
Like a DataFrame, but fields may be a FieldDTO
DataLinkLink 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.
Callback info for DataLink click events
DataLinksFieldConfigSettings
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
DataQueryResponse
DataSourceConstructor
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
DataSourcePluginMeta
DataSourceSelectItem
Data Source instance edit model. This is returned from: /api/datasources
DataTransformerConfig
Function that transform data frames (AKA transformer)
DateTime
DateTimeDuration
DateTimeOptionsThe type describing date and time options. Used for all the helper functions available to parse or format date and time values.
The type that describes options that can be passed when parsing a date and time value.
DateTimeOptionsWithFormatThe type describing the options that can be passed to the helper function to control how the date and time value passed to the function is formatted.
DecimalInfo
Dimensions2D2d object dimensions.
DisplayValueAlignmentFactorsThese represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues
FeatureTogglesDescribes available feature toggles in Grafana. These can be configured via the to enable features under development or not yet available in stable version.
FieldCalcs
FieldColorConfigSettings
(BETA)
FieldConfigEvery property is optionalPlugins may extend this with additional properties. Something like series overrides
FieldConfigEditorProps
FieldConfigSource
FieldDTOLike a field, but properties are optional and values may be a simple array
FieldNamePickerConfigSettings
FieldOverrideEditorProps
FieldSparkline
FlotDataPoint
FrameMatcherInfo
GrafanaConfigDescribes all the different Grafana configuration values available for an instance.
GrafanaTheme2(BETA) Next gen theme model introduced in Grafana v8.
GraphSeriesXYView model projection of a series
HistoryItem
Labels
LegacyEventHandler
LicenseInfoDescribes the license information about the current running instance of Grafana.
Processed Link Model. The values are ready to use
LinkModelSupplierProvides a way to produce links on demandTODO: ScopedVars in in GrafanaUI package!
LiveChannelLeaveEvent
LogLabelStatsModel
LogSearchMatch
LogsModel
MatcherConfig
MetricFindValue
Vector with standard manipulation functions
NavModelInterface used to describe different kinds of page titles and page navigation. Navmodels are usually generated in the backend and stored in Redux.
NavModelItem
NumericRange
PanelEditorProps
PanelOptionsEditorConfig
PanelOptionsEditorProps
PanelPluginMeta
PluginBuildInfo
PluginConfigPageProps
PluginErrorDescribes error returned from Grafana plugins API call
PluginMeta
QueryEditorHelpProps
QueryFix
QueryHint
QueryResultMeta
QueryResultMetaNotice is a structure that provides user notices for query result data
QueryResultMetaStat
Describes a range value matcher option that has a to and a from value to be able to match a range.
RawTimeRange
Apache arrow vectors are Read/Write
ReduceDataOptionsOptions for how to turn DataFrames into an array of display values
RegistryItem
RenameByRegexTransformerOptionsOptions for renameByRegexTransformer
ScopedVar
ScreenshotInfo
Used in select elements
SelectFieldConfigSettings
(BETA)
SliderFieldConfigSettings
StandardEditorProps
StatsPickerConfigSettings
SynchronousDataTransformerInfoMany transformations can be called with a simple synchronous function. When a transformer is defined, it should have identical behavior to using the operator
TableData
ThemeBreakpoints(BETA)
(BETA)
ThemeShadows(BETA)
(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
(BETA)
ThemeTypographyVariant
ThresholdsConfigConfig that is passed to the ThresholdsEditor
TimeOption
TimeRange
TimeZoneCountry
TraceSpanRowThis describes the structure of the dataframe that should be returned from a tracing data source to show trace in a TraceView component.
TransformerUIProps
UserOrgDTO
ValueFormatCategory
ValueLinkConfig
ValueMatcherInfoRegistry item to represent all the different valu matchers supported in the Grafana platform.
Describes a empty value matcher option.
VariableModel
Vector

Namespaces

VariableDescription
AppEvents
booleanOverrideProcessor
classicColors
DataLinkBuiltInVars
dateTime
dateTimeFormatHelper 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 .
dateTimeFormatISOHelper 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 .
dateTimeFormatTimeAgoHelper 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 .
dateTimeFormatWithAbbrevationHelper 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 .
dateTimeForTimeZone
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.
DefaultTimeZone
displayNameOverrideProcessor
escapeUnescapedString
fieldMatchersRegistry that contains all of the built in field matchers.
frameMatchersRegistry that contains all of the built in frame matchers.
GAUGE_DEFAULT_MINIMUM
getColumnFromDimension
getDimensionByName
getLocale
getSeriesTimeStepReturns minimal time step from series time field
getTimeZoneUsed 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.
getTimeZoneInfo
getValueFromDimension
hasMsResolutionChecks if series time field has ms resolution
isDataFrame
ISO_8601
locationUtil
MISSING_VALUE
objRemoveUndefined
onUpdateDatasourceJsonDataOptionChecked
onUpdateDatasourceOption
onUpdateDatasourceSecureJsonDataOption
PanelEvents
setLocale
sortInDescendingOrder
sortLogsResult
standardFieldConfigEditorRegistry
standardTransformersRegistryRegistry of transformation options that can be driven by stored configuration files.
systemDateFormats
thresholdsOverrideProcessor
TIME_SERIES_METRIC_FIELD_NAME
TIME_SERIES_VALUE_FIELD_NAME
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.
toDuration
toPascalCase
unEscapeStringFromRegex
updateDatasourcePluginJsonDataOption
updateDatasourcePluginSecureJsonDataOption
valueMappingsOverrideProcessor
Registry that contains all of the built in value matchers.
VAR_CALC
VAR_FIELD_LABELS
VAR_SERIES_NAME

Type Aliases