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:
@@ -37,9 +37,10 @@ import { FieldCache } from '@grafana/data';
|
||||
| --- | --- | --- |
|
||||
| [getFieldByName(name)](#getfieldbyname-method) | | Returns the first field with the given name. |
|
||||
| [getFields(type)](#getfields-method) | | |
|
||||
| [getFirstFieldOfType(type)](#getfirstfieldoftype-method) | | |
|
||||
| [getFirstFieldOfType(type, includeHidden)](#getfirstfieldoftype-method) | | |
|
||||
| [hasFieldNamed(name)](#hasfieldnamed-method) | | |
|
||||
| [hasFieldOfType(type)](#hasfieldoftype-method) | | |
|
||||
| [hasFieldWithNameAndType(name, type)](#hasfieldwithnameandtype-method) | | |
|
||||
|
||||
### constructor(data)
|
||||
|
||||
@@ -105,13 +106,14 @@ getFields(type?: FieldType): FieldWithIndex[];
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getFirstFieldOfType(type: FieldType): FieldWithIndex | undefined;
|
||||
getFirstFieldOfType(type: FieldType, includeHidden?: boolean): FieldWithIndex | undefined;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| type | <code>FieldType</code> | |
|
||||
| includeHidden | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@@ -151,3 +153,21 @@ hasFieldOfType(type: FieldType): boolean;
|
||||
|
||||
`boolean`
|
||||
|
||||
### hasFieldWithNameAndType method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasFieldWithNameAndType(name: string, type: FieldType): boolean;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | <code>string</code> | |
|
||||
| type | <code>FieldType</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user