Files
Marcus Andersson 6bc369629d Docs: adding first version of the auto-generated packages API docs. (#22107)
* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added menu options.

* added parameters and return values.

* Fixed merge error.

* Added first version of auto-generated docs.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* updated api docs.

* lerna bootstrap.

* added eror to the ingore words list.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

* updated the autogenerated dosc.

* adding missing new line.
2020-02-26 10:03:53 +01:00

155 lines
3.1 KiB
Markdown

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FieldCache"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## FieldCache class
<b>Signature</b>
```typescript
export declare class FieldCache
```
<b>Import</b>
```typescript
import { FieldCache } from '@grafana/data';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(data)](#constructor-data) | | Constructs a new instance of the <code>FieldCache</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [fields](#fields-property) | | <code>FieldWithIndex[]</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [getFieldByName(name)](#getfieldbyname-method) | | Returns the first field with the given name. |
| [getFields(type)](#getfields-method) | | |
| [getFirstFieldOfType(type)](#getfirstfieldoftype-method) | | |
| [hasFieldNamed(name)](#hasfieldnamed-method) | | |
| [hasFieldOfType(type)](#hasfieldoftype-method) | | |
### constructor(data)
Constructs a new instance of the `FieldCache` class
<b>Signature</b>
```typescript
constructor(data: DataFrame);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| data | <code>DataFrame</code> | |
### fields property
<b>Signature</b>
```typescript
fields: FieldWithIndex[];
```
### getFieldByName method
Returns the first field with the given name.
<b>Signature</b>
```typescript
getFieldByName(name: string): FieldWithIndex | undefined;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
<b>Returns:</b>
`FieldWithIndex | undefined`
### getFields method
<b>Signature</b>
```typescript
getFields(type?: FieldType): FieldWithIndex[];
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>FieldType</code> | |
<b>Returns:</b>
`FieldWithIndex[]`
### getFirstFieldOfType method
<b>Signature</b>
```typescript
getFirstFieldOfType(type: FieldType): FieldWithIndex | undefined;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>FieldType</code> | |
<b>Returns:</b>
`FieldWithIndex | undefined`
### hasFieldNamed method
<b>Signature</b>
```typescript
hasFieldNamed(name: string): boolean;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
<b>Returns:</b>
`boolean`
### hasFieldOfType method
<b>Signature</b>
```typescript
hasFieldOfType(type: FieldType): boolean;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>FieldType</code> | |
<b>Returns:</b>
`boolean`