grafana/docs/sources/packages_api/data/fieldstate.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

59 lines
1.3 KiB
Markdown

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FieldState"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## FieldState interface
<b>Signature</b>
```typescript
export interface FieldState
```
<b>Import</b>
```typescript
import { FieldState } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
| [displayName](#displayname-property) | <code>string &#124; null</code> | An appropriate name for the field (does not include frame info) |
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | Appropriate values for templating |
### calcs property
Cache of reduced values
<b>Signature</b>
```typescript
calcs?: FieldCalcs;
```
### displayName property
An appropriate name for the field (does not include frame info)
<b>Signature</b>
```typescript
displayName?: string | null;
```
### scopedVars property
Appropriate values for templating
<b>Signature</b>
```typescript
scopedVars?: ScopedVars;
```