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

Docs: run the api-extractor on master to update docs (#23726)

Browse Source 
* regenerated packages docs.

* fixed spelling issues.

* fixed spelling issues.
This commit is contained in:
Marcus Andersson
2020-04-21 10:41:50 +02:00
committed by GitHub
parent 017767ae39
commit a2d741f60f
275 changed files with 6448 additions and 2193 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/packages_api/data/dataframeview.md
+1 -58
View File
@@ -18,7 +18,7 @@ This abstraction will present the contents of a DataFrame as if it were a well t
<b>Signature</b>
```typescript
export declare class DataFrameView<T = any> implements Vector<T>
export declare class DataFrameView<T = any> extends FunctionalVector<T>
```
<b>Import</b>
@@ -47,12 +47,9 @@ The [DataFrameView.get()](./data/dataframeview/get.md) is optimized for use in a
| Method | Modifiers | Description |
| --- | --- | --- |
| [forEachRow(iterator)](#foreachrow-method) | | <b><i>(BETA)</i></b> |
| [get(idx)](#get-method) | | <b><i>(BETA)</i></b> The contents of the object returned from this function are optimized for use in a loop. All calls return the same object but the index has changed. |
| [getFieldDisplayProcessor(colIndex)](#getfielddisplayprocessor-method) | | <b><i>(BETA)</i></b> Helper function to return the [DisplayProcessor](./data/displayprocessor.md) for a given field column. |
| [map(iterator)](#map-method) | | <b><i>(BETA)</i></b> |
| [toArray()](#toarray-method) | | <b><i>(BETA)</i></b> |
| [toJSON()](#tojson-method) | | <b><i>(BETA)</i></b> |
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
@@ -95,26 +92,6 @@ get length(): number;
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
### forEachRow method
<b>Signature</b>
```typescript
forEachRow(iterator: (row: T) => void): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| iterator | <code>(row: T) =&gt; void</code> | |
<b>Returns:</b>
`void`
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
### get method
The contents of the object returned from this function are optimized for use in a loop. All calls return the same object but the index has changed.
@@ -175,26 +152,6 @@ getFieldDisplayProcessor(colIndex: number): DisplayProcessor | null;
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
### map method
<b>Signature</b>
```typescript
map<V>(iterator: (item: T, index: number) => V): V[];
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| iterator | <code>(item: T, index: number) =&gt; V</code> | |
<b>Returns:</b>
`V[]`
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
### toArray method
<b>Signature</b>
@@ -206,17 +163,3 @@ toArray(): T[];
`T[]`
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
### toJSON method
<b>Signature</b>
```typescript
toJSON(): T[];
```
<b>Returns:</b>
`T[]`