From 63aa9b8a7258c99439a50f16b0e1b8ae8b09cf53 Mon Sep 17 00:00:00 2001 From: John Bodley <4567245+john-bodley@users.noreply.github.com> Date: Thu, 28 Oct 2021 08:45:53 -0700 Subject: [PATCH] docs: update chart sorting control labels/descriptions (#1436) Co-authored-by: John Bodley --- .../src/shared-controls/dndControls.tsx | 10 ++++-- .../src/shared-controls/index.tsx | 34 +++++++++++++------ 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/dndControls.tsx b/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/dndControls.tsx index bbc67ab1038fd..0488fc454f656 100644 --- a/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/dndControls.tsx +++ b/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/dndControls.tsx @@ -25,7 +25,10 @@ export const dndGroupByControl: SharedControlConfig<'DndColumnSelect'> = { type: 'DndColumnSelect', label: t('Group by'), default: [], - description: t('One or many columns to group by'), + description: t( + 'One or many columns to group by. High cardinality groupings should include a sort by metric ' + + 'and series limit to limit the number of fetched and rendered series.', + ), mapStateToProps(state, { includeTime }) { const newState: ExtraControlProps = {}; if (state.datasource) { @@ -113,7 +116,10 @@ export const dnd_sort_by: SharedControlConfig<'DndMetricSelect'> = { type: 'DndMetricSelect', label: t('Sort by'), default: null, - description: t('Metric used to define the top series'), + description: t( + 'Metric used to define the top series. Should be used in conjunction with the series or row ' + + 'limit.', + ), mapStateToProps: ({ datasource }) => ({ columns: datasource?.columns || [], savedMetrics: datasource?.metrics || [], diff --git a/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/index.tsx b/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/index.tsx index 3de5c19e9fad3..a95fe90c6fca8 100644 --- a/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/index.tsx +++ b/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/index.tsx @@ -102,7 +102,10 @@ const groupByControl: SharedControlConfig<'SelectControl', ColumnMeta> = { clearable: true, default: [], includeTime: false, - description: t('One or many columns to group by'), + description: t( + 'One or many columns to group by. High cardinality groupings should include a sort by metric ' + + 'and series limit to limit the number of fetched and rendered series.', + ), optionRenderer: c => , valueRenderer: c => , valueKey: 'column_name', @@ -324,6 +327,10 @@ const row_limit: SharedControlConfig<'SelectControl'> = { validators: [legacyValidateInteger], default: 10000, choices: formatSelectOptions(ROW_LIMIT_OPTIONS), + description: t( + 'Limits the number of rows that get displayed. Should be used in conjunction with a sort ' + + 'by metric.', + ), }; const limit: SharedControlConfig<'SelectControl'> = { @@ -334,10 +341,11 @@ const limit: SharedControlConfig<'SelectControl'> = { choices: formatSelectOptions(SERIES_LIMITS), clearable: true, description: t( - 'Limits the number of time series that get displayed. A sub query ' + - '(or an extra phase where sub queries are not supported) is applied to limit ' + - 'the number of time series that get fetched and displayed. This feature is useful ' + - 'when grouping by high cardinality dimension(s).', + 'Limits the number of series that get displayed. Should be used in conjunction with a sort ' + + 'by metric. A joined subquery (or an extra phase where subqueries are not supported) is ' + + 'applied to limit the number of series that get fetched and rendered. This feature is ' + + 'useful when grouping by high cardinality column(s) though does increase the query ' + + 'complexity and cost.', ), }; @@ -348,18 +356,22 @@ const series_limit: SharedControlConfig<'SelectControl'> = { validators: [legacyValidateInteger], choices: formatSelectOptions(SERIES_LIMITS), description: t( - 'Limits the number of series that get displayed. A sub query ' + - '(or an extra phase where sub queries are not supported) is applied to limit ' + - 'the number of series that get fetched and displayed. This feature is useful ' + - 'when grouping by high cardinality dimension(s).', + 'Limits the number of series that get displayed. Should be used in conjunction with a sort ' + + 'by metric. A joined subquery (or an extra phase where subqueries are not supported) is ' + + 'applied to limit the number of series that get fetched and rendered. This feature is ' + + 'useful when grouping by high cardinality column(s) though does increase the query ' + + 'complexity and cost.', ), }; const sort_by: SharedControlConfig<'MetricsControl'> = { type: 'MetricsControl', - label: t('Sort By'), + label: t('Sort by'), default: null, - description: t('Metric used to define the top series'), + description: t( + 'Metric used to define the top series. Should be used in conjunction with the series or row ' + + 'limit', + ), mapStateToProps: ({ datasource }) => ({ columns: datasource?.columns || [], savedMetrics: datasource?.metrics || [],