Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.0/packages_api/runtime/templatesrv.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.0/packages_api/runtime/templatesrv/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
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.
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/v8.0/reference/templating
Signature
export interface TemplateSrv Import
import { TemplateSrv } from '@grafana/runtime';Methods
| Method | Description |
|---|---|
| getVariables() | List the dashboard variables |
| replace(target, scopedVars, format) | Replace the values within the target string. See also |
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