@ -1,5 +1,8 @@
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
import * as common from '@grafana/schema' ;
export interface DashboardV2Spec { export interface DashboardV2Spec {
// Unique numeric identifier for the dashboard.
// Unique numeric identifier for the dashboard.
// `id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances.
// `id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances.
@ -42,7 +45,7 @@ export interface DashboardV2Spec {
export const defaultDashboardV2Spec = ( ) : DashboardV2Spec = > ( { export const defaultDashboardV2Spec = ( ) : DashboardV2Spec = > ( {
title : "" , title : "" ,
cursorSync : DashboardCursorSync.Off , cursorSync : "Off" ,
preload : false , preload : false ,
editable : true , editable : true ,
links : [ ] , links : [ ] ,
@ -69,13 +72,9 @@ export const defaultAnnotationPanelFilter = (): AnnotationPanelFilter => ({
// "Off" for no shared crosshair or tooltip (default).
// "Off" for no shared crosshair or tooltip (default).
// "Crosshair" for shared crosshair.
// "Crosshair" for shared crosshair.
// "Tooltip" for shared crosshair AND shared tooltip.
// "Tooltip" for shared crosshair AND shared tooltip.
export enum DashboardCursorSync { export type DashboardCursorSync = "Off" | "Crosshair" | "Tooltip" ;
Off = "Off" ,
Crosshair = "Crosshair" ,
Tooltip = "Tooltip" ,
}
export const defaultDashboardCursorSync = ( ) : DashboardCursorSync = > ( DashboardCursorSync . Off ) ; export const defaultDashboardCursorSync = ( ) : DashboardCursorSync = > ( "Off" ) ;
// Links with references to other dashboards or external resources
// Links with references to other dashboards or external resources
export interface DashboardLink { export interface DashboardLink {
@ -104,7 +103,7 @@ export interface DashboardLink {
export const defaultDashboardLink = ( ) : DashboardLink = > ( { export const defaultDashboardLink = ( ) : DashboardLink = > ( {
title : "" , title : "" ,
type : DashboardLinkType . Link , type : "link" ,
icon : "" , icon : "" ,
tooltip : "" , tooltip : "" ,
tags : [ ] , tags : [ ] ,
@ -124,14 +123,6 @@ export interface DataSourceRef {
export const defaultDataSourceRef = ( ) : DataSourceRef = > ( { export const defaultDataSourceRef = ( ) : DataSourceRef = > ( {
} ) ; } ) ;
export enum DataTopic {
AlertStates = "alertStates" ,
Annotations = "annotations" ,
Series = "series" ,
}
export const defaultDataTopic = ( ) : DataTopic = > ( DataTopic . AlertStates ) ;
// Transformations allow to manipulate data returned by a query before the system applies a visualization.
// Transformations allow to manipulate data returned by a query before the system applies a visualization.
// Using transformations you can: rename fields, join time series data, perform mathematical operations across queries,
// Using transformations you can: rename fields, join time series data, perform mathematical operations across queries,
// use the output of one transformation as the input to another transformation, etc.
// use the output of one transformation as the input to another transformation, etc.
@ -143,7 +134,7 @@ export interface DataTransformerConfig {
// Optional frame matcher. When missing it will be applied to all results
// Optional frame matcher. When missing it will be applied to all results
filter? : MatcherConfig ; filter? : MatcherConfig ;
// Where to pull DataFrames from as input to transformation
// Where to pull DataFrames from as input to transformation
topic? : DataTopic ; topic? : common. DataTopic;
// Options to be passed to the transformer
// Options to be passed to the transformer
// Valid options depend on the transformer id
// Valid options depend on the transformer id
options : any ; options : any ;
@ -263,12 +254,9 @@ export const defaultThreshold = (): Threshold => ({
color : "" , color : "" ,
} ) ; } ) ;
export enum ThresholdsMode { export type ThresholdsMode = "absolute" | "percentage" ;
Absolute = "absolute" ,
Percentage = "percentage" ,
}
export const defaultThresholdsMode = ( ) : ThresholdsMode = > ( ThresholdsMode . Absolute ) ; export const defaultThresholdsMode = ( ) : ThresholdsMode = > ( "absolute" ) ;
export interface ThresholdsConfig { export interface ThresholdsConfig {
mode : ThresholdsMode ; mode : ThresholdsMode ;
@ -276,7 +264,7 @@ export interface ThresholdsConfig {
} }
export const defaultThresholdsConfig = ( ) : ThresholdsConfig = > ( { export const defaultThresholdsConfig = ( ) : ThresholdsConfig = > ( {
mode : ThresholdsMode.Absolute , mode : "absolute" ,
steps : [ ] , steps : [ ] ,
} ) ; } ) ;
@ -289,14 +277,9 @@ export const defaultValueMapping = (): ValueMapping => (defaultValueMap());
// `range`: Maps numerical ranges to a display text and color. For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number.
// `range`: Maps numerical ranges to a display text and color. For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number.
// `regex`: Maps regular expressions to replacement text and a color. For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain.
// `regex`: Maps regular expressions to replacement text and a color. For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain.
// `special`: Maps special values like Null, NaN (not a number), and boolean values like true and false to a display text and color. See SpecialValueMatch to see the list of special values. For example, you can configure a special value mapping so that null values appear as N/A.
// `special`: Maps special values like Null, NaN (not a number), and boolean values like true and false to a display text and color. See SpecialValueMatch to see the list of special values. For example, you can configure a special value mapping so that null values appear as N/A.
export enum MappingType { export type MappingType = "value" | "range" | "regex" | "special" ;
ValueToText = "value" ,
RangeToText = "range" ,
RegexToText = "regex" ,
SpecialValue = "special" ,
}
export const defaultMappingType = ( ) : MappingType = > ( MappingType . ValueToText ) ; export const defaultMappingType = ( ) : MappingType = > ( "value" ) ;
// Maps text values to a color or different display text and color.
// Maps text values to a color or different display text and color.
// For example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number.
// For example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number.
@ -372,22 +355,15 @@ export interface SpecialValueMap {
export const defaultSpecialValueMap = ( ) : SpecialValueMap = > ( { export const defaultSpecialValueMap = ( ) : SpecialValueMap = > ( {
type : "special" , type : "special" ,
options : { options : {
match : SpecialValueMatch.True , match : "true" ,
result : defaultValueMappingResult ( ) , result : defaultValueMappingResult ( ) ,
} , } ,
} ) ; } ) ;
// Special value types supported by the `SpecialValueMap`
// Special value types supported by the `SpecialValueMap`
export enum SpecialValueMatch { export type SpecialValueMatch = "true" | "false" | "null" | "nan" | "null+nan" | "empty" ;
True = "true" ,
False = "false" ,
Null = "null" ,
NotANumber = "nan" ,
NullAndNaN = "null+nan" ,
Empty = "empty" ,
}
export const defaultSpecialValueMatch = ( ) : SpecialValueMatch = > ( SpecialValueMatch . True ) ; export const defaultSpecialValueMatch = ( ) : SpecialValueMatch = > ( "true" ) ;
// Result used as replacement with text and color when the value matches
// Result used as replacement with text and color when the value matches
export interface ValueMappingResult { export interface ValueMappingResult {
@ -422,34 +398,14 @@ export const defaultValueMappingResult = (): ValueMappingResult => ({
// `continuous-purples`: Continuous Purple palette mode
// `continuous-purples`: Continuous Purple palette mode
// `shades`: Shades of a single color. Specify a single color, useful in an override rule.
// `shades`: Shades of a single color. Specify a single color, useful in an override rule.
// `fixed`: Fixed color mode. Specify a single color, useful in an override rule.
// `fixed`: Fixed color mode. Specify a single color, useful in an override rule.
export enum FieldColorModeId { export type FieldColorModeId = "thresholds" | "palette-classic" | "palette-classic-by-name" | "continuous-GrYlRd" | "continuous-RdYlGr" | "continuous-BlYlRd" | "continuous-YlRd" | "continuous-BlPu" | "continuous-YlBl" | "continuous-blues" | "continuous-reds" | "continuous-greens" | "continuous-purples" | "fixed" | "shades" ;
Thresholds = "thresholds" ,
PaletteClassic = "palette-classic" ,
PaletteClassicByName = "palette-classic-by-name" ,
ContinuousGrYlRd = "continuous-GrYlRd" ,
ContinuousRdYlGr = "continuous-RdYlGr" ,
ContinuousBlYlRd = "continuous-BlYlRd" ,
ContinuousYlRd = "continuous-YlRd" ,
ContinuousBlPu = "continuous-BlPu" ,
ContinuousYlBl = "continuous-YlBl" ,
ContinuousBlues = "continuous-blues" ,
ContinuousReds = "continuous-reds" ,
ContinuousGreens = "continuous-greens" ,
ContinuousPurples = "continuous-purples" ,
Fixed = "fixed" ,
Shades = "shades" ,
}
export const defaultFieldColorModeId = ( ) : FieldColorModeId = > ( FieldColorModeId . Thresholds ) ; export const defaultFieldColorModeId = ( ) : FieldColorModeId = > ( "thresholds" ) ;
// Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.
// Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.
export enum FieldColorSeriesByMode { export type FieldColorSeriesByMode = "min" | "max" | "last" ;
Min = "min" ,
Max = "max" ,
Last = "last" ,
}
export const defaultFieldColorSeriesByMode = ( ) : FieldColorSeriesByMode = > ( FieldColorSeriesByMode . Min ) ; export const defaultFieldColorSeriesByMode = ( ) : FieldColorSeriesByMode = > ( "min" ) ;
// Map a field to a color.
// Map a field to a color.
export interface FieldColor { export interface FieldColor {
@ -462,16 +418,13 @@ export interface FieldColor {
} }
export const defaultFieldColor = ( ) : FieldColor = > ( { export const defaultFieldColor = ( ) : FieldColor = > ( {
mode : FieldColorModeId.Thresholds , mode : "thresholds" ,
} ) ; } ) ;
// Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)
// Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)
export enum DashboardLinkType { export type DashboardLinkType = "link" | "dashboards" ;
Link = "link" ,
Dashboards = "dashboards" ,
}
export const defaultDashboardLinkType = ( ) : DashboardLinkType = > ( DashboardLinkType . Link ) ; export const defaultDashboardLinkType = ( ) : DashboardLinkType = > ( "link" ) ;
// --- Common types ---
// --- Common types ---
export interface Kind { export interface Kind {
@ -790,7 +743,7 @@ export interface CustomFormatterVariable {
export const defaultCustomFormatterVariable = ( ) : CustomFormatterVariable = > ( { export const defaultCustomFormatterVariable = ( ) : CustomFormatterVariable = > ( {
name : "" , name : "" ,
type : VariableType . Query , type : "query" ,
multi : false , multi : false ,
includeAll : false , includeAll : false ,
} ) ; } ) ;
@ -821,7 +774,7 @@ export const defaultVariableCustomFormatterFn = (): VariableCustomFormatterFn =>
value : { } , value : { } ,
legacyVariableModel : { legacyVariableModel : {
name : "" , name : "" ,
type : VariableType . Query , type : "query" ,
multi : false , multi : false ,
includeAll : false , includeAll : false ,
} , } ,
@ -836,20 +789,9 @@ export const defaultVariableCustomFormatterFn = (): VariableCustomFormatterFn =>
// `textbox`: Display a free text input field with an optional default value.
// `textbox`: Display a free text input field with an optional default value.
// `custom`: Define the variable options manually using a comma-separated list.
// `custom`: Define the variable options manually using a comma-separated list.
// `system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables
// `system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables
export enum VariableType { export type VariableType = "query" | "adhoc" | "groupby" | "constant" | "datasource" | "interval" | "textbox" | "custom" | "system" | "snapshot" ;
Query = "query" ,
Adhoc = "adhoc" ,
Groupby = "groupby" ,
Constant = "constant" ,
Datasource = "datasource" ,
Interval = "interval" ,
Textbox = "textbox" ,
Custom = "custom" ,
System = "system" ,
Snapshot = "snapshot" ,
}
export const defaultVariableType = ( ) : VariableType = > ( VariableType . Query ) ; export const defaultVariableType = ( ) : VariableType = > ( "query" ) ;
// Sort variable options
// Sort variable options
// Accepted values are:
// Accepted values are:
@ -863,41 +805,23 @@ export const defaultVariableType = (): VariableType => (VariableType.Query);
// `naturalAsc`: Natural ASC
// `naturalAsc`: Natural ASC
// `naturalDesc`: Natural DESC
// `naturalDesc`: Natural DESC
// VariableSort enum with default value
// VariableSort enum with default value
export enum VariableSort { export type VariableSort = "disabled" | "alphabeticalAsc" | "alphabeticalDesc" | "numericalAsc" | "numericalDesc" | "alphabeticalCaseInsensitiveAsc" | "alphabeticalCaseInsensitiveDesc" | "naturalAsc" | "naturalDesc" ;
Disabled = "disabled" ,
AlphabeticalAsc = "alphabeticalAsc" ,
AlphabeticalDesc = "alphabeticalDesc" ,
NumericalAsc = "numericalAsc" ,
NumericalDesc = "numericalDesc" ,
AlphabeticalCaseInsensitiveAsc = "alphabeticalCaseInsensitiveAsc" ,
AlphabeticalCaseInsensitiveDesc = "alphabeticalCaseInsensitiveDesc" ,
NaturalAsc = "naturalAsc" ,
NaturalDesc = "naturalDesc" ,
}
export const defaultVariableSort = ( ) : VariableSort = > ( VariableSort . Disabled ) ; export const defaultVariableSort = ( ) : VariableSort = > ( "disabled" ) ;
// Options to config when to refresh a variable
// Options to config when to refresh a variable
// `never`: Never refresh the variable
// `never`: Never refresh the variable
// `onDashboardLoad`: Queries the data source every time the dashboard loads.
// `onDashboardLoad`: Queries the data source every time the dashboard loads.
// `onTimeRangeChanged`: Queries the data source when the dashboard time range changes.
// `onTimeRangeChanged`: Queries the data source when the dashboard time range changes.
export enum VariableRefresh { export type VariableRefresh = "never" | "onDashboardLoad" | "onTimeRangeChanged" ;
Never = "never" ,
OnDashboardLoad = "onDashboardLoad" ,
OnTimeRangeChanged = "onTimeRangeChanged" ,
}
export const defaultVariableRefresh = ( ) : VariableRefresh = > ( VariableRefresh . Never ) ; export const defaultVariableRefresh = ( ) : VariableRefresh = > ( "never" ) ;
// Determine if the variable shows on dashboard
// Determine if the variable shows on dashboard
// Accepted values are `dontHide` (show label and value), `hideLabel` (show value only), `hideVariable` (show nothing).
// Accepted values are `dontHide` (show label and value), `hideLabel` (show value only), `hideVariable` (show nothing).
export enum VariableHide { export type VariableHide = "dontHide" | "hideLabel" | "hideVariable" ;
DontHide = "dontHide" ,
HideLabel = "hideLabel" ,
HideVariable = "hideVariable" ,
}
export const defaultVariableHide = ( ) : VariableHide = > ( VariableHide . DontHide ) ; export const defaultVariableHide = ( ) : VariableHide = > ( "dontHide" ) ;
// FIXME: should we introduce this? --- Variable value option
// FIXME: should we introduce this? --- Variable value option
export interface VariableValueOption { export interface VariableValueOption {
@ -950,13 +874,13 @@ export interface QueryVariableSpec {
export const defaultQueryVariableSpec = ( ) : QueryVariableSpec = > ( { export const defaultQueryVariableSpec = ( ) : QueryVariableSpec = > ( {
name : "" , name : "" ,
current : { text : "" , value : "" , } , current : { text : "" , value : "" , } ,
hide : VariableHide.DontHide , hide : "dontHide" ,
refresh : VariableRefresh.Never , refresh : "never" ,
skipUrlSync : false , skipUrlSync : false ,
datasource : defaultDataSourceRef ( ) , datasource : defaultDataSourceRef ( ) ,
query : "" , query : "" ,
regex : "" , regex : "" ,
sort : VariableSort.Disabled , sort : "disabled" ,
options : [ ] , options : [ ] ,
multi : false , multi : false ,
includeAll : false , includeAll : false ,
@ -988,7 +912,7 @@ export const defaultTextVariableSpec = (): TextVariableSpec => ({
name : "" , name : "" ,
current : { text : "" , value : "" , } , current : { text : "" , value : "" , } ,
query : "" , query : "" ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
@ -1018,7 +942,7 @@ export const defaultConstantVariableSpec = (): ConstantVariableSpec => ({
name : "" , name : "" ,
query : "" , query : "" ,
current : { text : "" , value : "" , } , current : { text : "" , value : "" , } ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
@ -1054,14 +978,14 @@ export interface DatasourceVariableSpec {
export const defaultDatasourceVariableSpec = ( ) : DatasourceVariableSpec = > ( { export const defaultDatasourceVariableSpec = ( ) : DatasourceVariableSpec = > ( {
name : "" , name : "" ,
pluginId : "" , pluginId : "" ,
refresh : VariableRefresh.Never , refresh : "never" ,
regex : "" , regex : "" ,
current : { text : "" , value : "" , } , current : { text : "" , value : "" , } ,
defaultOptionEnabled : false , defaultOptionEnabled : false ,
options : [ ] , options : [ ] ,
multi : false , multi : false ,
includeAll : false , includeAll : false ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
@ -1100,8 +1024,8 @@ export const defaultIntervalVariableSpec = (): IntervalVariableSpec => ({
auto : false , auto : false ,
auto_min : "" , auto_min : "" ,
auto_count : 0 , auto_count : 0 ,
refresh : VariableRefresh.Never , refresh : "never" ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
@ -1138,7 +1062,7 @@ export const defaultCustomVariableSpec = (): CustomVariableSpec => ({
options : [ ] , options : [ ] ,
multi : false , multi : false ,
includeAll : false , includeAll : false ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
@ -1175,7 +1099,7 @@ export const defaultGroupByVariableSpec = (): GroupByVariableSpec => ({
options : [ ] , options : [ ] ,
multi : false , multi : false ,
includeAll : false , includeAll : false ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
@ -1209,7 +1133,7 @@ export const defaultAdhocVariableSpec = (): AdhocVariableSpec => ({
baseFilters : [ ] , baseFilters : [ ] ,
filters : [ ] , filters : [ ] ,
defaultKeys : [ ] , defaultKeys : [ ] ,
hide : VariableHide.DontHide , hide : "dontHide" ,
skipUrlSync : false , skipUrlSync : false ,
} ) ; } ) ;
Kévin Gomez
8 months ago
committed by