mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 14:12:24 +08:00
6a0abf895e
* 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.
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# 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
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface TemplateSrv
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { TemplateSrv } from '@grafana/runtime';
|
|
```
|
|
<b>Methods</b>
|
|
|
|
| Method | Description |
|
|
| --- | --- |
|
|
| [getVariables()](#getvariables-method) | List the dashboard variables |
|
|
| [replace(target, scopedVars, format)](#replace-method) | Replace the values within the target string. See also |
|
|
|
|
### getVariables method
|
|
|
|
List the dashboard variables
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getVariables(): VariableModel[];
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`VariableModel[]`
|
|
|
|
### replace method
|
|
|
|
Replace the values within the target string. See also
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
replace(target: string, scopedVars?: ScopedVars, format?: string | Function): string;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| target | <code>string</code> | |
|
|
| scopedVars | <code>ScopedVars</code> | |
|
|
| format | <code>string | Function</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`string`
|
|
|