mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 14:12:15 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
224 lines
5.3 KiB
Markdown
224 lines
5.3 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "QueryField"
|
|
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## QueryField class
|
|
|
|
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.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class QueryField extends React.PureComponent<QueryFieldProps, QueryFieldState>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { QueryField } from '@grafana/ui';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(props, context)](#constructor-propscontext) | | Constructs a new instance of the <code>QueryField</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [editor](#editor-property) | | <code>Editor | null</code> | |
|
|
| [handleBlur](#handleblur-property) | | <code>(event: Event, editor: CoreEditor, next: Function) => any</code> | We need to handle blur events here mainly because of dashboard panels which expect to have query executed on blur. |
|
|
| [lastExecutedValue](#lastexecutedvalue-property) | | <code>Value | null</code> | |
|
|
| [mounted](#mounted-property) | | <code>boolean</code> | |
|
|
| [onChange](#onchange-property) | | <code>(value: Value, runQuery?: boolean | undefined) => void</code> | Update local state, propagate change upstream and optionally run the query afterwards. |
|
|
| [plugins](#plugins-property) | | <code>Plugin[]</code> | |
|
|
| [runOnChange](#runonchange-property) | | <code>() => void</code> | |
|
|
| [runOnChangeAndRunQuery](#runonchangeandrunquery-property) | | <code>() => void</code> | |
|
|
| [runOnChangeDebounced](#runonchangedebounced-property) | | <code>Function</code> | |
|
|
| [runOnRunQuery](#runonrunquery-property) | | <code>() => void</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [componentDidMount()](#componentdidmount-method) | | |
|
|
| [componentDidUpdate(prevProps, prevState)](#componentdidupdate-method) | | |
|
|
| [componentWillUnmount()](#componentwillunmount-method) | | |
|
|
| [render()](#render-method) | | |
|
|
| [UNSAFE\_componentWillReceiveProps(nextProps)](#unsafe_componentwillreceiveprops-method) | | |
|
|
|
|
### constructor(props, context)
|
|
|
|
Constructs a new instance of the `QueryField` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(props: QueryFieldProps, context: Context<any>);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| props | <code>QueryFieldProps</code> | |
|
|
| context | <code>Context<any></code> | |
|
|
|
|
### editor property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
editor: Editor | null;
|
|
```
|
|
|
|
### handleBlur property
|
|
|
|
We need to handle blur events here mainly because of dashboard panels which expect to have query executed on blur.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
handleBlur: (event: Event, editor: CoreEditor, next: Function) => any;
|
|
```
|
|
|
|
### lastExecutedValue property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
lastExecutedValue: Value | null;
|
|
```
|
|
|
|
### mounted property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
mounted: boolean;
|
|
```
|
|
|
|
### onChange property
|
|
|
|
Update local state, propagate change upstream and optionally run the query afterwards.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onChange: (value: Value, runQuery?: boolean | undefined) => void;
|
|
```
|
|
|
|
### plugins property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
plugins: Plugin[];
|
|
```
|
|
|
|
### runOnChange property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
runOnChange: () => void;
|
|
```
|
|
|
|
### runOnChangeAndRunQuery property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
runOnChangeAndRunQuery: () => void;
|
|
```
|
|
|
|
### runOnChangeDebounced property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
runOnChangeDebounced: Function;
|
|
```
|
|
|
|
### runOnRunQuery property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
runOnRunQuery: () => void;
|
|
```
|
|
|
|
### componentDidMount method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentDidMount(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### componentDidUpdate method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentDidUpdate(prevProps: QueryFieldProps, prevState: QueryFieldState): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| prevProps | <code>QueryFieldProps</code> | |
|
|
| prevState | <code>QueryFieldState</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### componentWillUnmount method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentWillUnmount(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### render method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
render(): JSX.Element;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`JSX.Element`
|
|
|
|
### UNSAFE\_componentWillReceiveProps method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
UNSAFE_componentWillReceiveProps(nextProps: QueryFieldProps): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| nextProps | <code>QueryFieldProps</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|