Marcus Andersson
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
64 lines
1.8 KiB
Markdown
64 lines
1.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "FieldConfigPropertyItem"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## FieldConfigPropertyItem interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface FieldConfigPropertyItem<TOptions = any, TValue = any, TSettings extends {} = any> extends OptionsEditorItem<TOptions, TSettings, FieldConfigEditorProps<TValue, TSettings>, TValue>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { FieldConfigPropertyItem } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [isCustom](#iscustom-property) | <code>boolean</code> | true for plugin field config properties |
|
|
| [override](#override-property) | <code>ComponentType<FieldOverrideEditorProps<TValue, TSettings>></code> | |
|
|
| [process](#process-property) | <code>(value: any, context: FieldOverrideContext, settings?: TSettings) => TValue | undefined | null</code> | |
|
|
| [shouldApply](#shouldapply-property) | <code>(field: Field) => boolean</code> | |
|
|
|
|
### isCustom property
|
|
|
|
true for plugin field config properties
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
isCustom?: boolean;
|
|
```
|
|
|
|
### 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 | undefined | null;
|
|
```
|
|
|
|
### shouldApply property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
shouldApply: (field: Field) => boolean;
|
|
```
|