Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Enterprise Open source

TemplateSrv interface

Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.

For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating

Signature

typescript
export interface TemplateSrv 

Import

typescript
import { TemplateSrv } from '@grafana/runtime';

Methods

MethodDescription
getVariables()List the dashboard variables
replace(target, scopedVars, format)Replace the values within the target string. See also
updateTimeRange(timeRange)Update the current time range to be used when interpolating __from / __to variables.

getVariables method

List the dashboard variables

Signature

typescript
getVariables(): VariableModel[];

Returns:

VariableModel[]

replace method

Replace the values within the target string. See also

Signature

typescript
replace(target?: string, scopedVars?: ScopedVars, format?: string | Function): string;

Parameters

ParameterTypeDescription
targetstring
scopedVarsScopedVars
formatstring | Function

Returns:

string

updateTimeRange method

Update the current time range to be used when interpolating __from / __to variables.

Signature

typescript
updateTimeRange(timeRange: TimeRange): void;

Parameters

ParameterTypeDescription
timeRangeTimeRange

Returns:

void