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.

DocumentationGrafana documentationAPI 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

typescript Copy

export interface TemplateSrv 

Import

typescript Copy

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

Methods

containsTemplate method

Checks if a target contains template variables.

Signature

typescript Copy

containsTemplate(target?: string): boolean;

Parameters

Returns:

boolean

getVariables method

List the dashboard variables

Signature

typescript Copy

getVariables(): VariableModel[];

Returns:

VariableModel[]

replace method

Replace the values within the target string. See also

Signature

typescript Copy

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

Parameters

Returns:

string

updateTimeRange method

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

Signature

typescript Copy

updateTimeRange(timeRange: TimeRange): void;

Parameters

Returns:

void