@grafana/schema on Grafana Labs

AxisConfig

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

AxisConfig interface

Signature

export interface AxisConfig

Import

import { AxisConfig } from '@grafana/schema';

Properties

Property	Type	Description
axisGridShow	`boolean`
axisLabel	`string`
axisPlacement	`AxisPlacement`
axisSoftMax	`number`
axisSoftMin	`number`
axisWidth	`number`
scaleDistribution	`ScaleDistributionConfig`

axisGridShow property

Signature

axisGridShow?: boolean;

axisLabel property

Signature

axisLabel?: string;

axisPlacement property

Signature

axisPlacement?: AxisPlacement;

axisSoftMax property

Signature

axisSoftMax?: number;

axisSoftMin property

Signature

axisSoftMin?: number;

axisWidth property

Signature

axisWidth?: number;

scaleDistribution property

Signature

scaleDistribution?: ScaleDistributionConfig;

AxisPlacement

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

AxisPlacement enum

Signature

export declare enum AxisPlacement

Import

import { AxisPlacement } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Auto	`"auto"`
Bottom	`"bottom"`
Hidden	`"hidden"`
Left	`"left"`
Right	`"right"`
Top	`"top"`

BarAlignment

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

BarAlignment enum

Signature

export declare enum BarAlignment

Import

import { BarAlignment } from '@grafana/schema';

Enumeration Members

Member	Value	Description
After	`1`
Before	`-1`
Center	`0`

BarConfig

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

BarConfig interface

Signature

export interface BarConfig

Import

import { BarConfig } from '@grafana/schema';

Properties

Property	Type	Description
barAlignment	`BarAlignment`
barMaxWidth	`number`
barWidthFactor	`number`

barAlignment property

Signature

barAlignment?: BarAlignment;

barMaxWidth property

Signature

barMaxWidth?: number;

barWidthFactor property

Signature

barWidthFactor?: number;

BarGaugeDisplayMode

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

BarGaugeDisplayMode enum

Signature

export declare enum BarGaugeDisplayMode

Import

import { BarGaugeDisplayMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Basic	`"basic"`
Gradient	`"gradient"`
Lcd	`"lcd"`

BigValueColorMode

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

BigValueColorMode enum

Signature

export declare enum BigValueColorMode

Import

import { BigValueColorMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Background	`"background"`
None	`"none"`
Value	`"value"`

BigValueGraphMode

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

BigValueGraphMode enum

Signature

export declare enum BigValueGraphMode

Import

import { BigValueGraphMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Area	`"area"`
Line	`"line"`
None	`"none"`

BigValueJustifyMode

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

BigValueJustifyMode enum

Signature

export declare enum BigValueJustifyMode

Import

import { BigValueJustifyMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Auto	`"auto"`
Center	`"center"`

BigValueTextMode

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

BigValueTextMode enum

Signature

export declare enum BigValueTextMode

Import

import { BigValueTextMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Auto	`"auto"`
Name	`"name"`
None	`"none"`
Value	`"value"`
Value_and_name	`"value_and_name"`

defaultTableFieldOptions

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

defaultTableFieldOptions variable

Signature

defaultTableFieldOptions: TableFieldOptions

Import

import { defaultTableFieldOptions } from '@grafana/schema';

FieldTextAlignment

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

FieldTextAlignment type

Signature

export declare type FieldTextAlignment = 'auto' | 'left' | 'right' | 'center';

Import

import { FieldTextAlignment } from '@grafana/schema';

FillConfig

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

FillConfig interface

Signature

export interface FillConfig

Import

import { FillConfig } from '@grafana/schema';

Properties

Property	Type	Description
fillBelowTo	`string`
fillColor	`string`
fillOpacity	`number`

fillBelowTo property

Signature

fillBelowTo?: string;

fillColor property

Signature

fillColor?: string;

fillOpacity property

Signature

fillOpacity?: number;

GraphDrawStyle

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

GraphDrawStyle enum

Signature

export declare enum GraphDrawStyle

Import

import { GraphDrawStyle } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Bars	`"bars"`
Line	`"line"`
Points	`"points"`

GraphFieldConfig

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

GraphFieldConfig interface

Signature

export interface GraphFieldConfig extends LineConfig, FillConfig, PointsConfig, AxisConfig, BarConfig, StackableFieldConfig, HideableFieldConfig

Import

import { GraphFieldConfig } from '@grafana/schema';

Properties

Property	Type	Description
drawStyle	`GraphDrawStyle`
gradientMode	`GraphGradientMode`
thresholdsStyle	`GraphThresholdsStyleConfig`
transform	`GraphTransform`

drawStyle property

Signature

drawStyle?: GraphDrawStyle;

gradientMode property

Signature

gradientMode?: GraphGradientMode;

thresholdsStyle property

Signature

thresholdsStyle?: GraphThresholdsStyleConfig;

transform property

Signature

transform?: GraphTransform;

GraphGradientMode

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

GraphGradientMode enum

Signature

export declare enum GraphGradientMode

Import

import { GraphGradientMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Hue	`"hue"`
None	`"none"`
Opacity	`"opacity"`
Scheme	`"scheme"`

GraphThresholdsStyleConfig

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

GraphThresholdsStyleConfig interface

Signature

export interface GraphThresholdsStyleConfig

Import

import { GraphThresholdsStyleConfig } from '@grafana/schema';

Properties

Property	Type	Description
mode	`GraphTresholdsStyleMode`

mode property

Signature

mode: GraphTresholdsStyleMode;

GraphTransform

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

GraphTransform enum

Signature

export declare enum GraphTransform

Import

import { GraphTransform } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Constant	`"constant"`
NegativeY	`"negative-Y"`

GraphTresholdsStyleMode

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

GraphTresholdsStyleMode enum

Signature

export declare enum GraphTresholdsStyleMode

Import

import { GraphTresholdsStyleMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Area	`"area"`
Line	`"line"`
LineAndArea	`"line+area"`
Off	`"off"`
Series	`"series"`

HideableFieldConfig

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

HideableFieldConfig interface

Signature

export interface HideableFieldConfig

Import

import { HideableFieldConfig } from '@grafana/schema';

Properties

Property	Type	Description
hideFrom	`HideSeriesConfig`

hideFrom property

Signature

hideFrom?: HideSeriesConfig;

HideSeriesConfig

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

HideSeriesConfig interface

Signature

export interface HideSeriesConfig

Import

import { HideSeriesConfig } from '@grafana/schema';

Properties

Property	Type	Description
legend	`boolean`
tooltip	`boolean`
viz	`boolean`

legend property

Signature

legend: boolean;

tooltip property

Signature

tooltip: boolean;

viz property

Signature

viz: boolean;

LegendDisplayMode

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

LegendDisplayMode enum

Signature

export declare enum LegendDisplayMode

Import

import { LegendDisplayMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Hidden	`"hidden"`
List	`"list"`
Table	`"table"`

LegendPlacement

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

LegendPlacement type

Signature

export declare type LegendPlacement = 'bottom' | 'right';

Import

import { LegendPlacement } from '@grafana/schema';

LineConfig

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

LineConfig interface

Signature

export interface LineConfig

Import

import { LineConfig } from '@grafana/schema';

Properties

Property	Type	Description
lineColor	`string`
lineInterpolation	`LineInterpolation`
lineStyle	`LineStyle`
lineWidth	`number`
spanNulls	`boolean \| number`

lineColor property

Signature

lineColor?: string;

lineInterpolation property

Signature

lineInterpolation?: LineInterpolation;

lineStyle property

Signature

lineStyle?: LineStyle;

lineWidth property

Signature

lineWidth?: number;

spanNulls property

Signature

spanNulls?: boolean | number;

LineInterpolation

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

LineInterpolation enum

Signature

export declare enum LineInterpolation

Import

import { LineInterpolation } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Linear	`"linear"`
Smooth	`"smooth"`
StepAfter	`"stepAfter"`
StepBefore	`"stepBefore"`

LineStyle

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

LineStyle interface

Signature

export interface LineStyle

Import

import { LineStyle } from '@grafana/schema';

Properties

Property	Type	Description
dash	`number[]`
fill	`‘solid’ \| ‘dash’ \| ‘dot’ \| ‘square’`

dash property

Signature

dash?: number[];

fill property

Signature

fill?: 'solid' | 'dash' | 'dot' | 'square';

OptionsWithLegend

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

OptionsWithLegend interface

Signature

export interface OptionsWithLegend

Import

import { OptionsWithLegend } from '@grafana/schema';

Properties

Property	Type	Description
legend	`VizLegendOptions`

legend property

Signature

legend: VizLegendOptions;

OptionsWithTextFormatting

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

OptionsWithTextFormatting interface

Signature

export interface OptionsWithTextFormatting

Import

import { OptionsWithTextFormatting } from '@grafana/schema';

Properties

Property	Type	Description
text	`VizTextDisplayOptions`

text property

Signature

text?: VizTextDisplayOptions;

OptionsWithTooltip

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

OptionsWithTooltip interface

Signature

export interface OptionsWithTooltip

Import

import { OptionsWithTooltip } from '@grafana/schema';

Properties

Property	Type	Description
tooltip	`VizTooltipOptions`

tooltip property

Signature

tooltip: VizTooltipOptions;

PointsConfig

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

PointsConfig interface

Signature

export interface PointsConfig

Import

import { PointsConfig } from '@grafana/schema';

Properties

Property	Type	Description
pointColor	`string`
pointSize	`number`
pointSymbol	`string`
showPoints	`VisibilityMode`

pointColor property

Signature

pointColor?: string;

pointSize property

Signature

pointSize?: number;

pointSymbol property

Signature

pointSymbol?: string;

showPoints property

Signature

showPoints?: VisibilityMode;

ReduceDataOptions

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

ReduceDataOptions interface

Signature

export interface ReduceDataOptions

Import

import { ReduceDataOptions } from '@grafana/schema';

Properties

Property	Type	Description
calcs	`string[]`
fields	`string`
limit	`number`
values	`boolean`

calcs property

Signature

calcs: string[];

fields property

Signature

fields?: string;

limit property

Signature

limit?: number;

values property

Signature

values?: boolean;

ScaleDirection

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

ScaleDirection enum

Signature

export declare enum ScaleDirection

Import

import { ScaleDirection } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Down	`-1`
Left	`-1`
Right	`1`
Up	`1`

ScaleDistribution

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

ScaleDistribution enum

Signature

export declare enum ScaleDistribution

Import

import { ScaleDistribution } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Linear	`"linear"`
Log	`"log"`
Ordinal	`"ordinal"`

ScaleDistributionConfig

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

ScaleDistributionConfig interface

Signature

export interface ScaleDistributionConfig

Import

import { ScaleDistributionConfig } from '@grafana/schema';

Properties

Property	Type	Description
log	`number`
type	`ScaleDistribution`

log property

Signature

log?: number;

type property

Signature

type: ScaleDistribution;

ScaleOrientation

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

ScaleOrientation enum

Signature

export declare enum ScaleOrientation

Import

import { ScaleOrientation } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Horizontal	`0`
Vertical	`1`

SingleStatBaseOptions

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

SingleStatBaseOptions interface

Signature

export interface SingleStatBaseOptions extends OptionsWithTextFormatting

Import

import { SingleStatBaseOptions } from '@grafana/schema';

Properties

Property	Type	Description
orientation	`VizOrientation`
reduceOptions	`ReduceDataOptions`

orientation property

Signature

orientation: VizOrientation;

reduceOptions property

Signature

reduceOptions: ReduceDataOptions;

SortOrder

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

SortOrder enum

Signature

export declare enum SortOrder

Import

import { SortOrder } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Ascending	`"asc"`
Descending	`"desc"`
None	`"none"`

StackableFieldConfig

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

StackableFieldConfig interface

Signature

export interface StackableFieldConfig

Import

import { StackableFieldConfig } from '@grafana/schema';

Properties

Property	Type	Description
stacking	`StackingConfig`

stacking property

Signature

stacking?: StackingConfig;

StackingConfig

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

StackingConfig interface

Signature

export interface StackingConfig

Import

import { StackingConfig } from '@grafana/schema';

Properties

Property	Type	Description
group	`string`
mode	`StackingMode`

group property

Signature

group?: string;

mode property

Signature

mode?: StackingMode;

StackingMode

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

StackingMode enum

Signature

export declare enum StackingMode

Import

import { StackingMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
None	`"none"`
Normal	`"normal"`
Percent	`"percent"`

TableCellDisplayMode

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

TableCellDisplayMode enum

Signature

export declare enum TableCellDisplayMode

Import

import { TableCellDisplayMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Auto	`"auto"`
BasicGauge	`"basic"`
ColorBackground	`"color-background"`
ColorBackgroundSolid	`"color-background-solid"`
ColorText	`"color-text"`
GradientGauge	`"gradient-gauge"`
Image	`"image"`
JSONView	`"json-view"`
LcdGauge	`"lcd-gauge"`

TableFieldOptions

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

TableFieldOptions interface

Signature

export interface TableFieldOptions

Import

import { TableFieldOptions } from '@grafana/schema';

Properties

Property	Type	Description
align	`string`
displayMode	`TableCellDisplayMode`
filterable	`boolean`
hidden	`boolean`
minWidth	`number`
width	`number`

align property

Signature

align: string;

displayMode property

Signature

displayMode: TableCellDisplayMode;

filterable property

Signature

filterable?: boolean;

hidden property

Signature

hidden?: boolean;

minWidth property

Signature

minWidth?: number;

width property

Signature

width?: number;

TableSortByFieldState

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

TableSortByFieldState interface

Signature

export interface TableSortByFieldState

Import

import { TableSortByFieldState } from '@grafana/schema';

Properties

Property	Type	Description
desc	`boolean`
displayName	`string`

desc property

Signature

desc?: boolean;

displayName property

Signature

displayName: string;

TooltipDisplayMode

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

TooltipDisplayMode enum

Signature

export declare enum TooltipDisplayMode

Import

import { TooltipDisplayMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Multi	`"multi"`
None	`"none"`
Single	`"single"`

VisibilityMode

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

VisibilityMode enum

Signature

export declare enum VisibilityMode

Import

import { VisibilityMode } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Always	`"always"`
Auto	`"auto"`
Never	`"never"`

VizLegendOptions

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

VizLegendOptions interface

Signature

export interface VizLegendOptions

Import

import { VizLegendOptions } from '@grafana/schema';

Properties

Property	Type	Description
asTable	`boolean`
calcs	`string[]`
displayMode	`LegendDisplayMode`
isVisible	`boolean`
placement	`LegendPlacement`
sortBy	`string`
sortDesc	`boolean`

asTable property

Signature

asTable?: boolean;

calcs property

Signature

calcs: string[];

displayMode property

Signature

displayMode: LegendDisplayMode;

isVisible property

Signature

isVisible?: boolean;

placement property

Signature

placement: LegendPlacement;

sortBy property

Signature

sortBy?: string;

sortDesc property

Signature

sortDesc?: boolean;

VizOrientation

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

VizOrientation enum

Signature

export declare enum VizOrientation

Import

import { VizOrientation } from '@grafana/schema';

Enumeration Members

Member	Value	Description
Auto	`"auto"`
Horizontal	`"horizontal"`
Vertical	`"vertical"`

VizTextDisplayOptions

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

VizTextDisplayOptions interface

Signature

export interface VizTextDisplayOptions

Import

import { VizTextDisplayOptions } from '@grafana/schema';

Properties

Property	Type	Description
titleSize	`number`
valueSize	`number`

titleSize property

Signature

titleSize?: number;

valueSize property

Signature

valueSize?: number;

VizTooltipOptions

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

VizTooltipOptions interface

Signature

export interface VizTooltipOptions

Import

import { VizTooltipOptions } from '@grafana/schema';

Properties

Property	Type	Description
mode	`TooltipDisplayMode`
sort	`SortOrder`

mode property

Signature

mode: TooltipDisplayMode;

sort property

Signature

sort: SortOrder;