| |
AnnotationEvent | |
| |
AnnotationEventUIModel | |
| This JSON object is stored in the dashboard json model. |
AnnotationQueryRequest | Options 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 | |
| |
BasicValueMatcherOptions | Describes 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. |
CartesianCoords2D | A 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 |
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. |
| 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 | |
| |
DateTimeOptions | The 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. |
DateTimeOptionsWithFormat | The 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 | |
| |
Dimensions2D | 2d object dimensions. |
| |
DisplayValueAlignmentFactors | These represents the display value with the longest title and text. Used to align widths and heights when displaying multiple DisplayValues |
| |
ExploreQueryFieldProps | |
| Describes available feature toggles in Grafana. These can be configured via the to enable features under development or not yet available in stable version. |
Field | |
| |
FieldColor | |
| |
FieldColorMode | (BETA) |
| Every property is optionalPlugins may extend this with additional properties. Something like series overrides |
FieldConfigEditorConfig | |
| |
FieldConfigPropertyItem | |
| |
FieldDisplay | |
| Like a field, but properties are optional and values may be a simple array |
FieldMatcherInfo | |
| |
FieldOverrideContext | |
| |
FieldReducerInfo | |
| |
FieldWithIndex | |
| |
FormattedValue | |
| |
GetFieldDisplayValuesOptions | |
| Describes all the different Grafana configuration values available for an instance. |
GrafanaTheme | |
| (BETA) Next gen theme model introduced in Grafana v8. |
GrafanaThemeCommons | |
| View model projection of a series |
GroupedTimeZones | |
| |
IntervalValues | |
| |
LegacyEmitter | |
| |
LegacyGraphHoverEventPayload | |
| Describes the license information about the current running instance of Grafana. |
LinkModel | Processed Link Model. The values are ready to use |
| Provides a way to produce links on demandTODO: ScopedVars in in GrafanaUI package! |
LiveChannelJoinEvent | |
| |
LiveChannelMessageEvent | |
| |
LogRowModel | |
| |
LogsMetaItem | |
| |
LogsParser | |
| |
MetadataInspectorProps | |
| |
MutableVector | Vector with standard manipulation functions |
| Interface used to describe different kinds of page titles and page navigation. Navmodels are usually generated in the backend and stored in Redux. |
NavModelBreadcrumb | |
| |
NumberFieldConfigSettings | |
| |
PanelData | |
| |
PanelModel | |
| |
PanelOptionsEditorItem | |
| |
PanelPluginDataSupport | |
| |
PanelProps | |
| |
PluginConfigPage | |
| |
PluginDependencies | |
| Describes error returned from Grafana plugins API call |
PluginInclude | |
| |
PluginMetaInfo | |
| |
QueryEditorProps | |
| |
QueryFixAction | |
| |
QueryResultBase | |
| |
QueryResultMetaNotice | QueryResultMetaNotice is a structure that provides user notices for query result data |
| |
RangeValueMatcherOptions | Describes a range value matcher option that has a to and a from value to be able to match a range. |
| |
ReadWriteVector | Apache arrow vectors are Read/Write |
| Options for how to turn DataFrames into an array of display values |
RegexpOrNamesMatcherOptions | |
| |
RegistryItemWithOptions | |
| Options for renameByRegexTransformer |
RenderMarkdownOptions | |
| |
ScopedVars | |
| |
SelectableValue | Used in select elements |
| |
SetFieldConfigOptionsArgs | (BETA) |
| |
StandardEditorContext | |
| |
StandardEditorsRegistryItem | |
| |
StringFieldConfigSettings | |
| |
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 | |
| |
ThresholdsConfig | Config that is passed to the ThresholdsEditor |
| |
TimeOption | |
| |
TimeRange | |
| |
TimeZoneCountry | |
| |
TraceSpanRow | This 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 | |
| |
ValueMatcherInfo | Registry item to represent all the different valu matchers supported in the Grafana platform. |
| Describes a empty value matcher option. |
VariableModel | |
| |
Vector | |
| |