API Reference@grafana/runtimeTemplateSrv

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

export interface TemplateSrv 

Import

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

Methods

Method Description
containsTemplate(target) Checks if a target contains template variables.
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.

containsTemplate method

Checks if a target contains template variables.

Signature

containsTemplate(target?: string): boolean;

Parameters

Parameter Type Description
target string

Returns:

boolean

getVariables method

List the dashboard variables

Signature

getVariables(): VariableModel[];

Returns:

VariableModel[]

replace method

Replace the values within the target string. See also

Signature

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

Parameters

Parameter Type Description
target string
scopedVars ScopedVars
format string | Function

Returns:

string

updateTimeRange method

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

Signature

updateTimeRange(timeRange: TimeRange): void;

Parameters

Parameter Type Description
timeRange TimeRange

Returns:

void