IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-11 16:15:42 -06:00
Code Issues Packages Projects Releases Wiki Activity
8e56dd0279
grafana/docs/sources/packages_api/runtime/templatesrv.md
Marcus Andersson 6a0abf895e
Docs: generated a 7.0 version of the packages reference docs. (#24708) 
* fixes so we match the transformer based on name properly.

* changed the signature on the FieldMatcher.

* introduced a names option so you can filter in name specificly.

* changed so the matcher UI uses the new options format.

* moved the exported functions together.

* changing editors a bit.

* made the filter by name work with both regex and name filtering.

* fixed failing tests and make sure we always parse regex the same way.

* removed unused code.

* simplified to make the existing field overrides still working.

* fixed issue reported by hugo.

* added tests for the name matcher.

* added tests for filter by name.

* added more tests.

* generated new version of the packages docs.

* fixed spelling error.

* regenerated the docs.
2020-05-14 21:34:59 +02:00

1.6 KiB
Raw Blame History

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "TemplateSrv" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" +++

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