grafana/docs/sources/packages_api/data/logrowmodel.md

179 lines
3.1 KiB
Markdown
Raw Normal View History

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 17:03:53 +08:00
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LogRowModel"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## LogRowModel interface
<b>Signature</b>
```typescript
export interface LogRowModel
```
<b>Import</b>
```typescript
import { LogRowModel } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [dataFrame](#dataframe-property) | <code>DataFrame</code> | |
| [duplicates](#duplicates-property) | <code>number</code> | |
| [entry](#entry-property) | <code>string</code> | |
| [entryFieldIndex](#entryfieldindex-property) | <code>number</code> | |
| [hasAnsi](#hasansi-property) | <code>boolean</code> | |
| [labels](#labels-property) | <code>Labels</code> | |
| [logLevel](#loglevel-property) | <code>LogLevel</code> | |
| [raw](#raw-property) | <code>string</code> | |
| [rowIndex](#rowindex-property) | <code>number</code> | |
| [searchWords](#searchwords-property) | <code>string[]</code> | |
| [timeEpochMs](#timeepochms-property) | <code>number</code> | |
| [timeEpochNs](#timeepochns-property) | <code>string</code> | |
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 17:03:53 +08:00
| [timeFromNow](#timefromnow-property) | <code>string</code> | |
| [timeLocal](#timelocal-property) | <code>string</code> | |
| [timeUtc](#timeutc-property) | <code>string</code> | |
| [uid](#uid-property) | <code>string</code> | |
| [uniqueLabels](#uniquelabels-property) | <code>Labels</code> | |
### dataFrame property
<b>Signature</b>
```typescript
dataFrame: DataFrame;
```
### duplicates property
<b>Signature</b>
```typescript
duplicates?: number;
```
### entry property
<b>Signature</b>
```typescript
entry: string;
```
### entryFieldIndex property
<b>Signature</b>
```typescript
entryFieldIndex: number;
```
### hasAnsi property
<b>Signature</b>
```typescript
hasAnsi: boolean;
```
### labels property
<b>Signature</b>
```typescript
labels: Labels;
```
### logLevel property
<b>Signature</b>
```typescript
logLevel: LogLevel;
```
### raw property
<b>Signature</b>
```typescript
raw: string;
```
### rowIndex property
<b>Signature</b>
```typescript
rowIndex: number;
```
### searchWords property
<b>Signature</b>
```typescript
searchWords?: string[];
```
### timeEpochMs property
<b>Signature</b>
```typescript
timeEpochMs: number;
```
### timeEpochNs property
<b>Signature</b>
```typescript
timeEpochNs: string;
```
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 17:03:53 +08:00
### timeFromNow property
<b>Signature</b>
```typescript
timeFromNow: string;
```
### timeLocal property
<b>Signature</b>
```typescript
timeLocal: string;
```
### timeUtc property
<b>Signature</b>
```typescript
timeUtc: string;
```
### uid property
<b>Signature</b>
```typescript
uid: string;
```
### uniqueLabels property
<b>Signature</b>
```typescript
uniqueLabels?: Labels;
```