IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore: Add comments to RAQB config (#79075)

Browse Source
This commit is contained in:
Zoltán Bedi 2023-12-06 08:33:04 +01:00 committed by GitHub
parent 439edebcd6
commit d85ac7cea7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
public/app/features/plugins/sql/components/visual-query-builder/AwesomeQueryBuilder.tsx
View File

@ -31,6 +31,8 @@ export const emptyInitTree: JsonTree = {
const TIME_FILTER = 'timeFilter';
const macros = [TIME_FILTER];
// Widgets are the components rendered for each field type see the docs for more info
// https://github.com/ukrbublik/react-awesome-query-builder/blob/master/CONFIG.adoc#configwidgets
export const widgets: Widgets = {
...BasicConfig.widgets,
text: {
@ -83,6 +85,7 @@ export const widgets: Widgets = {
/>
);
},
// Function for formatting widget’s value in SQL WHERE query.
sqlFormatValue: (val, field, widget, operator, operatorDefinition, rightFieldDef) => {
if (operator === Op.MACROS) {
if (macros.includes(val)) {
@ -105,6 +108,8 @@ export const widgets: Widgets = {
},
};
// Settings are the configuration options for the query builder see the docs for more info
// https://github.com/ukrbublik/react-awesome-query-builder/blob/master/CONFIG.adoc#configsettings
export const settings: Settings = {
...BasicConfig.settings,
canRegroup: false,
@ -113,6 +118,7 @@ export const settings: Settings = {
showNot: false,
addRuleLabel: buttonLabels.add,
deleteLabel: buttonLabels.remove,
// This is the component that renders conjunctions (logical operators)
renderConjs: function Conjunctions(conjProps) {
return (
<Select
@ -125,6 +131,7 @@ export const settings: Settings = {
/>
);
},
// This is the component that renders fields
renderField: function Field(fieldProps) {
const fields = fieldProps?.config?.fields || {};
return (
@ -149,6 +156,7 @@ export const settings: Settings = {
/>
);
},
// This is the component used for the Add/Remove buttons
renderButton: function RAQBButton(buttonProps) {
return (
<Button
@ -161,6 +169,7 @@ export const settings: Settings = {
/>
);
},
// This is the component used for the fields operator selector
renderOperator: function Operator(operatorProps) {
return (
<Select
@ -211,6 +220,9 @@ const customTypes = {
},
};
// This is the configuration for the query builder that doesn't include the fields but all the other configuration for the UI
// Fields should be added dynamically based on returned data
// See the doc for more info https://github.com/ukrbublik/react-awesome-query-builder/blob/master/CONFIG.adoc
export const raqbConfig: Config = {
...BasicConfig,
widgets,