Skip to content

Commit

Permalink
chore: Update Explore tooltip copy (#25438)
Browse files Browse the repository at this point in the history
  • Loading branch information
yousoph authored Sep 30, 2023
1 parent a14fcc9 commit e36e0fd
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,9 @@ export const dndGroupByControl: SharedControlConfig<
default: [],
includeTime: false,
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.',
'Dimensions contain qualitative values such as names, dates, or geographical data. ' +
'Use dimensions to categorize, segment, and reveal the details in your data. ' +
'Dimensions affect the level of detail in the view.',
),
optionRenderer: (c: ColumnMeta) => <ColumnOption showType column={c} />,
valueRenderer: (c: ColumnMeta) => <ColumnOption column={c} />,
Expand Down Expand Up @@ -108,7 +109,7 @@ export const dndGroupByControl: SharedControlConfig<
export const dndColumnsControl: typeof dndGroupByControl = {
...dndGroupByControl,
label: t('Columns'),
description: t('One or many columns to pivot as columns'),
description: t('Add dataset columns here to group the pivot table columns.'),
};

export const dndSeriesControl: typeof dndGroupByControl = {
Expand All @@ -118,8 +119,7 @@ export const dndSeriesControl: typeof dndGroupByControl = {
default: null,
description: t(
'Defines the grouping of entities. ' +
'Each series is shown as a specific color on the chart and ' +
'has a legend toggle',
'Each series is represented by a specific color in the chart.',
),
};

Expand Down Expand Up @@ -166,21 +166,29 @@ export const dndAdhocMetricsControl: SharedControlConfig<
datasource,
datasourceType: datasource?.type,
}),
description: t('One or many metrics to display'),
description: t(
'Select one or many metrics to display. ' +
'You can use an aggregation function on a column ' +
'or write custom SQL to create a metric.',
),
};

export const dndAdhocMetricControl: typeof dndAdhocMetricsControl = {
...dndAdhocMetricsControl,
multi: false,
label: t('Metric'),
description: t('Metric'),
description: t(
'Select a metric to display. ' +
'You can use an aggregation function on a column ' +
'or write custom SQL to create a metric.',
),
};

export const dndAdhocMetricControl2: typeof dndAdhocMetricControl = {
...dndAdhocMetricControl,
label: t('Right Axis Metric'),
clearable: true,
description: t('Choose a metric for right axis'),
description: t('Select a metric to display on the right axis'),
};

export const dndSortByControl: SharedControlConfig<
Expand All @@ -190,8 +198,8 @@ export const dndSortByControl: SharedControlConfig<
label: t('Sort by'),
default: null,
description: t(
'Metric used to define how the top series are sorted if a series or row limit is present. ' +
'If undefined reverts to the first metric (where appropriate).',
'This metric is used to define row selection criteria (how the rows are sorted) if a series or row limit is present. ' +
'If not defined, it reverts to the first metric (where appropriate).',
),
mapStateToProps: ({ datasource }) => ({
columns: datasource?.columns || [],
Expand All @@ -211,14 +219,18 @@ export const dndSizeControl: typeof dndAdhocMetricControl = {
export const dndXControl: typeof dndAdhocMetricControl = {
...dndAdhocMetricControl,
label: t('X Axis'),
description: t('Metric assigned to the [X] axis'),
description: t(
"The dataset column/metric that returns the values on your chart's x-axis.",
),
default: null,
};

export const dndYControl: typeof dndAdhocMetricControl = {
...dndAdhocMetricControl,
label: t('Y Axis'),
description: t('Metric assigned to the [Y] axis'),
description: t(
"The dataset column/metric that returns the values on your chart's y-axis.",
),
default: null,
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,9 @@ const time_grain_sqla: SharedControlConfig<'SelectControl'> = {
: 'P1D';
},
description: t(
'The time granularity for the visualization. This ' +
'applies a date transformation to alter ' +
'your time column and defines a new time granularity. ' +
'The options here are defined on a per database ' +
'engine basis in the Superset source code.',
'Select a time grain for the visualization. The ' +
'grain is the time interval represented by a ' +
'single point on the chart.',
),
mapStateToProps: ({ datasource }) => ({
choices: (datasource as Dataset)?.time_grain_sqla || [],
Expand Down Expand Up @@ -232,7 +230,7 @@ const time_range: SharedControlConfig<'DateFilterControl'> = {
label: TIME_FILTER_LABELS.time_range,
default: NO_TIME_RANGE, // this value is an empty filter constant so shouldn't translate it.
description: t(
'The time range for the visualization. All relative times, e.g. "Last month", ' +
'This control filters the whole chart based on the selected time range. All relative times, e.g. "Last month", ' +
'"Last 7 days", "now", etc. are evaluated on the server using the server\'s ' +
'local time (sans timezone). All tooltips and placeholder times are expressed ' +
'in UTC (sans timezone). The timestamps are then evaluated by the database ' +
Expand All @@ -248,14 +246,18 @@ const row_limit: SharedControlConfig<'SelectControl'> = {
validators: [legacyValidateInteger],
default: 10000,
choices: formatSelectOptions(ROW_LIMIT_OPTIONS),
description: t('Limits the number of rows that get displayed.'),
description: t(
'Limits the number of the rows that are computed in the query that is the source of the data used for this chart.',
),
};

const order_desc: SharedControlConfig<'CheckboxControl'> = {
type: 'CheckboxControl',
label: t('Sort Descending'),
default: true,
description: t('Whether to sort descending or ascending'),
description: t(
'If enabled, this control sorts the results/values descending, otherwise it sorts the results ascending.',
),
visibility: ({ controls }) =>
Boolean(
controls?.timeseries_limit_metric.value &&
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ const percentMetrics: typeof sharedControls.metrics = {
type: 'MetricsControl',
label: t('Percentage metrics'),
description: t(
'Metrics for which percentage of total are to be displayed. Calculated from only data within the row limit.',
'Select one or many metrics to display, that will be displayed in the percentages of total. ' +
'Percentage metrics will be calculated only from data within the row limit. ' +
'You can use an aggregation function on a column or write custom SQL to create a percentage metric.',
),
multi: true,
visibility: isAggMode,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,9 @@ const percentMetricsControl: typeof sharedControls.metrics = {
...sharedControls.metrics,
label: t('Percentage metrics'),
description: t(
'Metrics for which percentage of total are to be displayed. Calculated from only data within the row limit.',
'Select one or many metrics to display, that will be displayed in the percentages of total. ' +
'Percentage metrics will be calculated only from data within the row limit. ' +
'You can use an aggregation function on a column or write custom SQL to create a percentage metric.',
),
visibility: isAggMode,
resetOnHide: false,
Expand Down Expand Up @@ -351,7 +353,9 @@ const config: ControlPanelConfig = {
type: 'CheckboxControl',
label: t('Sort descending'),
default: true,
description: t('Whether to sort descending or ascending'),
description: t(
'If enabled, this control sorts the results/values descending, otherwise it sorts the results ascending.',
),
visibility: isAggMode,
resetOnHide: false,
},
Expand Down Expand Up @@ -455,7 +459,7 @@ const config: ControlPanelConfig = {
renderTrigger: true,
default: true,
description: t(
'Whether to colorize numeric values by if they are positive or negative',
'Whether to colorize numeric values by whether they are positive or negative',
),
},
},
Expand Down

0 comments on commit e36e0fd

Please sign in to comment.