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.
This commit is contained in:
@@ -11,7 +11,7 @@ type = "docs"
|
||||
|
||||
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/variables/templates-and-variables
|
||||
For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -27,10 +27,13 @@ import { TemplateSrv } from '@grafana/runtime';
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [getVariables()](#getvariables-method) | |
|
||||
| [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
|
||||
@@ -40,3 +43,24 @@ getVariables(): VariableModel[];
|
||||
|
||||
`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`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user