betodealmeida commented on a change in pull request #4777: [doc] module header
for controls.jsx and visTypes.jsx
@@ -1,3 +1,43 @@
+ * This file exports all controls available for use in the different
+ * While the React components located in `controls/components` represent
+ * types of controls (CheckboxControl, SelectControl, TextControl, ...), the
+ * represent instances of control types, that can be reused across
+ * When controls are reused across viz types, their values are carried over as
+ * changes the chart types.
+ * While the keys defined in the control itself get passed to the controlType
+ * here's a list of the keys that are common to all controls,
+ * and as a result define the control interface:
+ * - type: the control type, referencing a React component of the same name
+ * - label: the label as shown in the control's header
+ * - description: shown in the info tooltip of the control's header
+ * - default: the default value when opening a new chart, or changing
+ * - renderTrigger: a bool that defines whether the visualization should be
+ when changed. This should `true` for controls that only affect the
rendering (client side)
+ and don't affect the query or backend data processing as those require to
re run a query
+ and fetch the data
+ * - validators: an array of functions that will receive the value of the
+ should return error messages when the value is not valid. The error
+ bubble up to the control header, section header and query panel header.
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
Apache Git Services