mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 16:32:15 +08:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "RegistryItemWithOptions"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## RegistryItemWithOptions interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface RegistryItemWithOptions<TOptions = any> extends RegistryItem
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { RegistryItemWithOptions } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [defaultOptions](#defaultoptions-property) | <code>TOptions</code> | Default options used if nothing else is specified |
|
|
| [getOptionsDisplayText](#getoptionsdisplaytext-property) | <code>(options: TOptions) => string</code> | Convert the options to a string |
|
|
|
|
### defaultOptions property
|
|
|
|
Default options used if nothing else is specified
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
defaultOptions?: TOptions;
|
|
```
|
|
|
|
### getOptionsDisplayText property
|
|
|
|
Convert the options to a string
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getOptionsDisplayText?: (options: TOptions) => string;
|
|
```
|