Marcus Andersson
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.
72 lines
1.8 KiB
Markdown
72 lines
1.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "FieldPropertyEditorItem"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## FieldPropertyEditorItem interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface FieldPropertyEditorItem<TValue = any, TSettings = any> extends RegistryItem
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { FieldPropertyEditorItem } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [editor](#editor-property) | <code>ComponentType<FieldConfigEditorProps<TValue, TSettings>></code> | |
|
|
| [override](#override-property) | <code>ComponentType<FieldOverrideEditorProps<TValue, TSettings>></code> | |
|
|
| [process](#process-property) | <code>(value: any, context: FieldOverrideContext, settings: TSettings) => TValue</code> | |
|
|
| [settings](#settings-property) | <code>TSettings</code> | |
|
|
| [shouldApply](#shouldapply-property) | <code>(field: Field) => boolean</code> | |
|
|
|
|
### editor property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
editor: ComponentType<FieldConfigEditorProps<TValue, TSettings>>;
|
|
```
|
|
|
|
### override property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
override: ComponentType<FieldOverrideEditorProps<TValue, TSettings>>;
|
|
```
|
|
|
|
### process property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
process: (value: any, context: FieldOverrideContext, settings: TSettings) => TValue;
|
|
```
|
|
|
|
### settings property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
settings: TSettings;
|
|
```
|
|
|
|
### shouldApply property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
shouldApply: (field: Field) => boolean;
|
|
```
|