public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: generated a 7.0 version of the packages reference docs. (#24708)

Browse Source 
* 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:
Marcus Andersson
2020-05-14 21:34:59 +02:00
committed by GitHub
parent 713fe39b1f
commit 6a0abf895e
78 changed files with 834 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/packages_api/data/field.md
+11 -11
View File
@@ -23,26 +23,16 @@ import { Field } from '@grafana/data';
| Property | Type | Description |
| --- | --- | --- |
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
| [config](#config-property) | <code>FieldConfig</code> | Meta info about how field and how to display it |
| [display](#display-property) | <code>DisplayProcessor</code> | Convert a value for display |
| [getLinks](#getlinks-property) | <code>(config: ValueLinkConfig) =&gt; Array&lt;LinkModel&lt;Field&gt;&gt;</code> | Get value data links with variables interpolated |
| [labels](#labels-property) | <code>Labels</code> | |
| [name](#name-property) | <code>string</code> | Name of the field (column) |
| [parse](#parse-property) | <code>(value: any) =&gt; T</code> | Convert text to the field value |
| [state](#state-property) | <code>FieldState &#124; null</code> | Cached values with appropriate display and id values |
| [type](#type-property) | <code>FieldType</code> | Field value type (string, number, etc) |
| [values](#values-property) | <code>V</code> | |
### calcs property
Cache of reduced values
<b>Signature</b>
```typescript
calcs?: FieldCalcs;
```
### config property
Meta info about how field and how to display it
@@ -101,6 +91,16 @@ Convert text to the field value
parse?: (value: any) => T;
```
### state property
Cached values with appropriate display and id values
<b>Signature</b>
```typescript
state?: FieldState | null;
```
### type property
Field value type (string, number, etc)