Skip to content

feat: SW-1892 Add compact density variant for dashboard-tile charts #144

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.

Sign up for GitHub

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

Open
owilliams-tetrascience wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: SW-1892 Add compact density variant for dashboard-tile charts #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 54 additions & 0 deletions src/components/charts/AreaGraph/AreaGraph.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,60 @@ export const Stacked: Story = {
},
};

export const CompactDashboardTile: Story = {
name: "Compact (Dashboard Tile)",
parameters: {
// Auto-generated by sync-storybook-zephyr - do not add manually
zephyr: { testCaseId: "" },
},
args: {
// Idiomatic dashboard-tile usage: omit width/height so the chart fills its
// tile (responsive), and set density="compact" to shrink the chrome.
dataSeries: sampleDataSeries,
title: "Yield",
xTitle: "Run",
yTitle: "g/L",
variant: "normal",
density: "compact",
},
render: (args) => (
<div
style={{
width: 600,
height: 260,
border: "1px solid var(--border, #e2e8f0)",
borderRadius: 8,
overflow: "hidden",
}}
>
<AreaGraph {...args} />
</div>
),
play: async ({ canvasElement, step }) => {
const canvas = within(canvasElement);

await step("Compact title is displayed", async () => {
// Responsive fill renders after the ResizeObserver measures the tile.
await waitFor(() => {
expect(canvas.getByText("Yield")).toBeInTheDocument();
});
});

await step("Chart fills the tile and its plot area exceeds 65%", async () => {
await waitFor(() => {
const plot = canvasElement.querySelector(".js-plotly-plot") as HTMLElement;
expect(plot).toBeInTheDocument();
const drag = canvasElement.querySelector(".nsewdrag");
const w = parseFloat(drag?.getAttribute("width") ?? "0");
const h = parseFloat(drag?.getAttribute("height") ?? "0");
const canvasArea = plot.clientWidth * plot.clientHeight;
expect(canvasArea).toBeGreaterThan(0);
expect((w * h) / canvasArea).toBeGreaterThan(0.65);
});
});
},
};

const weekdayDataSeries = [
{
// x positions are integer indices; xTickText supplies the day labels
Expand Down
61 changes: 40 additions & 21 deletions src/components/charts/AreaGraph/AreaGraph.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ import { chartTooltipLines, useChartTooltip } from "../ChartTooltip";
import { useElementSize } from "@/hooks/use-element-size";
import { usePlotlyTheme } from "@/hooks/use-plotly-theme";
import { cn } from "@/lib/utils";
import {
COMPACT_AXIS_TITLE_STANDOFF,
COMPACT_CHART_MARGIN,
chartDensityTokens,
type ChartDensity,
} from "@/utils/chartDensity";
import { seriesColor } from "@/utils/colors";

interface AreaDataSeries {
Expand All @@ -19,6 +25,9 @@ interface AreaDataSeries {

type AreaGraphVariant = "normal" | "stacked";

/** Comfortable-density gap between each axis title and its ticks */
const COMFORTABLE_AXIS_TITLE_STANDOFF = 15;

/** Top margin reserving room for the 32px title; reduced when no title is set */
const TITLE_MARGIN_TOP = 80;
const NO_TITLE_MARGIN_TOP = 40;
Expand All @@ -41,6 +50,8 @@ interface AreaGraphProps {
xTitle?: string;
yTitle?: string;
title?: string;
/** Sizing preset; `"compact"` shrinks fonts and margins for dashboard tiles */
density?: ChartDensity;
/**
* Categorical labels for the x-axis ticks. When provided, the x data values
* still drive area positioning but the displayed tick labels match these
Expand All @@ -60,6 +71,7 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
xTitle,
yTitle,
title,
density = "comfortable",
xTickText,
}) => {
const plotRef = useRef<HTMLDivElement>(null);
Expand Down Expand Up @@ -169,6 +181,9 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
return ticks;
}, [effectiveYRange]);

const tokens = useMemo(() => chartDensityTokens(density), [density]);
const compact = density === "compact";

// When categorical labels are supplied, ticks must sit on the actual data
// x-positions rather than the computed nice-step values above. Sorted
// ascending so labels map deterministically to x regardless of series order.
Expand All @@ -188,7 +203,7 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
tickwidth: 1,
ticks: "outside" as const,
tickfont: {
size: 16,
size: tokens.tickFontSize,
color: theme.textColor,
family: "Inter, sans-serif",
weight: 400,
Expand All @@ -198,7 +213,7 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
position: 0,
zeroline: false,
}),
[theme],
[theme, tokens.tickFontSize],
);

const titleOptions = useMemo(
Expand All @@ -211,7 +226,7 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
xanchor: "center" as const,
yanchor: "top" as const,
font: {
size: 32,
size: tokens.titleFontSize,
weight: 600,
family: "Inter, sans-serif",
color: theme.textColor,
Expand All @@ -220,7 +235,7 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
},
}
: undefined,
[title, theme],
[title, theme, tokens.titleFontSize],
);

useEffect(() => {
Expand Down Expand Up @@ -283,15 +298,17 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
width: sizeRef.current.width,
height: sizeRef.current.height,
...(titleOptions ? { title: titleOptions } : {}),
margin: {
l: 80,
r: 40,
// Reserve room for tick labels, the x-axis title, and the
// container-anchored bottom legend stacked beneath them.
b: 96,
t: title ? TITLE_MARGIN_TOP : NO_TITLE_MARGIN_TOP,
pad: 0,
},
margin: compact
? COMPACT_CHART_MARGIN
: {
l: 80,
r: 40,
// Reserve room for tick labels, the x-axis title, and the
// container-anchored bottom legend stacked beneath them.
b: 96,
t: title ? TITLE_MARGIN_TOP : NO_TITLE_MARGIN_TOP,
pad: 0,
},
paper_bgcolor: theme.paperBg,
plot_bgcolor: theme.plotBg,
font: {
Expand All @@ -302,12 +319,12 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
title: {
text: xTitle,
font: {
size: 16,
size: tokens.axisTitleFontSize,
color: theme.textSecondary,
family: "Inter, sans-serif",
weight: 400,
},
standoff: 15,
standoff: compact ? COMPACT_AXIS_TITLE_STANDOFF : COMFORTABLE_AXIS_TITLE_STANDOFF,
},
gridcolor: theme.gridColor,
range: xRange,
Expand All @@ -318,27 +335,27 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
showgrid: true,
// Reserve space for tick labels + the axis title so the bottom legend
// can't overlap them at small sizes (SW-2157).
automargin: true,
automargin: !compact,
...tickOptions,
},
yaxis: {
title: {
text: yTitle,
font: {
size: 16,
size: tokens.axisTitleFontSize,
color: theme.textSecondary,
family: "Inter, sans-serif",
weight: 400,
},
standoff: 15,
standoff: compact ? COMPACT_AXIS_TITLE_STANDOFF : COMFORTABLE_AXIS_TITLE_STANDOFF,
},
gridcolor: theme.gridColor,
range: yRange,
autorange: !yRange,
tickmode: "array" as const,
tickvals: yTicks,
showgrid: true,
automargin: true,
automargin: !compact,
...tickOptions,
},
legend: {
Expand All @@ -359,7 +376,9 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
lineheight: 18,
},
},
showlegend: true,
// Compact tiles are too short to fit a legend below the plot without
// Plotly's automargin eating most of the data area
showlegend: !compact,
};

const config = {
Expand All @@ -385,7 +404,7 @@ const AreaGraph: React.FC<AreaGraphProps> = ({
plotInitedRef.current = false;
}
};
}, [dataSeries, hasSize, xRange, yRange, effectiveXRange, effectiveYRange, variant, xTitle, yTitle, title, titleOptions, tickOptions, xTicks, yTicks, xDataValues, useCategoricalX, xTickText, theme, bindTooltip]);
}, [dataSeries, hasSize, xRange, yRange, effectiveXRange, effectiveYRange, variant, xTitle, yTitle, title, titleOptions, tickOptions, xTicks, yTicks, xDataValues, useCategoricalX, xTickText, theme, bindTooltip, compact, tokens]);

// Resize in place when the measured/overridden size changes — far cheaper
// than recreating the plot (and it preserves tooltip/event bindings).
Expand Down
53 changes: 53 additions & 0 deletions src/components/charts/BarGraph/BarGraph.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,59 @@ export const CustomStyling: Story = {
},
};

export const CompactDashboardTile: Story = {
name: "Compact (Dashboard Tile)",
parameters: {
// Auto-generated by sync-storybook-zephyr - do not add manually
zephyr: { testCaseId: "" },
},
args: {
// Idiomatic dashboard-tile usage: omit width/height so the chart fills its
// tile (responsive), and set density="compact" to shrink the chrome.
dataSeries: generateBasicData(),
title: "Throughput",
xTitle: "Batch",
yTitle: "Units",
density: "compact",
},
render: (args) => (
<div
style={{
width: 600,
height: 260,
border: "1px solid var(--border, #e2e8f0)",
borderRadius: 8,
overflow: "hidden",
}}
>
<BarGraph {...args} />
</div>
),
play: async ({ canvasElement, step }) => {
const canvas = within(canvasElement);

await step("Compact title is displayed", async () => {
// Responsive fill renders after the ResizeObserver measures the tile.
await waitFor(() => {
expect(canvas.getByText("Throughput")).toBeInTheDocument();
});
});

await step("Chart fills the tile and its plot area exceeds 65%", async () => {
await waitFor(() => {
const plot = canvasElement.querySelector(".js-plotly-plot") as HTMLElement;
expect(plot).toBeInTheDocument();
const drag = canvasElement.querySelector(".nsewdrag");
const w = parseFloat(drag?.getAttribute("width") ?? "0");
const h = parseFloat(drag?.getAttribute("height") ?? "0");
const canvasArea = plot.clientWidth * plot.clientHeight;
expect(canvasArea).toBeGreaterThan(0);
expect((w * h) / canvasArea).toBeGreaterThan(0.65);
});
});
},
};

export const ContainerFilled: Story = {
name: "Container Filled (responsive)",
parameters: {
Expand Down
Loading
Loading