mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 07:32:13 +08:00
6bc369629d
* 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.
117 lines
2.3 KiB
Markdown
117 lines
2.3 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "CSVReader"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## CSVReader class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class CSVReader
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { CSVReader } from '@grafana/data';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>CSVReader</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [callback](#callback-property) | | <code>CSVParseCallbacks</code> | |
|
|
| [config](#config-property) | | <code>CSVConfig</code> | |
|
|
| [current](#current-property) | | <code>MutableDataFrame</code> | |
|
|
| [data](#data-property) | | <code>MutableDataFrame[]</code> | |
|
|
| [state](#state-property) | | <code>ParseState</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [readCSV(text)](#readcsv-method) | | |
|
|
|
|
### constructor(options)
|
|
|
|
Constructs a new instance of the `CSVReader` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(options?: CSVOptions);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| options | <code>CSVOptions</code> | |
|
|
|
|
### callback property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
callback?: CSVParseCallbacks;
|
|
```
|
|
|
|
### config property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
config: CSVConfig;
|
|
```
|
|
|
|
### current property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
current: MutableDataFrame;
|
|
```
|
|
|
|
### data property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
data: MutableDataFrame[];
|
|
```
|
|
|
|
### state property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
state: ParseState;
|
|
```
|
|
|
|
### readCSV method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
readCSV(text: string): MutableDataFrame[];
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| text | <code>string</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`MutableDataFrame[]`
|
|
|