public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: adding first version of the auto-generated packages API docs. (#22107)

Browse Source 
* 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.
This commit is contained in:
Marcus Andersson
2020-02-26 10:03:53 +01:00
committed by GitHub
parent 89e6c45090
commit 6bc369629d
594 changed files with 30265 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/packages_api/ui/_index.md
+243
View File
@@ -0,0 +1,243 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "@grafana/ui"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## @grafana/ui package
A library containing the different design components of the Grafana ecosystem.
## Classes
| Class | Description |
| --- | --- |
| [ansicolor](./ansicolor/) | Represents an ANSI-escaped string. |
| [AsyncSelect](./asyncselect/) | |
| [BarGauge](./bargauge/) | |
| [BigValue](./bigvalue/) | |
| [ButtonSelect](./buttonselect/) | |
| [Cascader](./cascader/) | |
| [ClickOutsideWrapper](./clickoutsidewrapper/) | |
| [CustomScrollbar](./customscrollbar/) | Wraps component into <Scrollbars> component from <code>react-custom-scrollbars</code> |
| [ErrorBoundary](./errorboundary/) | |
| [ErrorBoundaryAlert](./errorboundaryalert/) | |
| [FieldDisplayEditor](./fielddisplayeditor/) | |
| [Gauge](./gauge/) | |
| [Graph](./graph/) | |
| [GraphSeriesToggler](./graphseriestoggler/) | |
| [Input](./input/) | |
| [JsonExplorer](./jsonexplorer/) | JsonExplorer<!-- -->JsonExplorer allows you to render JSON objects in HTML with a \*\*collapsible\*\* navigation. |
| [JSONFormatter](./jsonformatter/) | |
| [List](./list/) | |
| [PieChart](./piechart/) | |
| [Popover](./popover/) | |
| [PopoverController](./popovercontroller/) | |
| [Portal](./portal/) | |
| [QueryField](./queryfield/) | Renders an editor field. Pass initial value as initialQuery and listen to changes in props.onValueChanged. This component can only process strings. Internally it uses Slate Value. Implement props.onTypeahead to use suggestions, see PromQueryField.tsx as an example. |
| [Select](./select/) | |
| [SetInterval](./setinterval/) | |
| [StatsPicker](./statspicker/) | |
| [Switch](./switch/) | |
| [TableInputCSV](./tableinputcsv/) | Expects the container div to have size set and will fill it 100% |
| [TagsInput](./tagsinput/) | |
| [ThresholdsEditor](./thresholdseditor/) | |
| [ToggleButtonGroup](./togglebuttongroup/) | |
| [TransformationsEditor](./transformationseditor/) | |
| [UnitPicker](./unitpicker/) | |
| [ValueMappingsEditor](./valuemappingseditor/) | |
| [VizRepeater](./vizrepeater/) | |
## Enumerations
| Enumeration | Description |
| --- | --- |
| [BarGaugeDisplayMode](./bargaugedisplaymode/) | |
| [BigValueColorMode](./bigvaluecolormode/) | |
| [BigValueGraphMode](./bigvaluegraphmode/) | |
| [BigValueJustifyMode](./bigvaluejustifymode/) | |
| [CompletionItemKind](./completionitemkind/) | |
| [EventsWithValidation](./eventswithvalidation/) | |
| [InputStatus](./inputstatus/) | |
| [LegendDisplayMode](./legenddisplaymode/) | |
| [PieChartType](./piecharttype/) | |
## Functions
| Function | Description |
| --- | --- |
| [BracesPlugin()](./bracesplugin/) | |
| [calculateFontSize(text, width, height, lineHeight, maxSize)](./calculatefontsize/) | |
| [ClearPlugin()](./clearplugin/) | |
| [ClipboardPlugin()](./clipboardplugin/) | |
| [convertOldAngularValueMapping(panel)](./convertoldangularvaluemapping/) | Convert the angular single stat mapping to new react style |
| [FadeTransition(props)](./fadetransition/) | |
| [getTagColorsFromName(name)](./gettagcolorsfromname/) | Returns tag badge background and border colors based on hashed tag name. |
| [IndentationPlugin()](./indentationplugin/) | |
| [measureText(text, fontSize)](./measuretext/) | |
| [NewlinePlugin()](./newlineplugin/) | |
| [resetSelectStyles()](./resetselectstyles/) | |
| [RunnerPlugin({ handler })](./runnerplugin/) | |
| [Segment({ options, value, onChange, Component, className, allowCustomValue, placeholder, })](./segment/) | |
| [SegmentAsync({ value, onChange, loadOptions, Component, className, allowCustomValue, placeholder, })](./segmentasync/) | |
| [SegmentInput({ value: initialValue, onChange, Component, className, placeholder, autofocus, })](./segmentinput/) | |
| [SegmentSelect({ value, options, onChange, onClickOutside, width, noOptionsMessage, allowCustomValue, })](./segmentselect/) | |
| [SelectionShortcutsPlugin()](./selectionshortcutsplugin/) | |
| [sharedSingleStatMigrationHandler(panel)](./sharedsinglestatmigrationhandler/) | |
| [sharedSingleStatPanelChangedHandler(options, prevPluginId, prevOptions)](./sharedsinglestatpanelchangedhandler/) | |
| [SlatePrism(optsParam)](./slateprism/) | A Slate plugin to highlight code syntax. |
| [SlideOutTransition(props)](./slideouttransition/) | |
| [stylesFactory(stylesCreator)](./stylesfactory/) | Creates memoized version of styles creator |
| [SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, })](./suggestionsplugin/) | |
| [useTheme()](./usetheme/) | |
| [ValuePicker({ label, icon, options, onChange, variant })](./valuepicker/) | |
## Interfaces
| Interface | Description |
| --- | --- |
| [BigValueSparkline](./bigvaluesparkline/) | |
| [CascaderOption](./cascaderoption/) | |
| [CompletionItem](./completionitem/) | |
| [CompletionItemGroup](./completionitemgroup/) | |
| [ContextMenuGroup](./contextmenugroup/) | |
| [ContextMenuItem](./contextmenuitem/) | |
| [ContextMenuProps](./contextmenuprops/) | |
| [GraphSeriesTogglerAPI](./graphseriestogglerapi/) | |
| [GraphTooltipOptions](./graphtooltipoptions/) | |
| [LegendBasicOptions](./legendbasicoptions/) | |
| [LegendItem](./legenditem/) | |
| [LegendOptions](./legendoptions/) | |
| [LegendRenderOptions](./legendrenderoptions/) | |
| [NumberFieldConfigSettings](./numberfieldconfigsettings/) | |
| [SelectFieldConfigSettings](./selectfieldconfigsettings/) | |
| [SingleStatBaseOptions](./singlestatbaseoptions/) | |
| [StringFieldConfigSettings](./stringfieldconfigsettings/) | |
| [SuggestionsState](./suggestionsstate/) | |
| [Themeable](./themeable/) | |
| [TypeaheadInput](./typeaheadinput/) | |
| [TypeaheadOutput](./typeaheadoutput/) | |
| [ValidationEvents](./validationevents/) | |
| [ValidationRule](./validationrule/) | |
## Namespaces
| Namespace | Description |
| --- | --- |
| [DOMUtil](./domutil/) | |
| [styleMixins](./stylemixins/) | |
## Variables
| Variable | Description |
| --- | --- |
| [Alert](./alert/) | |
| [ALERTING\_COLOR](./alerting_color/) | |
| [AlphaNotice](./alphanotice/) | |
| [Button](./button/) | |
| [ButtonCascader](./buttoncascader/) | |
| [CallToActionCard](./calltoactioncard/) | |
| [Chart](./chart/) | |
| [Collapse](./collapse/) | |
| [ColorPicker](./colorpicker/) | |
| [colors](./colors/) | |
| [ConfirmButton](./confirmbutton/) | |
| [ConfirmModal](./confirmmodal/) | |
| [ContextMenu](./contextmenu/) | |
| [ControlledCollapse](./controlledcollapse/) | |
| [DataLinkBuiltInVars](./datalinkbuiltinvars/) | |
| [DataLinkInput](./datalinkinput/) | |
| [DataLinksContextMenu](./datalinkscontextmenu/) | |
| [DataLinksEditor](./datalinkseditor/) | |
| [DataSourceHttpSettings](./datasourcehttpsettings/) | |
| [DEFAULT\_ANNOTATION\_COLOR](./default_annotation_color/) | |
| [DeleteButton](./deletebutton/) | |
| [Drawer](./drawer/) | |
| [EmptySearchResult](./emptysearchresult/) | |
| [ErrorWithStack](./errorwithstack/) | |
| [fieldMatchersUI](./fieldmatchersui/) | |
| [FieldPropertiesEditor](./fieldpropertieseditor/) | |
| [FormField](./formfield/) | Default form field including label used in Grafana UI. Default input element is simple <input />. You can also pass custom inputEl if required in which case inputWidth and inputProps are ignored. |
| [FormLabel](./formlabel/) | |
| [Forms](./forms/) | |
| [FullWidthButtonContainer](./fullwidthbuttoncontainer/) | |
| [getLogRowStyles](./getlogrowstyles/) | |
| [getStandardFieldConfigs](./getstandardfieldconfigs/) | |
| [getTheme](./gettheme/) | |
| [GraphContextMenu](./graphcontextmenu/) | |
| [GraphLegend](./graphlegend/) | |
| [GraphWithLegend](./graphwithlegend/) | |
| [hasValidationEvent](./hasvalidationevent/) | |
| [HorizontalGroup](./horizontalgroup/) | |
| [Icon](./icon/) | |
| [IndicatorsContainer](./indicatorscontainer/) | |
| [LegendList](./legendlist/) | |
| [LegendTable](./legendtable/) | |
| [LinkButton](./linkbutton/) | |
| [linkModelToContextMenuItems](./linkmodeltocontextmenuitems/) | Delays creating links until we need to open the ContextMenu |
| [LoadingPlaceholder](./loadingplaceholder/) | |
| [LogLabels](./loglabels/) | |
| [LogRows](./logrows/) | |
| [makeFragment](./makefragment/) | |
| [makeValue](./makevalue/) | |
| [mockTheme](./mocktheme/) | |
| [mockThemeContext](./mockthemecontext/) | Enables theme context mocking |
| [Modal](./modal/) | |
| [NO\_DATA\_COLOR](./no_data_color/) | |
| [NoOptionsMessage](./nooptionsmessage/) | |
| [NumberOverrideEditor](./numberoverrideeditor/) | |
| [numberOverrideProcessor](./numberoverrideprocessor/) | |
| [NumberValueEditor](./numbervalueeditor/) | |
| [OK\_COLOR](./ok_color/) | |
| [PALETTE\_COLUMNS](./palette_columns/) | |
| [PALETTE\_ROWS](./palette_rows/) | |
| [PanelOptionsGrid](./paneloptionsgrid/) | |
| [PanelOptionsGroup](./paneloptionsgroup/) | |
| [PENDING\_COLOR](./pending_color/) | |
| [RefreshPicker](./refreshpicker/) | |
| [regexValidation](./regexvalidation/) | |
| [REGION\_FILL\_ALPHA](./region_fill_alpha/) | |
| [SCHEMA](./schema/) | |
| [SecretFormField](./secretformfield/) | Form field that has 2 states configured and not configured. If configured it will not show its contents and adds a reset button that will clear the input and makes it accessible. In non configured state it behaves like normal form field. This is used for passwords or anything that is encrypted on the server and is later returned encrypted to the user (like datasource passwords). |
| [SelectOverrideEditor](./selectoverrideeditor/) | |
| [selectOverrideProcessor](./selectoverrideprocessor/) | |
| [selectThemeVariant](./selectthemevariant/) | |
| [SelectValueEditor](./selectvalueeditor/) | |
| [SeriesColorPicker](./seriescolorpicker/) | |
| [SeriesColorPickerPopover](./seriescolorpickerpopover/) | |
| [SeriesColorPickerPopoverWithTheme](./seriescolorpickerpopoverwiththeme/) | |
| [SeriesIcon](./seriesicon/) | |
| [sortedColors](./sortedcolors/) | |
| [Spinner](./spinner/) | |
| [StringOverrideEditor](./stringoverrideeditor/) | |
| [stringOverrideProcessor](./stringoverrideprocessor/) | |
| [StringValueEditor](./stringvalueeditor/) | |
| [Tab](./tab/) | |
| [TabContent](./tabcontent/) | |
| [Table](./table/) | |
| [TabsBar](./tabsbar/) | |
| [ThemeContext](./themecontext/) | |
| [TimeOfDayPicker](./timeofdaypicker/) | |
| [TimePicker](./timepicker/) | |
| [ToggleButton](./togglebutton/) | |
| [Tooltip](./tooltip/) | |
| [TransformationRow](./transformationrow/) | |
| [transformersUIRegistry](./transformersuiregistry/) | |
| [validate](./validate/) | |
| [VerticalGroup](./verticalgroup/) | |
| [withTheme](./withtheme/) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [AlertVariant](./alertvariant/) | |
| [LegendPlacement](./legendplacement/) | |
| [PopoverContent](./popovercontent/) | |
| [Renderable](./renderable/) | |
| [RenderFunction](./renderfunction/) | |
docs/sources/packages_api/ui/alert.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Alert"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Alert variable
### Alert variable
<b>Signature</b>
```typescript
Alert: FC<AlertProps>
```
<b>Import</b>
```typescript
import { Alert } from '@grafana/ui';
```
docs/sources/packages_api/ui/alerting_color.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ALERTING_COLOR"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ALERTING\_COLOR variable
### ALERTING\_COLOR variable
<b>Signature</b>
```typescript
ALERTING_COLOR = "rgba(237, 46, 24, 1)"
```
<b>Import</b>
```typescript
import { ALERTING_COLOR } from '@grafana/ui';
```
docs/sources/packages_api/ui/alertvariant.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "AlertVariant"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## AlertVariant type
### AlertVariant type
<b>Signature</b>
```typescript
export declare type AlertVariant = 'success' | 'warning' | 'error' | 'info';
```
<b>Import</b>
```typescript
import { AlertVariant } from '@grafana/ui';
```
docs/sources/packages_api/ui/alphanotice.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "AlphaNotice"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## AlphaNotice variable
### AlphaNotice variable
<b>Signature</b>
```typescript
AlphaNotice: FC<Props>
```
<b>Import</b>
```typescript
import { AlphaNotice } from '@grafana/ui';
```
docs/sources/packages_api/ui/ansicolor.md
+212
View File
@@ -0,0 +1,212 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ansicolor"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ansicolor class
Represents an ANSI-escaped string.
<b>Signature</b>
```typescript
export default class Colors
```
<b>Import</b>
```typescript
import { ansicolor } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(s)](#constructor-s) | | Constructs a new instance of the <code>Colors</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [asChromeConsoleLogArguments](#aschromeconsolelogarguments-property) | | <code>any[]</code> | |
| [browserConsoleArguments](#browserconsolearguments-property) | | <code>any[]</code> | |
| [names](#names-property) | <code>static</code> | <code>(string &#124; number)[]</code> | |
| [nice](#nice-property) | <code>static</code> | <code>typeof Colors</code> | installs String prototype extensions |
| [parsed](#parsed-property) | | <code>Colors &amp; {</code><br/><code> spans: any[];</code><br/><code> }</code> | |
| [rgb](#rgb-property) | <code>static</code> | <code>{</code><br/><code> black: number[];</code><br/><code> darkGray: number[];</code><br/><code> lightGray: number[];</code><br/><code> white: number[];</code><br/><code> red: number[];</code><br/><code> lightRed: number[];</code><br/><code> green: number[];</code><br/><code> lightGreen: number[];</code><br/><code> yellow: number[];</code><br/><code> lightYellow: number[];</code><br/><code> blue: number[];</code><br/><code> lightBlue: number[];</code><br/><code> magenta: number[];</code><br/><code> lightMagenta: number[];</code><br/><code> cyan: number[];</code><br/><code> lightCyan: number[];</code><br/><code> }</code> | |
| [spans](#spans-property) | | <code>any[]</code> | |
| [str](#str-property) | | <code>any</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [\[Symbol.iterator\]()](#_symbol.iterator_-method) | | |
| [parse(s)](#parse-method) | <code>static</code> | parses a string containing ANSI escape codes {<!-- -->Colors<!-- -->} parsed representation. |
| [strip(s)](#strip-method) | <code>static</code> | strips ANSI codes from a string |
### constructor(s)
Constructs a new instance of the `Colors` class
<b>Signature</b>
```typescript
constructor(s?: string);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| s | <code>string</code> | |
### asChromeConsoleLogArguments property
<b>Signature</b>
```typescript
get asChromeConsoleLogArguments(): any[];
```
### browserConsoleArguments property
<b>Signature</b>
```typescript
get browserConsoleArguments(): any[];
```
### names property
<b>Signature</b>
```typescript
static names: (string | number)[];
```
### nice property
installs String prototype extensions
<b>Signature</b>
```typescript
static get nice(): typeof Colors;
```
## Example
require ('ansicolor').nice console.log ('foo'.bright.red)
### parsed property
<b>Signature</b>
```typescript
get parsed(): Colors & {
spans: any[];
};
```
### rgb property
<b>Signature</b>
```typescript
static rgb: {
black: number[];
darkGray: number[];
lightGray: number[];
white: number[];
red: number[];
lightRed: number[];
green: number[];
lightGreen: number[];
yellow: number[];
lightYellow: number[];
blue: number[];
lightBlue: number[];
magenta: number[];
lightMagenta: number[];
cyan: number[];
lightCyan: number[];
};
```
### spans property
<b>Signature</b>
```typescript
spans: any[];
```
### str property
<b>Signature</b>
```typescript
get str(): any;
```
### \[Symbol.iterator\] method
<b>Signature</b>
```typescript
[Symbol.iterator](): IterableIterator<any>;
```
<b>Returns:</b>
`IterableIterator<any>`
## Example
const spans = \[...ansi.parse ('<!-- -->\\<!-- -->u001b\[7m<!-- -->\\<!-- -->u001b\[7mfoo<!-- -->\\<!-- -->u001b\[7mbar<!-- -->\\<!-- -->u001b\[27m')\]
### parse method
parses a string containing ANSI escape codes {<!-- -->Colors<!-- -->} parsed representation.
<b>Signature</b>
```typescript
static parse(s: string): Colors & {
spans: any[];
};
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| s | <code>string</code> | |
<b>Returns:</b>
`Colors & {
spans: any[];
}`
### strip method
strips ANSI codes from a string
<b>Signature</b>
```typescript
static strip(s: string): string;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| s | <code>string</code> | |
<b>Returns:</b>
`string`
docs/sources/packages_api/ui/asyncselect.md
+53
View File
@@ -0,0 +1,53 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "AsyncSelect"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## AsyncSelect class
<b>Signature</b>
```typescript
export declare class AsyncSelect<T> extends PureComponent<AsyncProps<T>>
```
<b>Import</b>
```typescript
import { AsyncSelect } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;AsyncProps&lt;any&gt;&gt;</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<AsyncProps<any>>;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/bargauge.md
+107
View File
@@ -0,0 +1,107 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BarGauge"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BarGauge class
<b>Signature</b>
```typescript
export declare class BarGauge extends PureComponent<Props>
```
<b>Import</b>
```typescript
import { BarGauge } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;Props&gt;</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [getCellColor(positionValue)](#getcellcolor-method) | | |
| [render()](#render-method) | | |
| [renderBarAndValue()](#renderbarandvalue-method) | | |
| [renderBasicAndGradientBars()](#renderbasicandgradientbars-method) | | |
| [renderRetroBars()](#renderretrobars-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<Props>;
```
### getCellColor method
<b>Signature</b>
```typescript
getCellColor(positionValue: TimeSeriesValue): CellColors;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| positionValue | <code>TimeSeriesValue</code> | |
<b>Returns:</b>
`CellColors`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
### renderBarAndValue method
<b>Signature</b>
```typescript
renderBarAndValue(): React.ReactNode;
```
<b>Returns:</b>
`React.ReactNode`
### renderBasicAndGradientBars method
<b>Signature</b>
```typescript
renderBasicAndGradientBars(): ReactNode;
```
<b>Returns:</b>
`ReactNode`
### renderRetroBars method
<b>Signature</b>
```typescript
renderRetroBars(): ReactNode;
```
<b>Returns:</b>
`ReactNode`
docs/sources/packages_api/ui/bargaugedisplaymode.md
+33
View File
@@ -0,0 +1,33 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BarGaugeDisplayMode"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BarGaugeDisplayMode enum
### BarGaugeDisplayMode enum
<b>Signature</b>
```typescript
export declare enum BarGaugeDisplayMode
```
<b>Import</b>
```typescript
import { BarGaugeDisplayMode } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Basic | <code>&quot;basic&quot;</code> | |
| Gradient | <code>&quot;gradient&quot;</code> | |
| Lcd | <code>&quot;lcd&quot;</code> | |
docs/sources/packages_api/ui/bigvalue.md
+53
View File
@@ -0,0 +1,53 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BigValue"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BigValue class
<b>Signature</b>
```typescript
export declare class BigValue extends PureComponent<Props>
```
<b>Import</b>
```typescript
import { BigValue } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;Props&gt;</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<Props>;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/bigvaluecolormode.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BigValueColorMode"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BigValueColorMode enum
### BigValueColorMode enum
<b>Signature</b>
```typescript
export declare enum BigValueColorMode
```
<b>Import</b>
```typescript
import { BigValueColorMode } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Background | <code>&quot;background&quot;</code> | |
| Value | <code>&quot;value&quot;</code> | |
docs/sources/packages_api/ui/bigvaluegraphmode.md
+33
View File
@@ -0,0 +1,33 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BigValueGraphMode"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BigValueGraphMode enum
### BigValueGraphMode enum
<b>Signature</b>
```typescript
export declare enum BigValueGraphMode
```
<b>Import</b>
```typescript
import { BigValueGraphMode } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Area | <code>&quot;area&quot;</code> | |
| Line | <code>&quot;line&quot;</code> | |
| None | <code>&quot;none&quot;</code> | |
docs/sources/packages_api/ui/bigvaluejustifymode.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BigValueJustifyMode"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BigValueJustifyMode enum
### BigValueJustifyMode enum
<b>Signature</b>
```typescript
export declare enum BigValueJustifyMode
```
<b>Import</b>
```typescript
import { BigValueJustifyMode } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Auto | <code>&quot;auto&quot;</code> | |
| Center | <code>&quot;center&quot;</code> | |
docs/sources/packages_api/ui/bigvaluesparkline.md
+80
View File
@@ -0,0 +1,80 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BigValueSparkline"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BigValueSparkline interface
<b>Signature</b>
```typescript
export interface BigValueSparkline
```
<b>Import</b>
```typescript
import { BigValueSparkline } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [data](#data-property) | <code>GraphSeriesValue[][]</code> | |
| [highlightIndex](#highlightindex-property) | <code>number</code> | |
| [xMax](#xmax-property) | <code>number &#124; null</code> | |
| [xMin](#xmin-property) | <code>number &#124; null</code> | |
| [yMax](#ymax-property) | <code>number &#124; null</code> | |
| [yMin](#ymin-property) | <code>number &#124; null</code> | |
### data property
<b>Signature</b>
```typescript
data: GraphSeriesValue[][];
```
### highlightIndex property
<b>Signature</b>
```typescript
highlightIndex?: number;
```
### xMax property
<b>Signature</b>
```typescript
xMax?: number | null;
```
### xMin property
<b>Signature</b>
```typescript
xMin?: number | null;
```
### yMax property
<b>Signature</b>
```typescript
yMax?: number | null;
```
### yMin property
<b>Signature</b>
```typescript
yMin?: number | null;
```
docs/sources/packages_api/ui/bracesplugin.md
+28
View File
@@ -0,0 +1,28 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BracesPlugin"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## BracesPlugin() function
### BracesPlugin() function
<b>Signature</b>
```typescript
export declare function BracesPlugin(): Plugin;
```
<b>Import</b>
```typescript
import { BracesPlugin } from '@grafana/ui';
```
<b>Returns:</b>
`Plugin`
docs/sources/packages_api/ui/button.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Button"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Button variable
### Button variable
<b>Signature</b>
```typescript
Button: React.ForwardRefExoticComponent<CommonProps & React.ButtonHTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>
```
<b>Import</b>
```typescript
import { Button } from '@grafana/ui';
```
docs/sources/packages_api/ui/buttoncascader.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ButtonCascader"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ButtonCascader variable
### ButtonCascader variable
<b>Signature</b>
```typescript
ButtonCascader: React.FC<ButtonCascaderProps>
```
<b>Import</b>
```typescript
import { ButtonCascader } from '@grafana/ui';
```
docs/sources/packages_api/ui/buttonselect.md
+53
View File
@@ -0,0 +1,53 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ButtonSelect"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ButtonSelect class
<b>Signature</b>
```typescript
export declare class ButtonSelect<T> extends PureComponent<Props<T>>
```
<b>Import</b>
```typescript
import { ButtonSelect } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [onChange](#onchange-property) | | <code>(item: SelectableValue&lt;T&gt;) =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### onChange property
<b>Signature</b>
```typescript
onChange: (item: SelectableValue<T>) => void;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/calculatefontsize.md
+38
View File
@@ -0,0 +1,38 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "calculateFontSize"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## calculateFontSize() function
### calculateFontSize() function
<b>Signature</b>
```typescript
export declare function calculateFontSize(text: string, width: number, height: number, lineHeight: number, maxSize?: number): number;
```
<b>Import</b>
```typescript
import { calculateFontSize } from '@grafana/ui';
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| text | <code>string</code> | |
| width | <code>number</code> | |
| height | <code>number</code> | |
| lineHeight | <code>number</code> | |
| maxSize | <code>number</code> | |
<b>Returns:</b>
`number`
docs/sources/packages_api/ui/calltoactioncard.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CallToActionCard"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## CallToActionCard variable
### CallToActionCard variable
<b>Signature</b>
```typescript
CallToActionCard: React.FunctionComponent<CallToActionCardProps>
```
<b>Import</b>
```typescript
import { CallToActionCard } from '@grafana/ui';
```
docs/sources/packages_api/ui/cascader.md
+162
View File
@@ -0,0 +1,162 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Cascader"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Cascader class
<b>Signature</b>
```typescript
export declare class Cascader extends React.PureComponent<CascaderProps, CascaderState>
```
<b>Import</b>
```typescript
import { Cascader } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>Cascader</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [flattenOptions](#flattenoptions-property) | | <code>(options: CascaderOption[], optionPath?: CascaderOption[]) =&gt; SelectableValue&lt;string[]&gt;[]</code> | |
| [onBlur](#onblur-property) | | <code>() =&gt; void</code> | |
| [onBlurCascade](#onblurcascade-property) | | <code>() =&gt; void</code> | |
| [onChange](#onchange-property) | | <code>(value: string[], selectedOptions: CascaderOption[]) =&gt; void</code> | |
| [onClick](#onclick-property) | | <code>() =&gt; void</code> | |
| [onCreateOption](#oncreateoption-property) | | <code>(value: string) =&gt; void</code> | |
| [onInputKeyDown](#oninputkeydown-property) | | <code>(e: React.KeyboardEvent&lt;HTMLInputElement&gt;) =&gt; void</code> | |
| [onSelect](#onselect-property) | | <code>(obj: SelectableValue&lt;string[]&gt;) =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
| [setInitialValue(searchableOptions, initValue)](#setinitialvalue-method) | | |
### constructor(props)
Constructs a new instance of the `Cascader` class
<b>Signature</b>
```typescript
constructor(props: CascaderProps);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| props | <code>CascaderProps</code> | |
### flattenOptions property
<b>Signature</b>
```typescript
flattenOptions: (options: CascaderOption[], optionPath?: CascaderOption[]) => SelectableValue<string[]>[];
```
### onBlur property
<b>Signature</b>
```typescript
onBlur: () => void;
```
### onBlurCascade property
<b>Signature</b>
```typescript
onBlurCascade: () => void;
```
### onChange property
<b>Signature</b>
```typescript
onChange: (value: string[], selectedOptions: CascaderOption[]) => void;
```
### onClick property
<b>Signature</b>
```typescript
onClick: () => void;
```
### onCreateOption property
<b>Signature</b>
```typescript
onCreateOption: (value: string) => void;
```
### onInputKeyDown property
<b>Signature</b>
```typescript
onInputKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
```
### onSelect property
<b>Signature</b>
```typescript
onSelect: (obj: SelectableValue<string[]>) => void;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
### setInitialValue method
<b>Signature</b>
```typescript
setInitialValue(searchableOptions: Array<SelectableValue<string[]>>, initValue?: string): {
rcValue: string[];
activeLabel: any;
};
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| searchableOptions | <code>Array&lt;SelectableValue&lt;string[]&gt;&gt;</code> | |
| initValue | <code>string</code> | |
<b>Returns:</b>
`{
rcValue: string[];
activeLabel: any;
}`
docs/sources/packages_api/ui/cascaderoption.md
+84
View File
@@ -0,0 +1,84 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CascaderOption"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## CascaderOption interface
<b>Signature</b>
```typescript
export interface CascaderOption
```
<b>Import</b>
```typescript
import { CascaderOption } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [children](#children-property) | <code>CascaderOption[]</code> | Children will be shown in a submenu. Use 'items' instead, as 'children' exist to ensure backwards compatibility. |
| [disabled](#disabled-property) | <code>boolean</code> | |
| [items](#items-property) | <code>CascaderOption[]</code> | Items will be just flattened into the main list of items recursively. |
| [label](#label-property) | <code>string</code> | |
| [title](#title-property) | <code>string</code> | |
| [value](#value-property) | <code>any</code> | |
### children property
Children will be shown in a submenu. Use 'items' instead, as 'children' exist to ensure backwards compatibility.
<b>Signature</b>
```typescript
children?: CascaderOption[];
```
### disabled property
<b>Signature</b>
```typescript
disabled?: boolean;
```
### items property
Items will be just flattened into the main list of items recursively.
<b>Signature</b>
```typescript
items?: CascaderOption[];
```
### label property
<b>Signature</b>
```typescript
label: string;
```
### title property
<b>Signature</b>
```typescript
title?: string;
```
### value property
<b>Signature</b>
```typescript
value: any;
```
docs/sources/packages_api/ui/chart.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Chart"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Chart variable
### Chart variable
<b>Signature</b>
```typescript
Chart: {
Tooltip: import("react").FC<import("./Tooltip").TooltipProps>;
}
```
<b>Import</b>
```typescript
import { Chart } from '@grafana/ui';
```
docs/sources/packages_api/ui/clearplugin.md
+28
View File
@@ -0,0 +1,28 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ClearPlugin"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ClearPlugin() function
### ClearPlugin() function
<b>Signature</b>
```typescript
export declare function ClearPlugin(): Plugin;
```
<b>Import</b>
```typescript
import { ClearPlugin } from '@grafana/ui';
```
<b>Returns:</b>
`Plugin`
docs/sources/packages_api/ui/clickoutsidewrapper.md
+88
View File
@@ -0,0 +1,88 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ClickOutsideWrapper"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ClickOutsideWrapper class
<b>Signature</b>
```typescript
export declare class ClickOutsideWrapper extends PureComponent<Props, State>
```
<b>Import</b>
```typescript
import { ClickOutsideWrapper } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [onOutsideClick](#onoutsideclick-property) | | <code>(event: any) =&gt; void</code> | |
| [state](#state-property) | | <code>{</code><br/><code> hasEventListener: boolean;</code><br/><code> }</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentWillUnmount()](#componentwillunmount-method) | | |
| [render()](#render-method) | | |
### onOutsideClick property
<b>Signature</b>
```typescript
onOutsideClick: (event: any) => void;
```
### state property
<b>Signature</b>
```typescript
state: {
hasEventListener: boolean;
};
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentWillUnmount method
<b>Signature</b>
```typescript
componentWillUnmount(): void;
```
<b>Returns:</b>
`void`
### render method
<b>Signature</b>
```typescript
render(): import("react").ReactNode;
```
<b>Returns:</b>
`import("react").ReactNode`
docs/sources/packages_api/ui/clipboardplugin.md
+28
View File
@@ -0,0 +1,28 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ClipboardPlugin"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ClipboardPlugin() function
### ClipboardPlugin() function
<b>Signature</b>
```typescript
export declare function ClipboardPlugin(): Plugin;
```
<b>Import</b>
```typescript
import { ClipboardPlugin } from '@grafana/ui';
```
<b>Returns:</b>
`Plugin`
docs/sources/packages_api/ui/collapse.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Collapse"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Collapse variable
### Collapse variable
<b>Signature</b>
```typescript
Collapse: FunctionComponent<Props>
```
<b>Import</b>
```typescript
import { Collapse } from '@grafana/ui';
```
docs/sources/packages_api/ui/colorpicker.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ColorPicker"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ColorPicker variable
### ColorPicker variable
<b>Signature</b>
```typescript
ColorPicker: React.FunctionComponent<Pick<import("./ColorPickerPopover").Props<import("./ColorPickerPopover").CustomPickersDescriptor> & {
children?: ColorPickerTriggerRenderer | undefined;
}, "onChange" | "color" | "children" | "onColorChange" | "enableNamedColors" | "customPickers" | "updatePopperPosition">>
```
<b>Import</b>
```typescript
import { ColorPicker } from '@grafana/ui';
```
docs/sources/packages_api/ui/colors.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "colors"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## colors variable
### colors variable
<b>Signature</b>
```typescript
colors: string[]
```
<b>Import</b>
```typescript
import { colors } from '@grafana/ui';
```
docs/sources/packages_api/ui/completionitem.md
+125
View File
@@ -0,0 +1,125 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CompletionItem"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## CompletionItem interface
<b>Signature</b>
```typescript
export interface CompletionItem
```
<b>Import</b>
```typescript
import { CompletionItem } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [deleteBackwards](#deletebackwards-property) | <code>number</code> | Delete number of characters before the caret position, by default the letters from the beginning of the word. |
| [detail](#detail-property) | <code>string</code> | A human-readable string with additional information about this item, like type or symbol information. |
| [documentation](#documentation-property) | <code>string</code> | A human-readable string, can be Markdown, that represents a doc-comment. |
| [filterText](#filtertext-property) | <code>string</code> | A string that should be used when filtering a set of completion items. When <code>falsy</code> the <code>label</code> is used. |
| [insertText](#inserttext-property) | <code>string</code> | A string or snippet that should be inserted in a document when selecting this completion. When <code>falsy</code> the <code>label</code> is used. |
| [kind](#kind-property) | <code>CompletionItemKind &#124; string</code> | The kind of this completion item. An icon is chosen by the editor based on the kind. |
| [label](#label-property) | <code>string</code> | The label of this completion item. By default this is also the text that is inserted when selecting this completion. |
| [move](#move-property) | <code>number</code> | Number of steps to move after the insertion, can be negative. |
| [sortText](#sorttext-property) | <code>string</code> | A string that should be used when comparing this item with other items. When <code>falsy</code> the <code>label</code> is used. |
### deleteBackwards property
Delete number of characters before the caret position, by default the letters from the beginning of the word.
<b>Signature</b>
```typescript
deleteBackwards?: number;
```
### detail property
A human-readable string with additional information about this item, like type or symbol information.
<b>Signature</b>
```typescript
detail?: string;
```
### documentation property
A human-readable string, can be Markdown, that represents a doc-comment.
<b>Signature</b>
```typescript
documentation?: string;
```
### filterText property
A string that should be used when filtering a set of completion items. When `falsy` the `label` is used.
<b>Signature</b>
```typescript
filterText?: string;
```
### insertText property
A string or snippet that should be inserted in a document when selecting this completion. When `falsy` the `label` is used.
<b>Signature</b>
```typescript
insertText?: string;
```
### kind property
The kind of this completion item. An icon is chosen by the editor based on the kind.
<b>Signature</b>
```typescript
kind?: CompletionItemKind | string;
```
### label property
The label of this completion item. By default this is also the text that is inserted when selecting this completion.
<b>Signature</b>
```typescript
label: string;
```
### move property
Number of steps to move after the insertion, can be negative.
<b>Signature</b>
```typescript
move?: number;
```
### sortText property
A string that should be used when comparing this item with other items. When `falsy` the `label` is used.
<b>Signature</b>
```typescript
sortText?: string;
```
docs/sources/packages_api/ui/completionitemgroup.md
+81
View File
@@ -0,0 +1,81 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CompletionItemGroup"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## CompletionItemGroup interface
<b>Signature</b>
```typescript
export interface CompletionItemGroup
```
<b>Import</b>
```typescript
import { CompletionItemGroup } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [items](#items-property) | <code>CompletionItem[]</code> | List of suggestions of this group. |
| [label](#label-property) | <code>string</code> | Label that will be displayed for all entries of this group. |
| [prefixMatch](#prefixmatch-property) | <code>boolean</code> | If true, match only by prefix (and not mid-word). |
| [skipFilter](#skipfilter-property) | <code>boolean</code> | If true, do not filter items in this group based on the search. |
| [skipSort](#skipsort-property) | <code>boolean</code> | If true, do not sort items. |
### items property
List of suggestions of this group.
<b>Signature</b>
```typescript
items: CompletionItem[];
```
### label property
Label that will be displayed for all entries of this group.
<b>Signature</b>
```typescript
label: string;
```
### prefixMatch property
If true, match only by prefix (and not mid-word).
<b>Signature</b>
```typescript
prefixMatch?: boolean;
```
### skipFilter property
If true, do not filter items in this group based on the search.
<b>Signature</b>
```typescript
skipFilter?: boolean;
```
### skipSort property
If true, do not sort items.
<b>Signature</b>
```typescript
skipSort?: boolean;
```
docs/sources/packages_api/ui/completionitemkind.md
+31
View File
@@ -0,0 +1,31 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CompletionItemKind"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## CompletionItemKind enum
### CompletionItemKind enum
<b>Signature</b>
```typescript
export declare enum CompletionItemKind
```
<b>Import</b>
```typescript
import { CompletionItemKind } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| GroupTitle | <code>&quot;GroupTitle&quot;</code> | |
docs/sources/packages_api/ui/confirmbutton.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ConfirmButton"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ConfirmButton variable
### ConfirmButton variable
<b>Signature</b>
```typescript
ConfirmButton: React.FunctionComponent<Pick<Props, "size" | "className" | "disabled" | "onClick" | "confirmText" | "confirmVariant" | "onConfirm" | "onCancel">>
```
<b>Import</b>
```typescript
import { ConfirmButton } from '@grafana/ui';
```
docs/sources/packages_api/ui/confirmmodal.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ConfirmModal"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ConfirmModal variable
### ConfirmModal variable
<b>Signature</b>
```typescript
ConfirmModal: FC<Props>
```
<b>Import</b>
```typescript
import { ConfirmModal } from '@grafana/ui';
```
docs/sources/packages_api/ui/contextmenu.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ContextMenu"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ContextMenu variable
### ContextMenu variable
<b>Signature</b>
```typescript
ContextMenu: React.FC<ContextMenuProps>
```
<b>Import</b>
```typescript
import { ContextMenu } from '@grafana/ui';
```
docs/sources/packages_api/ui/contextmenugroup.md
+44
View File
@@ -0,0 +1,44 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ContextMenuGroup"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ContextMenuGroup interface
<b>Signature</b>
```typescript
export interface ContextMenuGroup
```
<b>Import</b>
```typescript
import { ContextMenuGroup } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [items](#items-property) | <code>ContextMenuItem[]</code> | |
| [label](#label-property) | <code>string</code> | |
### items property
<b>Signature</b>
```typescript
items: ContextMenuItem[];
```
### label property
<b>Signature</b>
```typescript
label?: string;
```
docs/sources/packages_api/ui/contextmenuitem.md
+80
View File
@@ -0,0 +1,80 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ContextMenuItem"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ContextMenuItem interface
<b>Signature</b>
```typescript
export interface ContextMenuItem
```
<b>Import</b>
```typescript
import { ContextMenuItem } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [group](#group-property) | <code>string</code> | |
| [icon](#icon-property) | <code>string</code> | |
| [label](#label-property) | <code>string</code> | |
| [onClick](#onclick-property) | <code>(event?: React.SyntheticEvent&lt;HTMLElement&gt;) =&gt; void</code> | |
| [target](#target-property) | <code>LinkTarget</code> | |
| [url](#url-property) | <code>string</code> | |
### group property
<b>Signature</b>
```typescript
group?: string;
```
### icon property
<b>Signature</b>
```typescript
icon?: string;
```
### label property
<b>Signature</b>
```typescript
label: string;
```
### onClick property
<b>Signature</b>
```typescript
onClick?: (event?: React.SyntheticEvent<HTMLElement>) => void;
```
### target property
<b>Signature</b>
```typescript
target?: LinkTarget;
```
### url property
<b>Signature</b>
```typescript
url?: string;
```
docs/sources/packages_api/ui/contextmenuprops.md
+71
View File
@@ -0,0 +1,71 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ContextMenuProps"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ContextMenuProps interface
<b>Signature</b>
```typescript
export interface ContextMenuProps
```
<b>Import</b>
```typescript
import { ContextMenuProps } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [items](#items-property) | <code>ContextMenuGroup[]</code> | |
| [onClose](#onclose-property) | <code>() =&gt; void</code> | |
| [renderHeader](#renderheader-property) | <code>() =&gt; React.ReactNode</code> | |
| [x](#x-property) | <code>number</code> | |
| [y](#y-property) | <code>number</code> | |
### items property
<b>Signature</b>
```typescript
items?: ContextMenuGroup[];
```
### onClose property
<b>Signature</b>
```typescript
onClose: () => void;
```
### renderHeader property
<b>Signature</b>
```typescript
renderHeader?: () => React.ReactNode;
```
### x property
<b>Signature</b>
```typescript
x: number;
```
### y property
<b>Signature</b>
```typescript
y: number;
```
docs/sources/packages_api/ui/controlledcollapse.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ControlledCollapse"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ControlledCollapse variable
### ControlledCollapse variable
<b>Signature</b>
```typescript
ControlledCollapse: FunctionComponent<Props>
```
<b>Import</b>
```typescript
import { ControlledCollapse } from '@grafana/ui';
```
docs/sources/packages_api/ui/convertoldangularvaluemapping.md
+36
View File
@@ -0,0 +1,36 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "convertOldAngularValueMapping"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## convertOldAngularValueMapping() function
### convertOldAngularValueMapping() function
Convert the angular single stat mapping to new react style
<b>Signature</b>
```typescript
export declare function convertOldAngularValueMapping(panel: any): ValueMapping[];
```
<b>Import</b>
```typescript
import { convertOldAngularValueMapping } from '@grafana/ui';
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| panel | <code>any</code> | |
<b>Returns:</b>
`ValueMapping[]`
docs/sources/packages_api/ui/customscrollbar.md
+187
View File
@@ -0,0 +1,187 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "CustomScrollbar"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## CustomScrollbar class
Wraps component into <Scrollbars> component from `react-custom-scrollbars`
<b>Signature</b>
```typescript
export declare class CustomScrollbar extends Component<Props>
```
<b>Import</b>
```typescript
import { CustomScrollbar } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>CustomScrollbar</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;Props&gt;</code> | |
| [renderThumb](#renderthumb-property) | | <code>(thumb: &quot;thumb-horizontal&quot; &#124; &quot;thumb-vertical&quot;, passedProps: any) =&gt; JSX.Element</code> | |
| [renderThumbHorizontal](#renderthumbhorizontal-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderThumbVertical](#renderthumbvertical-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrack](#rendertrack-property) | | <code>(track: &quot;track-vertical&quot; &#124; &quot;track-horizontal&quot;, hideTrack: boolean &#124; undefined, passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrackHorizontal](#rendertrackhorizontal-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderTrackVertical](#rendertrackvertical-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
| [renderView](#renderview-property) | | <code>(passedProps: any) =&gt; JSX.Element</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentDidUpdate()](#componentdidupdate-method) | | |
| [render()](#render-method) | | |
| [updateAfterMount()](#updateaftermount-method) | | |
| [updateScroll()](#updatescroll-method) | | |
### constructor(props)
Constructs a new instance of the `CustomScrollbar` class
<b>Signature</b>
```typescript
constructor(props: Props);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| props | <code>Props</code> | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<Props>;
```
### renderThumb property
<b>Signature</b>
```typescript
renderThumb: (thumb: "thumb-horizontal" | "thumb-vertical", passedProps: any) => JSX.Element;
```
### renderThumbHorizontal property
<b>Signature</b>
```typescript
renderThumbHorizontal: (passedProps: any) => JSX.Element;
```
### renderThumbVertical property
<b>Signature</b>
```typescript
renderThumbVertical: (passedProps: any) => JSX.Element;
```
### renderTrack property
<b>Signature</b>
```typescript
renderTrack: (track: "track-vertical" | "track-horizontal", hideTrack: boolean | undefined, passedProps: any) => JSX.Element;
```
### renderTrackHorizontal property
<b>Signature</b>
```typescript
renderTrackHorizontal: (passedProps: any) => JSX.Element;
```
### renderTrackVertical property
<b>Signature</b>
```typescript
renderTrackVertical: (passedProps: any) => JSX.Element;
```
### renderView property
<b>Signature</b>
```typescript
renderView: (passedProps: any) => JSX.Element;
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(): void;
```
<b>Returns:</b>
`void`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
### updateAfterMount method
<b>Signature</b>
```typescript
updateAfterMount(): void;
```
<b>Returns:</b>
`void`
### updateScroll method
<b>Signature</b>
```typescript
updateScroll(): void;
```
<b>Returns:</b>
`void`
docs/sources/packages_api/ui/datalinkbuiltinvars.md
+36
View File
@@ -0,0 +1,36 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DataLinkBuiltInVars"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DataLinkBuiltInVars variable
### DataLinkBuiltInVars variable
<b>Signature</b>
```typescript
DataLinkBuiltInVars: {
keepTime: string;
timeRangeFrom: string;
timeRangeTo: string;
includeVars: string;
seriesName: string;
fieldName: string;
valueTime: string;
valueNumeric: string;
valueText: string;
valueRaw: string;
valueCalc: string;
}
```
<b>Import</b>
```typescript
import { DataLinkBuiltInVars } from '@grafana/ui';
```
docs/sources/packages_api/ui/datalinkinput.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DataLinkInput"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DataLinkInput variable
### DataLinkInput variable
<b>Signature</b>
```typescript
DataLinkInput: React.FC<DataLinkInputProps>
```
<b>Import</b>
```typescript
import { DataLinkInput } from '@grafana/ui';
```
docs/sources/packages_api/ui/datalinkscontextmenu.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DataLinksContextMenu"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DataLinksContextMenu variable
### DataLinksContextMenu variable
<b>Signature</b>
```typescript
DataLinksContextMenu: React.FC<DataLinksContextMenuProps>
```
<b>Import</b>
```typescript
import { DataLinksContextMenu } from '@grafana/ui';
```
docs/sources/packages_api/ui/datalinkseditor.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DataLinksEditor"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DataLinksEditor variable
### DataLinksEditor variable
<b>Signature</b>
```typescript
DataLinksEditor: FC<DataLinksEditorProps>
```
<b>Import</b>
```typescript
import { DataLinksEditor } from '@grafana/ui';
```
docs/sources/packages_api/ui/datasourcehttpsettings.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DataSourceHttpSettings"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DataSourceHttpSettings variable
### DataSourceHttpSettings variable
<b>Signature</b>
```typescript
DataSourceHttpSettings: React.FC<HttpSettingsProps>
```
<b>Import</b>
```typescript
import { DataSourceHttpSettings } from '@grafana/ui';
```
docs/sources/packages_api/ui/default_annotation_color.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DEFAULT_ANNOTATION_COLOR"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DEFAULT\_ANNOTATION\_COLOR variable
### DEFAULT\_ANNOTATION\_COLOR variable
<b>Signature</b>
```typescript
DEFAULT_ANNOTATION_COLOR = "rgba(0, 211, 255, 1)"
```
<b>Import</b>
```typescript
import { DEFAULT_ANNOTATION_COLOR } from '@grafana/ui';
```
docs/sources/packages_api/ui/deletebutton.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DeleteButton"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DeleteButton variable
### DeleteButton variable
<b>Signature</b>
```typescript
DeleteButton: FC<Props>
```
<b>Import</b>
```typescript
import { DeleteButton } from '@grafana/ui';
```
docs/sources/packages_api/ui/domutil.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DOMUtil"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DOMUtil namespace
### DOMUtil namespace
<b>Signature</b>
```typescript
export declare namespace DOMUtil
```
<b>Import</b>
```typescript
import { DOMUtil } from '@grafana/ui';
```
## Functions
| Function | Description |
| --- | --- |
| [getNextCharacter(global)](./getnextcharacter/) | |
| [getPreviousCousin(node, selector)](./getpreviouscousin/) | |
docs/sources/packages_api/ui/domutil/getnextcharacter.md
+35
View File
@@ -0,0 +1,35 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getNextCharacter"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DOMUtil.getNextCharacter() function
### DOMUtil.getNextCharacter() function
<b>Signature</b>
```typescript
function getNextCharacter(global?: any): any;
```
<b>Import</b>
```typescript
import { DOMUtil } from '@grafana/ui';
const { getNextCharacter } = DOMUtil;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| global | <code>any</code> | |
<b>Returns:</b>
`any`
docs/sources/packages_api/ui/domutil/getpreviouscousin.md
+36
View File
@@ -0,0 +1,36 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getPreviousCousin"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## DOMUtil.getPreviousCousin() function
### DOMUtil.getPreviousCousin() function
<b>Signature</b>
```typescript
function getPreviousCousin(node: any, selector: string): any;
```
<b>Import</b>
```typescript
import { DOMUtil } from '@grafana/ui';
const { getPreviousCousin } = DOMUtil;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| node | <code>any</code> | |
| selector | <code>string</code> | |
<b>Returns:</b>
`any`
docs/sources/packages_api/ui/drawer.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Drawer"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Drawer variable
### Drawer variable
<b>Signature</b>
```typescript
Drawer: FC<Props>
```
<b>Import</b>
```typescript
import { Drawer } from '@grafana/ui';
```
docs/sources/packages_api/ui/emptysearchresult.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "EmptySearchResult"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## EmptySearchResult variable
### EmptySearchResult variable
<b>Signature</b>
```typescript
EmptySearchResult: FC<Props>
```
<b>Import</b>
```typescript
import { EmptySearchResult } from '@grafana/ui';
```
docs/sources/packages_api/ui/errorboundary.md
+72
View File
@@ -0,0 +1,72 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ErrorBoundary"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ErrorBoundary class
<b>Signature</b>
```typescript
export declare class ErrorBoundary extends PureComponent<Props, State>
```
<b>Import</b>
```typescript
import { ErrorBoundary } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [state](#state-property) | | <code>State</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidCatch(error, errorInfo)](#componentdidcatch-method) | | |
| [render()](#render-method) | | |
### state property
<b>Signature</b>
```typescript
readonly state: State;
```
### componentDidCatch method
<b>Signature</b>
```typescript
componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| error | <code>Error</code> | |
| errorInfo | <code>ErrorInfo</code> | |
<b>Returns:</b>
`void`
### render method
<b>Signature</b>
```typescript
render(): React.ReactNode;
```
<b>Returns:</b>
`React.ReactNode`
docs/sources/packages_api/ui/errorboundaryalert.md
+53
View File
@@ -0,0 +1,53 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ErrorBoundaryAlert"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ErrorBoundaryAlert class
<b>Signature</b>
```typescript
export declare class ErrorBoundaryAlert extends PureComponent<WithAlertBoxProps>
```
<b>Import</b>
```typescript
import { ErrorBoundaryAlert } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;WithAlertBoxProps&gt;</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<WithAlertBoxProps>;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/errorwithstack.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ErrorWithStack"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## ErrorWithStack variable
### ErrorWithStack variable
<b>Signature</b>
```typescript
ErrorWithStack: FunctionComponent<Props>
```
<b>Import</b>
```typescript
import { ErrorWithStack } from '@grafana/ui';
```
docs/sources/packages_api/ui/eventswithvalidation.md
+33
View File
@@ -0,0 +1,33 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "EventsWithValidation"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## EventsWithValidation enum
### EventsWithValidation enum
<b>Signature</b>
```typescript
export declare enum EventsWithValidation
```
<b>Import</b>
```typescript
import { EventsWithValidation } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| onBlur | <code>&quot;onBlur&quot;</code> | |
| onChange | <code>&quot;onChange&quot;</code> | |
| onFocus | <code>&quot;onFocus&quot;</code> | |
docs/sources/packages_api/ui/fadetransition.md
+34
View File
@@ -0,0 +1,34 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FadeTransition"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## FadeTransition() function
### FadeTransition() function
<b>Signature</b>
```typescript
export declare function FadeTransition(props: Props): JSX.Element;
```
<b>Import</b>
```typescript
import { FadeTransition } from '@grafana/ui';
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| props | <code>Props</code> | |
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/fielddisplayeditor.md
+80
View File
@@ -0,0 +1,80 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FieldDisplayEditor"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## FieldDisplayEditor class
<b>Signature</b>
```typescript
export declare class FieldDisplayEditor extends PureComponent<Props>
```
<b>Import</b>
```typescript
import { FieldDisplayEditor } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [onCalcsChange](#oncalcschange-property) | | <code>(calcs: string[]) =&gt; void</code> | |
| [onDefaultsChange](#ondefaultschange-property) | | <code>(value: FieldConfig) =&gt; void</code> | |
| [onLimitChange](#onlimitchange-property) | | <code>(event: React.ChangeEvent&lt;HTMLInputElement&gt;) =&gt; void</code> | |
| [onShowValuesChange](#onshowvalueschange-property) | | <code>(item: SelectableValue&lt;boolean&gt;) =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### onCalcsChange property
<b>Signature</b>
```typescript
onCalcsChange: (calcs: string[]) => void;
```
### onDefaultsChange property
<b>Signature</b>
```typescript
onDefaultsChange: (value: FieldConfig) => void;
```
### onLimitChange property
<b>Signature</b>
```typescript
onLimitChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
```
### onShowValuesChange property
<b>Signature</b>
```typescript
onShowValuesChange: (item: SelectableValue<boolean>) => void;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/fieldmatchersui.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "fieldMatchersUI"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## fieldMatchersUI variable
### fieldMatchersUI variable
<b>Signature</b>
```typescript
fieldMatchersUI: Registry<FieldMatcherUIRegistryItem<any>>
```
<b>Import</b>
```typescript
import { fieldMatchersUI } from '@grafana/ui';
```
docs/sources/packages_api/ui/fieldpropertieseditor.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FieldPropertiesEditor"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## FieldPropertiesEditor variable
### FieldPropertiesEditor variable
<b>Signature</b>
```typescript
FieldPropertiesEditor: React.FC<Props>
```
<b>Import</b>
```typescript
import { FieldPropertiesEditor } from '@grafana/ui';
```
docs/sources/packages_api/ui/formfield.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FormField"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## FormField variable
### FormField variable
Default form field including label used in Grafana UI. Default input element is simple <input />. You can also pass custom inputEl if required in which case inputWidth and inputProps are ignored.
<b>Signature</b>
```typescript
FormField: FunctionComponent<Props>
```
<b>Import</b>
```typescript
import { FormField } from '@grafana/ui';
```
docs/sources/packages_api/ui/formlabel.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "FormLabel"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## FormLabel variable
### FormLabel variable
<b>Signature</b>
```typescript
FormLabel: FunctionComponent<Props>
```
<b>Import</b>
```typescript
import { FormLabel } from '@grafana/ui';
```
docs/sources/packages_api/ui/forms.md
+91
View File
File diff suppressed because one or more lines are too long
docs/sources/packages_api/ui/gauge.md
+137
View File
@@ -0,0 +1,137 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Gauge"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Gauge class
<b>Signature</b>
```typescript
export declare class Gauge extends PureComponent<Props>
```
<b>Import</b>
```typescript
import { Gauge } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [canvasElement](#canvaselement-property) | | <code>any</code> | |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>Partial&lt;Props&gt;</code> | |
| [renderVisualization](#rendervisualization-property) | | <code>() =&gt; JSX.Element</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentDidUpdate()](#componentdidupdate-method) | | |
| [draw()](#draw-method) | | |
| [getFontScale(length)](#getfontscale-method) | | |
| [getFormattedThresholds()](#getformattedthresholds-method) | | |
| [render()](#render-method) | | |
### canvasElement property
<b>Signature</b>
```typescript
canvasElement: any;
```
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: Partial<Props>;
```
### renderVisualization property
<b>Signature</b>
```typescript
renderVisualization: () => JSX.Element;
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(): void;
```
<b>Returns:</b>
`void`
### draw method
<b>Signature</b>
```typescript
draw(): void;
```
<b>Returns:</b>
`void`
### getFontScale method
<b>Signature</b>
```typescript
getFontScale(length: number): number;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| length | <code>number</code> | |
<b>Returns:</b>
`number`
### getFormattedThresholds method
<b>Signature</b>
```typescript
getFormattedThresholds(): Threshold[];
```
<b>Returns:</b>
`Threshold[]`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/getlogrowstyles.md
+43
View File
@@ -0,0 +1,43 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getLogRowStyles"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## getLogRowStyles variable
### getLogRowStyles variable
<b>Signature</b>
```typescript
getLogRowStyles: (theme: GrafanaTheme, logLevel?: LogLevel | undefined) => {
logsRowMatchHighLight: string;
logsRowMatchHighLightPreview: string;
logsRowsTable: string;
logsRowsHorizontalScroll: string;
context: string;
logsRow: string;
logsRowDuplicates: string;
logsRowLevel: string;
logsRowToggleDetails: string;
logsRowLocalTime: string;
logsRowLabels: string;
logsRowMessage: string;
logDetailsContainer: string;
logDetailsTable: string;
logsDetailsIcon: string;
logDetailsLabel: string;
logDetailsHeading: string;
logDetailsValue: string;
}
```
<b>Import</b>
```typescript
import { getLogRowStyles } from '@grafana/ui';
```
docs/sources/packages_api/ui/gettagcolorsfromname.md
+42
View File
@@ -0,0 +1,42 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getTagColorsFromName"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## getTagColorsFromName() function
### getTagColorsFromName() function
Returns tag badge background and border colors based on hashed tag name.
<b>Signature</b>
```typescript
export declare function getTagColorsFromName(name: string): {
color: string;
borderColor: string;
};
```
<b>Import</b>
```typescript
import { getTagColorsFromName } from '@grafana/ui';
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
<b>Returns:</b>
`{
color: string;
borderColor: string;
}`
docs/sources/packages_api/ui/gettheme.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "getTheme"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## getTheme variable
### getTheme variable
<b>Signature</b>
```typescript
getTheme: (name?: string | undefined) => GrafanaTheme
```
<b>Import</b>
```typescript
import { getTheme } from '@grafana/ui';
```
docs/sources/packages_api/ui/graph.md
+238
View File
@@ -0,0 +1,238 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Graph"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Graph class
<b>Signature</b>
```typescript
export declare class Graph extends PureComponent<GraphProps, GraphState>
```
<b>Import</b>
```typescript
import { Graph } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [$element](#_element-property) | | <code>any</code> | |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> showLines: boolean;</code><br/><code> showPoints: boolean;</code><br/><code> showBars: boolean;</code><br/><code> isStacked: boolean;</code><br/><code> lineWidth: number;</code><br/><code> }</code> | |
| [element](#element-property) | | <code>HTMLElement &#124; null</code> | |
| [getBarWidth](#getbarwidth-property) | | <code>() =&gt; number</code> | |
| [onPlotClick](#onplotclick-property) | | <code>(event: JQueryEventObject, contextPos: FlotPosition, item?: FlotItem&lt;GraphSeriesXY&gt; &#124; undefined) =&gt; void</code> | |
| [onPlotHover](#onplothover-property) | | <code>(event: JQueryEventObject, pos: FlotPosition, item?: FlotItem&lt;GraphSeriesXY&gt; &#124; undefined) =&gt; void</code> | |
| [onPlotSelected](#onplotselected-property) | | <code>(event: JQueryEventObject, ranges: {</code><br/><code> xaxis: {</code><br/><code> from: number;</code><br/><code> to: number;</code><br/><code> };</code><br/><code> }) =&gt; void</code> | |
| [renderContextMenu](#rendercontextmenu-property) | | <code>() =&gt; JSX.Element &#124; null</code> | |
| [renderTooltip](#rendertooltip-property) | | <code>() =&gt; React.ReactElement&lt;TooltipProps, string &#124; ((props: any) =&gt; React.ReactElement&lt;any, string &#124; any &#124; (new (props: any) =&gt; React.Component&lt;any, any, any&gt;)&gt; &#124; null) &#124; (new (props: any) =&gt; React.Component&lt;any, any, any&gt;)&gt; &#124; null</code> | |
| [state](#state-property) | | <code>GraphState</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentDidUpdate(prevProps, prevState)](#componentdidupdate-method) | | |
| [componentWillUnmount()](#componentwillunmount-method) | | |
| [draw()](#draw-method) | | |
| [getYAxes(series)](#getyaxes-method) | | |
| [render()](#render-method) | | |
### $element property
<b>Signature</b>
```typescript
$element: any;
```
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: {
showLines: boolean;
showPoints: boolean;
showBars: boolean;
isStacked: boolean;
lineWidth: number;
};
```
### element property
<b>Signature</b>
```typescript
element: HTMLElement | null;
```
### getBarWidth property
<b>Signature</b>
```typescript
getBarWidth: () => number;
```
### onPlotClick property
<b>Signature</b>
```typescript
onPlotClick: (event: JQueryEventObject, contextPos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void;
```
### onPlotHover property
<b>Signature</b>
```typescript
onPlotHover: (event: JQueryEventObject, pos: FlotPosition, item?: FlotItem<GraphSeriesXY> | undefined) => void;
```
### onPlotSelected property
<b>Signature</b>
```typescript
onPlotSelected: (event: JQueryEventObject, ranges: {
xaxis: {
from: number;
to: number;
};
}) => void;
```
### renderContextMenu property
<b>Signature</b>
```typescript
renderContextMenu: () => JSX.Element | null;
```
### renderTooltip property
<b>Signature</b>
```typescript
renderTooltip: () => React.ReactElement<TooltipProps, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null;
```
### state property
<b>Signature</b>
```typescript
state: GraphState;
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(prevProps: GraphProps, prevState: GraphState): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| prevProps | <code>GraphProps</code> | |
| prevState | <code>GraphState</code> | |
<b>Returns:</b>
`void`
### componentWillUnmount method
<b>Signature</b>
```typescript
componentWillUnmount(): void;
```
<b>Returns:</b>
`void`
### draw method
<b>Signature</b>
```typescript
draw(): void;
```
<b>Returns:</b>
`void`
### getYAxes method
<b>Signature</b>
```typescript
getYAxes(series: GraphSeriesXY[]): {
show: boolean;
index: number;
position: string;
min: import("@grafana/data").DecimalCount;
tickDecimals: import("@grafana/data").DecimalCount;
}[] | {
show: boolean;
min: number;
max: number;
}[];
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| series | <code>GraphSeriesXY[]</code> | |
<b>Returns:</b>
`{
show: boolean;
index: number;
position: string;
min: import("@grafana/data").DecimalCount;
tickDecimals: import("@grafana/data").DecimalCount;
}[] | {
show: boolean;
min: number;
max: number;
}[]`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/graphcontextmenu.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GraphContextMenu"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## GraphContextMenu variable
### GraphContextMenu variable
<b>Signature</b>
```typescript
GraphContextMenu: React.FC<GraphContextMenuProps>
```
<b>Import</b>
```typescript
import { GraphContextMenu } from '@grafana/ui';
```
docs/sources/packages_api/ui/graphlegend.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GraphLegend"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## GraphLegend variable
### GraphLegend variable
<b>Signature</b>
```typescript
GraphLegend: React.FunctionComponent<GraphLegendProps>
```
<b>Import</b>
```typescript
import { GraphLegend } from '@grafana/ui';
```
docs/sources/packages_api/ui/graphseriestoggler.md
+97
View File
@@ -0,0 +1,97 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GraphSeriesToggler"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## GraphSeriesToggler class
<b>Signature</b>
```typescript
export declare class GraphSeriesToggler extends React.Component<GraphSeriesTogglerProps, GraphSeriesTogglerState>
```
<b>Import</b>
```typescript
import { GraphSeriesToggler } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>GraphSeriesToggler</code> class |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidUpdate(prevProps)](#componentdidupdate-method) | | |
| [onSeriesToggle(label, event)](#onseriestoggle-method) | | |
| [render()](#render-method) | | |
### constructor(props)
Constructs a new instance of the `GraphSeriesToggler` class
<b>Signature</b>
```typescript
constructor(props: GraphSeriesTogglerProps);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| props | <code>GraphSeriesTogglerProps</code> | |
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(prevProps: Readonly<GraphSeriesTogglerProps>): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| prevProps | <code>Readonly&lt;GraphSeriesTogglerProps&gt;</code> | |
<b>Returns:</b>
`void`
### onSeriesToggle method
<b>Signature</b>
```typescript
onSeriesToggle(label: string, event: React.MouseEvent<HTMLElement>): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| label | <code>string</code> | |
| event | <code>React.MouseEvent&lt;HTMLElement&gt;</code> | |
<b>Returns:</b>
`void`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/graphseriestogglerapi.md
+44
View File
@@ -0,0 +1,44 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GraphSeriesTogglerAPI"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## GraphSeriesTogglerAPI interface
<b>Signature</b>
```typescript
export interface GraphSeriesTogglerAPI
```
<b>Import</b>
```typescript
import { GraphSeriesTogglerAPI } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [onSeriesToggle](#onseriestoggle-property) | <code>(label: string, event: React.MouseEvent&lt;HTMLElement&gt;) =&gt; void</code> | |
| [toggledSeries](#toggledseries-property) | <code>GraphSeriesXY[]</code> | |
### onSeriesToggle property
<b>Signature</b>
```typescript
onSeriesToggle: (label: string, event: React.MouseEvent<HTMLElement>) => void;
```
### toggledSeries property
<b>Signature</b>
```typescript
toggledSeries: GraphSeriesXY[];
```
docs/sources/packages_api/ui/graphtooltipoptions.md
+35
View File
@@ -0,0 +1,35 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GraphTooltipOptions"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## GraphTooltipOptions interface
<b>Signature</b>
```typescript
export interface GraphTooltipOptions
```
<b>Import</b>
```typescript
import { GraphTooltipOptions } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [mode](#mode-property) | <code>TooltipMode</code> | |
### mode property
<b>Signature</b>
```typescript
mode: TooltipMode;
```
docs/sources/packages_api/ui/graphwithlegend.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GraphWithLegend"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## GraphWithLegend variable
### GraphWithLegend variable
<b>Signature</b>
```typescript
GraphWithLegend: React.FunctionComponent<GraphWithLegendProps>
```
<b>Import</b>
```typescript
import { GraphWithLegend } from '@grafana/ui';
```
docs/sources/packages_api/ui/hasvalidationevent.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "hasValidationEvent"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## hasValidationEvent variable
### hasValidationEvent variable
<b>Signature</b>
```typescript
hasValidationEvent: (event: EventsWithValidation, validationEvents: ValidationEvents | undefined) => ValidationRule[] | undefined
```
<b>Import</b>
```typescript
import { hasValidationEvent } from '@grafana/ui';
```
docs/sources/packages_api/ui/icon.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Icon"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Icon variable
### Icon variable
<b>Signature</b>
```typescript
Icon: React.FC<IconProps>
```
<b>Import</b>
```typescript
import { Icon } from '@grafana/ui';
```
docs/sources/packages_api/ui/indentationplugin.md
+28
View File
@@ -0,0 +1,28 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "IndentationPlugin"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## IndentationPlugin() function
### IndentationPlugin() function
<b>Signature</b>
```typescript
export declare function IndentationPlugin(): Plugin;
```
<b>Import</b>
```typescript
import { IndentationPlugin } from '@grafana/ui';
```
<b>Returns:</b>
`Plugin`
docs/sources/packages_api/ui/indicatorscontainer.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "IndicatorsContainer"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## IndicatorsContainer variable
### IndicatorsContainer variable
<b>Signature</b>
```typescript
IndicatorsContainer: (props: any) => JSX.Element
```
<b>Import</b>
```typescript
import { IndicatorsContainer } from '@grafana/ui';
```
docs/sources/packages_api/ui/input.md
+100
View File
@@ -0,0 +1,100 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "Input"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## Input class
<b>Signature</b>
```typescript
export declare class Input extends PureComponent<Props, State>
```
<b>Import</b>
```typescript
import { Input } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> className: string;</code><br/><code> }</code> | |
| [isInvalid](#isinvalid-property) | | <code>boolean</code> | |
| [populateEventPropsWithStatus](#populateeventpropswithstatus-property) | | <code>(restProps: any, validationEvents: ValidationEvents &#124; undefined) =&gt; any</code> | |
| [state](#state-property) | | <code>State</code> | |
| [status](#status-property) | | <code>InputStatus</code> | |
| [validatorAsync](#validatorasync-property) | | <code>(validationRules: ValidationRule[]) =&gt; (evt: React.ChangeEvent&lt;HTMLInputElement&gt;) =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: {
className: string;
};
```
### isInvalid property
<b>Signature</b>
```typescript
get isInvalid(): boolean;
```
### populateEventPropsWithStatus property
<b>Signature</b>
```typescript
populateEventPropsWithStatus: (restProps: any, validationEvents: ValidationEvents | undefined) => any;
```
### state property
<b>Signature</b>
```typescript
state: State;
```
### status property
<b>Signature</b>
```typescript
get status(): InputStatus;
```
### validatorAsync property
<b>Signature</b>
```typescript
validatorAsync: (validationRules: ValidationRule[]) => (evt: React.ChangeEvent<HTMLInputElement>) => void;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/inputstatus.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "InputStatus"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## InputStatus enum
### InputStatus enum
<b>Signature</b>
```typescript
export declare enum InputStatus
```
<b>Import</b>
```typescript
import { InputStatus } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Invalid | <code>&quot;invalid&quot;</code> | |
| Valid | <code>&quot;valid&quot;</code> | |
docs/sources/packages_api/ui/jsonexplorer.md
+189
View File
@@ -0,0 +1,189 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "JsonExplorer"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## JsonExplorer class
JsonExplorer
JsonExplorer allows you to render JSON objects in HTML with a \*\*collapsible\*\* navigation.
<b>Signature</b>
```typescript
export declare class JsonExplorer
```
<b>Import</b>
```typescript
import { JsonExplorer } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(json, open, config, key)](#constructor-jsonopenconfigkey) | | Constructs a new instance of the <code>JsonExplorer</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [json](#json-property) | | <code>any</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [appendChildren(animated)](#appendchildren-method) | | Appends all the children to children element Animated option is used when user triggers this via a click |
| [isNumberArray()](#isnumberarray-method) | | |
| [openAtDepth(depth)](#openatdepth-method) | | Open all children up to a certain depth. Allows actions such as expand all/collapse all |
| [removeChildren(animated)](#removechildren-method) | | Removes all the children from children element Animated option is used when user triggers this via a click |
| [render(skipRoot)](#render-method) | | Renders an HTML element and installs event listeners |
| [renderArray()](#renderarray-method) | | |
| [toggleOpen()](#toggleopen-method) | | Toggles <code>isOpen</code> state |
### constructor(json, open, config, key)
Constructs a new instance of the `JsonExplorer` class
<b>Signature</b>
```typescript
constructor(json: any, open?: number, config?: JsonExplorerConfig, key?: string | undefined);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| json | <code>any</code> | |
| open | <code>number</code> | |
| config | <code>JsonExplorerConfig</code> | |
| key | <code>string &#124; undefined</code> | |
### json property
<b>Signature</b>
```typescript
json: any;
```
### appendChildren method
Appends all the children to children element Animated option is used when user triggers this via a click
<b>Signature</b>
```typescript
appendChildren(animated?: boolean): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| animated | <code>boolean</code> | |
<b>Returns:</b>
`void`
### isNumberArray method
<b>Signature</b>
```typescript
isNumberArray(): boolean;
```
<b>Returns:</b>
`boolean`
### openAtDepth method
Open all children up to a certain depth. Allows actions such as expand all/collapse all
<b>Signature</b>
```typescript
openAtDepth(depth?: number): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| depth | <code>number</code> | |
<b>Returns:</b>
`void`
### removeChildren method
Removes all the children from children element Animated option is used when user triggers this via a click
<b>Signature</b>
```typescript
removeChildren(animated?: boolean): void;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| animated | <code>boolean</code> | |
<b>Returns:</b>
`void`
### render method
Renders an HTML element and installs event listeners
<b>Signature</b>
```typescript
render(skipRoot?: boolean): HTMLDivElement;
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| skipRoot | <code>boolean</code> | |
<b>Returns:</b>
`HTMLDivElement`
{<!-- -->HTMLDivElement<!-- -->}
### renderArray method
<b>Signature</b>
```typescript
renderArray(): Element;
```
<b>Returns:</b>
`Element`
### toggleOpen method
Toggles `isOpen` state
<b>Signature</b>
```typescript
toggleOpen(): void;
```
<b>Returns:</b>
`void`
docs/sources/packages_api/ui/jsonformatter.md
+91
View File
@@ -0,0 +1,91 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "JSONFormatter"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## JSONFormatter class
<b>Signature</b>
```typescript
export declare class JSONFormatter extends PureComponent<Props>
```
<b>Import</b>
```typescript
import { JSONFormatter } from '@grafana/ui';
```
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultProps](#defaultprops-property) | <code>static</code> | <code>{</code><br/><code> open: number;</code><br/><code> config: {</code><br/><code> animateOpen: boolean;</code><br/><code> };</code><br/><code> }</code> | |
| [renderJson](#renderjson-property) | | <code>() =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [componentDidMount()](#componentdidmount-method) | | |
| [componentDidUpdate()](#componentdidupdate-method) | | |
| [render()](#render-method) | | |
### defaultProps property
<b>Signature</b>
```typescript
static defaultProps: {
open: number;
config: {
animateOpen: boolean;
};
};
```
### renderJson property
<b>Signature</b>
```typescript
renderJson: () => void;
```
### componentDidMount method
<b>Signature</b>
```typescript
componentDidMount(): void;
```
<b>Returns:</b>
`void`
### componentDidUpdate method
<b>Signature</b>
```typescript
componentDidUpdate(): void;
```
<b>Returns:</b>
`void`
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/legendbasicoptions.md
+44
View File
@@ -0,0 +1,44 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendBasicOptions"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendBasicOptions interface
<b>Signature</b>
```typescript
export interface LegendBasicOptions
```
<b>Import</b>
```typescript
import { LegendBasicOptions } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [asTable](#astable-property) | <code>boolean</code> | |
| [isVisible](#isvisible-property) | <code>boolean</code> | |
### asTable property
<b>Signature</b>
```typescript
asTable: boolean;
```
### isVisible property
<b>Signature</b>
```typescript
isVisible: boolean;
```
docs/sources/packages_api/ui/legenddisplaymode.md
+32
View File
@@ -0,0 +1,32 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendDisplayMode"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendDisplayMode enum
### LegendDisplayMode enum
<b>Signature</b>
```typescript
export declare enum LegendDisplayMode
```
<b>Import</b>
```typescript
import { LegendDisplayMode } from '@grafana/ui';
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| List | <code>&quot;list&quot;</code> | |
| Table | <code>&quot;table&quot;</code> | |
docs/sources/packages_api/ui/legenditem.md
+71
View File
@@ -0,0 +1,71 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendItem"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendItem interface
<b>Signature</b>
```typescript
export interface LegendItem
```
<b>Import</b>
```typescript
import { LegendItem } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [color](#color-property) | <code>string</code> | |
| [displayValues](#displayvalues-property) | <code>DisplayValue[]</code> | |
| [isVisible](#isvisible-property) | <code>boolean</code> | |
| [label](#label-property) | <code>string</code> | |
| [yAxis](#yaxis-property) | <code>number</code> | |
### color property
<b>Signature</b>
```typescript
color: string;
```
### displayValues property
<b>Signature</b>
```typescript
displayValues?: DisplayValue[];
```
### isVisible property
<b>Signature</b>
```typescript
isVisible: boolean;
```
### label property
<b>Signature</b>
```typescript
label: string;
```
### yAxis property
<b>Signature</b>
```typescript
yAxis: number;
```
docs/sources/packages_api/ui/legendlist.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendList"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendList variable
### LegendList variable
<b>Signature</b>
```typescript
LegendList: React.FunctionComponent<LegendComponentProps>
```
<b>Import</b>
```typescript
import { LegendList } from '@grafana/ui';
```
docs/sources/packages_api/ui/legendoptions.md
+22
View File
@@ -0,0 +1,22 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendOptions"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendOptions interface
<b>Signature</b>
```typescript
export interface LegendOptions extends LegendBasicOptions, LegendRenderOptions
```
<b>Import</b>
```typescript
import { LegendOptions } from '@grafana/ui';
```
docs/sources/packages_api/ui/legendplacement.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendPlacement"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendPlacement type
### LegendPlacement type
<b>Signature</b>
```typescript
export declare type LegendPlacement = 'under' | 'right' | 'over';
```
<b>Import</b>
```typescript
import { LegendPlacement } from '@grafana/ui';
```
docs/sources/packages_api/ui/legendrenderoptions.md
+53
View File
@@ -0,0 +1,53 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendRenderOptions"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendRenderOptions interface
<b>Signature</b>
```typescript
export interface LegendRenderOptions
```
<b>Import</b>
```typescript
import { LegendRenderOptions } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [hideEmpty](#hideempty-property) | <code>boolean</code> | |
| [hideZero](#hidezero-property) | <code>boolean</code> | |
| [placement](#placement-property) | <code>LegendPlacement</code> | |
### hideEmpty property
<b>Signature</b>
```typescript
hideEmpty?: boolean;
```
### hideZero property
<b>Signature</b>
```typescript
hideZero?: boolean;
```
### placement property
<b>Signature</b>
```typescript
placement: LegendPlacement;
```
docs/sources/packages_api/ui/legendtable.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LegendTable"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LegendTable variable
### LegendTable variable
<b>Signature</b>
```typescript
LegendTable: React.FunctionComponent<LegendTableProps>
```
<b>Import</b>
```typescript
import { LegendTable } from '@grafana/ui';
```
docs/sources/packages_api/ui/linkbutton.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LinkButton"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LinkButton variable
### LinkButton variable
<b>Signature</b>
```typescript
LinkButton: React.ForwardRefExoticComponent<CommonProps & React.AnchorHTMLAttributes<HTMLAnchorElement> & {
disabled?: boolean | undefined;
} & React.RefAttributes<HTMLAnchorElement>>
```
<b>Import</b>
```typescript
import { LinkButton } from '@grafana/ui';
```
docs/sources/packages_api/ui/linkmodeltocontextmenuitems.md
+26
View File
@@ -0,0 +1,26 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "linkModelToContextMenuItems"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## linkModelToContextMenuItems variable
### linkModelToContextMenuItems variable
Delays creating links until we need to open the ContextMenu
<b>Signature</b>
```typescript
linkModelToContextMenuItems: (links: LinkModelSupplier<any>) => ContextMenuItem[]
```
<b>Import</b>
```typescript
import { linkModelToContextMenuItems } from '@grafana/ui';
```
docs/sources/packages_api/ui/list.md
+39
View File
@@ -0,0 +1,39 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "List"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## List class
<b>Signature</b>
```typescript
export declare class List<T> extends React.PureComponent<ListProps<T>>
```
<b>Import</b>
```typescript
import { List } from '@grafana/ui';
```
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`
docs/sources/packages_api/ui/loadingplaceholder.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LoadingPlaceholder"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LoadingPlaceholder variable
### LoadingPlaceholder variable
<b>Signature</b>
```typescript
LoadingPlaceholder: SFC<LoadingPlaceholderProps>
```
<b>Import</b>
```typescript
import { LoadingPlaceholder } from '@grafana/ui';
```
docs/sources/packages_api/ui/loglabels.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LogLabels"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LogLabels variable
### LogLabels variable
<b>Signature</b>
```typescript
LogLabels: React.FunctionComponent<Pick<Props, "labels">>
```
<b>Import</b>
```typescript
import { LogLabels } from '@grafana/ui';
```
docs/sources/packages_api/ui/logrows.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "LogRows"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## LogRows variable
### LogRows variable
<b>Signature</b>
```typescript
LogRows: React.FunctionComponent<Pick<Props, "timeZone" | "getRowContext" | "onClickFilterLabel" | "onClickFilterOutLabel" | "getFieldLinks" | "highlighterExpressions" | "wrapLogMessage" | "showLabels" | "showTime" | "allowDetails" | "logRows" | "deduplicatedRows" | "dedupStrategy" | "rowLimit" | "previewLimit">>
```
<b>Import</b>
```typescript
import { LogRows } from '@grafana/ui';
```
docs/sources/packages_api/ui/makefragment.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "makeFragment"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## makeFragment variable
### makeFragment variable
<b>Signature</b>
```typescript
makeFragment: (text: string, syntax?: string | undefined) => Document
```
<b>Import</b>
```typescript
import { makeFragment } from '@grafana/ui';
```
docs/sources/packages_api/ui/makevalue.md
+24
View File
@@ -0,0 +1,24 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "makeValue"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## makeValue variable
### makeValue variable
<b>Signature</b>
```typescript
makeValue: (text: string, syntax?: string | undefined) => Value
```
<b>Import</b>
```typescript
import { makeValue } from '@grafana/ui';
```
docs/sources/packages_api/ui/measuretext.md
+35
View File
@@ -0,0 +1,35 @@
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "measureText"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
draft = true
+++
## measureText() function
### measureText() function
<b>Signature</b>
```typescript
export declare function measureText(text: string, fontSize: number): TextMetrics;
```
<b>Import</b>
```typescript
import { measureText } from '@grafana/ui';
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| text | <code>string</code> | |
| fontSize | <code>number</code> | |
<b>Returns:</b>
`TextMetrics`

Some files were not shown because too many files have changed in this diff Show More