Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow the X and Y tick format to be customized #6370

Merged
merged 1 commit into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions client/cypress/support/visualizations/chart.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ export function assertAxesAndAddLabels(xaxisLabel, yaxisLabel) {
.clear()
.type(yaxisLabel);

cy.getByTestId("Chart.LeftYAxis.TickFormat")
.clear()
.type("+");

cy.getByTestId("VisualizationEditor.Tabs.General").click();
}

Expand Down
13 changes: 13 additions & 0 deletions viz-lib/src/components/visualizations/editor/ContextHelp.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,18 @@ function DateTimeFormatSpecs() {
);
}

function TickFormatSpecs() {
const { HelpTriggerComponent } = visualizationsSettings;
return (
<HelpTriggerComponent
title="Tick Formatting"
href="https://redash.io/help/user-guide/visualizations/formatting-axis"
className="visualization-editor-context-help">
{ContextHelp.defaultIcon}
</HelpTriggerComponent>
);
}

ContextHelp.NumberFormatSpecs = NumberFormatSpecs;
ContextHelp.DateTimeFormatSpecs = DateTimeFormatSpecs;
ContextHelp.TickFormatSpecs = TickFormatSpecs;
20 changes: 19 additions & 1 deletion viz-lib/src/visualizations/chart/Editor/AxisSettings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { isString, isObject, isFinite, isNumber, merge } from "lodash";
import React from "react";
import { useDebouncedCallback } from "use-debounce";
import * as Grid from "antd/lib/grid";
import { Section, Select, Input, InputNumber } from "@/components/visualizations/editor";
import { Section, Select, Input, InputNumber, ContextHelp } from "@/components/visualizations/editor";

function toNumber(value: any) {
value = isNumber(value) ? value : parseFloat(value);
Expand All @@ -18,6 +18,7 @@ type OwnProps = {
};
rangeMin?: number;
rangeMax?: number;
tickFormat?: string;
};
features?: {
autoDetectType?: boolean;
Expand All @@ -40,6 +41,8 @@ export default function AxisSettings({ id, options, features, onChange }: Props)

const [handleMinMaxChange] = useDebouncedCallback(opts => optionsChanged(opts), 200);

const [handleTickFormatChange] = useDebouncedCallback(opts => optionsChanged(opts), 200);

return (
<React.Fragment>
{/* @ts-expect-error ts-migrate(2745) FIXME: This JSX tag's 'children' prop expects type 'never... Remove this comment to see the full error message */}
Expand Down Expand Up @@ -89,6 +92,21 @@ export default function AxisSettings({ id, options, features, onChange }: Props)
/>
</Section>

{/* @ts-expect-error ts-migrate(2745) FIXME: This JSX tag's 'children' prop expects type 'never... Remove this comment to see the full error message */}
<Section>
<Input
label={
<React.Fragment>
Tick Format
<ContextHelp.TickFormatSpecs />
</React.Fragment>
}
data-test={`Chart.${id}.TickFormat`}
defaultValue={options.tickFormat}
onChange={(event: any) => handleTickFormatChange({ tickFormat: event.target.value })}
/>
</Section>

{features.range && (
// @ts-expect-error ts-migrate(2745) FIXME: This JSX tag's 'children' prop expects type 'never... Remove this comment to see the full error message
<Section>
Expand Down
14 changes: 14 additions & 0 deletions viz-lib/src/visualizations/chart/Editor/XAxisSettings.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,20 @@ describe("Visualizations -> Chart -> Editor -> X-Axis Settings", () => {
.simulate("change", { target: { value: "test" } });
});

test("Changes axis tick format", done => {
const el = mount(
{
globalSeriesType: "column",
xAxis: { },
},
done
);

findByTestID(el, "Chart.XAxis.TickFormat")
.last()
.simulate("change", { target: { value: "%B" } });
});

test("Sets Show Labels option", done => {
const el = mount(
{
Expand Down
14 changes: 14 additions & 0 deletions viz-lib/src/visualizations/chart/Editor/YAxisSettings.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,20 @@ describe("Visualizations -> Chart -> Editor -> Y-Axis Settings", () => {
.simulate("change", { target: { value: "test" } });
});

test("Changes axis tick format", done => {
const el = mount(
{
globalSeriesType: "column",
yAxis: [],
},
done
);

findByTestID(el, "Chart.LeftYAxis.TickFormat")
.last()
.simulate("change", { target: { value: "s" } });
});

test("Changes axis min value", done => {
const el = mount(
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ Object {
}
`;

exports[`Visualizations -> Chart -> Editor -> X-Axis Settings Changes axis tick format 1`] = `
Object {
"xAxis": Object {
"labels": Object {
"enabled": true,
},
"tickFormat": "%B",
"type": "-",
},
}
`;

exports[`Visualizations -> Chart -> Editor -> X-Axis Settings Changes axis type 1`] = `
Object {
"xAxis": Object {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ Object {
}
`;

exports[`Visualizations -> Chart -> Editor -> Y-Axis Settings Changes axis tick format 1`] = `
Object {
"yAxis": Array [
Object {
"tickFormat": "s",
"type": "linear",
},
Object {
"opposite": true,
"type": "linear",
},
],
}
`;

exports[`Visualizations -> Chart -> Editor -> Y-Axis Settings Changes axis type 1`] = `
Object {
"yAxis": Array [
Expand Down
2 changes: 2 additions & 0 deletions viz-lib/src/visualizations/chart/plotly/prepareLayout.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ function prepareXAxis(axisOptions: any, additionalOptions: any) {
title: getAxisTitle(axisOptions),
type: getAxisScaleType(axisOptions),
automargin: true,
tickformat: axisOptions.tickFormat,
};

if (additionalOptions.sortX && axis.type === "category") {
Expand Down Expand Up @@ -48,6 +49,7 @@ function prepareYAxis(axisOptions: any) {
automargin: true,
autorange: true,
range: null,
tickformat: axisOptions.tickFormat,
};
}

Expand Down
Loading