grafana/docs/sources/packages_api/data/queryeditorprops.md
Marcus Andersson 6a0abf895e
Docs: generated a 7.0 version of the packages reference docs. (#24708)
* fixes so we match the transformer based on name properly.

* changed the signature on the FieldMatcher.

* introduced a names option so you can filter in name specificly.

* changed so the matcher UI uses the new options format.

* moved the exported functions together.

* changing editors a bit.

* made the filter by name work with both regex and name filtering.

* fixed failing tests and make sure we always parse regex the same way.

* removed unused code.

* simplified to make the existing field overrides still working.

* fixed issue reported by hugo.

* added tests for the name matcher.

* added tests for filter by name.

* added more tests.

* generated new version of the packages docs.

* fixed spelling error.

* regenerated the docs.
2020-05-14 21:34:59 +02:00

2.3 KiB

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "QueryEditorProps" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

QueryEditorProps interface

Signature

export interface QueryEditorProps<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> 

Import

import { QueryEditorProps } from '@grafana/data';

Properties

Property Type Description
data PanelData Contains query response filtered by refId of QueryResultBase and possible query error
datasource DSType
exploreId any
exploreMode ExploreMode
history HistoryItem[]
onBlur () => void
onChange (value: TQuery) => void
onRunQuery () => void
query TQuery

data property

Contains query response filtered by refId of QueryResultBase and possible query error

Signature

data?: PanelData;

datasource property

Signature

datasource: DSType;

exploreId property

Signature

exploreId?: any;

exploreMode property

Signature

exploreMode?: ExploreMode;

history property

Signature

history?: HistoryItem[];

onBlur property

Signature

onBlur?: () => void;

onChange property

Signature

onChange: (value: TQuery) => void;

onRunQuery property

Signature

onRunQuery: () => void;

query property

Signature

query: TQuery;