2022-10-02 15:01:17 -04:00
|
|
|
import { AxisBottom, AxisLeft } from "@visx/axis";
|
|
|
|
import { bottomTickLabelProps } from "@visx/axis/lib/axis/AxisBottom";
|
|
|
|
import { leftTickLabelProps } from "@visx/axis/lib/axis/AxisLeft";
|
|
|
|
import { localPoint } from "@visx/event";
|
|
|
|
import { GridColumns, GridRows } from "@visx/grid";
|
|
|
|
import { Group } from "@visx/group";
|
|
|
|
import { LegendOrdinal } from "@visx/legend";
|
|
|
|
import { Point } from "@visx/point";
|
|
|
|
import { scaleBand, scaleLinear, scaleOrdinal } from "@visx/scale";
|
|
|
|
import { LinePath } from "@visx/shape";
|
2022-11-16 21:35:55 -05:00
|
|
|
import { withTooltip } from "@visx/tooltip";
|
2022-10-02 15:01:17 -04:00
|
|
|
import React from "react";
|
|
|
|
import { Color } from "utils/Color";
|
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
import { TooltipWrapper } from "./TooltipWrapper";
|
|
|
|
|
2022-10-02 15:01:17 -04:00
|
|
|
import styles from "./LineGraph.module.css";
|
|
|
|
|
|
|
|
interface LineData {
|
|
|
|
label: string;
|
|
|
|
yValues: number[];
|
|
|
|
}
|
|
|
|
|
|
|
|
interface PointData {
|
|
|
|
x: string;
|
|
|
|
y: number;
|
|
|
|
}
|
|
|
|
|
|
|
|
interface LineGraphData {
|
|
|
|
xValues: string[];
|
|
|
|
lines: LineData[];
|
|
|
|
}
|
|
|
|
|
|
|
|
interface LegendProps {
|
|
|
|
/** Position of the legend, relative to the graph. */
|
|
|
|
position?: "top" | "right";
|
|
|
|
/** Font size of the labels in the legend, in pixels. Default is 16px. */
|
|
|
|
itemLabelSize?: number;
|
|
|
|
/** Gap between items in the legend, in pixels. */
|
|
|
|
itemGap?: number;
|
|
|
|
/** Distance between the legend and other adjacent elements, in pixels. */
|
|
|
|
margin?: {
|
|
|
|
top?: number;
|
|
|
|
bottom?: number;
|
|
|
|
left?: number;
|
|
|
|
right?: number;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
interface LineGraphProps {
|
|
|
|
data: LineGraphData;
|
|
|
|
/** Width of the entire graph, in pixels. */
|
|
|
|
width: number;
|
|
|
|
/** Height of the entire graph, in pixels. */
|
|
|
|
height: number;
|
|
|
|
/** Distance between the edge of the graph and the area where the bars are drawn, in pixels. */
|
|
|
|
margin: {
|
|
|
|
top: number;
|
|
|
|
bottom: number;
|
|
|
|
left: number;
|
|
|
|
right: number;
|
|
|
|
};
|
|
|
|
className?: string;
|
|
|
|
/** Font size of the category tick labels, in pixels. Default is 16px. */
|
|
|
|
xTickLabelSize?: number;
|
|
|
|
/** Font size of the value tick labels, in pixels. Default is 16px. */
|
|
|
|
yTickLabelSize?: number;
|
|
|
|
/** Font size of the value that appears when hovering over a bar, in pixels. */
|
|
|
|
hoverLabelSize?: number;
|
|
|
|
/** Label text for the category axis. */
|
|
|
|
xAxisLabel?: string;
|
|
|
|
/** Font size of the label for the cateogry axis, in pixels. */
|
|
|
|
xAxisLabelSize?: number;
|
|
|
|
/** Controls the distance between the category axis label and the category axis. */
|
|
|
|
xAxisLabelOffset?: number;
|
|
|
|
/** Label text for the value axis. */
|
|
|
|
yAxisLabel?: string;
|
|
|
|
/** Font size of the label for the value axis, in pixels. */
|
|
|
|
yAxisLabelSize?: number;
|
|
|
|
/** Controls the distance between the value axis label and the value axis. */
|
|
|
|
yAxisLabelOffset?: number;
|
|
|
|
legendProps?: LegendProps;
|
|
|
|
}
|
|
|
|
|
|
|
|
const DEFAULT_LABEL_SIZE = 16;
|
|
|
|
const DEFAULT_LEGEND_GAP = 16;
|
|
|
|
|
2022-10-22 14:04:12 -04:00
|
|
|
// TODO: Address unused props in this file
|
|
|
|
/* eslint-disable unused-imports/no-unused-vars*/
|
2022-11-16 21:35:55 -05:00
|
|
|
|
|
|
|
type TooltipData = string;
|
|
|
|
|
|
|
|
export const LineGraph = withTooltip<LineGraphProps, TooltipData>(
|
|
|
|
({
|
2022-10-02 15:01:17 -04:00
|
|
|
width,
|
|
|
|
height,
|
|
|
|
margin,
|
|
|
|
data,
|
|
|
|
className,
|
|
|
|
xTickLabelSize = DEFAULT_LABEL_SIZE,
|
|
|
|
yTickLabelSize = DEFAULT_LABEL_SIZE,
|
|
|
|
hoverLabelSize,
|
|
|
|
xAxisLabel,
|
|
|
|
xAxisLabelSize = DEFAULT_LABEL_SIZE,
|
|
|
|
xAxisLabelOffset = 0,
|
|
|
|
yAxisLabel,
|
|
|
|
yAxisLabelSize = DEFAULT_LABEL_SIZE,
|
|
|
|
yAxisLabelOffset = 0,
|
2022-11-16 21:35:55 -05:00
|
|
|
tooltipOpen,
|
2022-10-02 15:01:17 -04:00
|
|
|
tooltipLeft,
|
|
|
|
tooltipTop,
|
2022-11-16 21:35:55 -05:00
|
|
|
tooltipData,
|
2022-10-02 15:01:17 -04:00
|
|
|
hideTooltip,
|
2022-11-16 21:35:55 -05:00
|
|
|
showTooltip,
|
|
|
|
legendProps,
|
|
|
|
}) => {
|
|
|
|
const {
|
|
|
|
position: legendPosition = "right",
|
|
|
|
itemLabelSize: legendLabelSize = DEFAULT_LABEL_SIZE,
|
|
|
|
itemGap: legendItemGap = DEFAULT_LEGEND_GAP,
|
|
|
|
margin: legendMargin = {},
|
|
|
|
} = legendProps ?? {};
|
|
|
|
|
|
|
|
const xLength = data.xValues.length;
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
data.lines.forEach((line) => {
|
|
|
|
if (line.yValues.length != xLength) {
|
|
|
|
throw new Error("Invalid data with wrong length.");
|
|
|
|
}
|
|
|
|
});
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
const yMax = height - margin.top - margin.bottom;
|
|
|
|
const xMax = width - margin.left - margin.right;
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
const actualData = data.lines.map((line) => {
|
|
|
|
return line.yValues.map((val, idx) => {
|
|
|
|
return { x: data.xValues[idx], y: val };
|
|
|
|
});
|
2022-10-02 15:01:17 -04:00
|
|
|
});
|
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
const yMaxValue = Math.max(
|
|
|
|
...data.lines.map((line) => {
|
|
|
|
return Math.max(...line.yValues);
|
|
|
|
})
|
|
|
|
);
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
// data accessors
|
|
|
|
const getX = (d: PointData) => d.x;
|
|
|
|
const getY = (d: PointData) => d.y;
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
// scales
|
|
|
|
const xScale = scaleBand({
|
|
|
|
range: [0, xMax],
|
|
|
|
domain: data.xValues,
|
|
|
|
});
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
const yScale = scaleLinear<number>({
|
|
|
|
range: [0, yMax],
|
|
|
|
nice: true,
|
|
|
|
domain: [yMaxValue, 0],
|
|
|
|
});
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
const keys = data.lines.map((line) => line.label);
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
const legendScale = scaleOrdinal<string, string>({
|
|
|
|
domain: keys,
|
|
|
|
range: [Color.primaryAccent, Color.secondaryAccent],
|
|
|
|
});
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
return (
|
|
|
|
<div
|
|
|
|
className={
|
|
|
|
className ? `${className} ${styles.wrapper}` : styles.wrapper
|
|
|
|
}
|
2022-10-02 15:01:17 -04:00
|
|
|
style={{
|
2022-11-16 21:35:55 -05:00
|
|
|
flexDirection: legendPosition === "right" ? "row" : "column-reverse",
|
2022-10-02 15:01:17 -04:00
|
|
|
}}
|
2022-11-16 21:35:55 -05:00
|
|
|
>
|
|
|
|
<svg width={width} height={height}>
|
|
|
|
<Group top={margin.top} left={margin.left}>
|
|
|
|
<GridColumns
|
|
|
|
scale={xScale}
|
|
|
|
height={yMax}
|
|
|
|
left={margin.left}
|
|
|
|
numTicks={5}
|
|
|
|
stroke={Color.tertiaryBackground}
|
|
|
|
strokeWidth={4}
|
|
|
|
strokeDasharray="10"
|
|
|
|
strokeLinecap="round"
|
|
|
|
/>
|
|
|
|
<GridRows
|
|
|
|
scale={yScale}
|
|
|
|
width={xMax}
|
|
|
|
left={margin.left * 2.3}
|
|
|
|
numTicks={data.xValues.length}
|
|
|
|
stroke={Color.tertiaryBackground}
|
|
|
|
strokeWidth={4}
|
|
|
|
strokeDasharray="10"
|
|
|
|
strokeLinecap="round"
|
|
|
|
/>
|
|
|
|
<AxisBottom
|
|
|
|
scale={xScale}
|
|
|
|
top={margin.top + yMax}
|
|
|
|
left={margin.left}
|
|
|
|
hideAxisLine
|
|
|
|
hideTicks
|
|
|
|
tickLabelProps={() => {
|
|
|
|
return {
|
|
|
|
...bottomTickLabelProps(),
|
|
|
|
className: styles.tickLabel,
|
|
|
|
dy: "-0.25rem",
|
|
|
|
fontSize: `${xTickLabelSize / 16}rem`,
|
|
|
|
width: xScale.bandwidth(),
|
|
|
|
};
|
|
|
|
}}
|
|
|
|
/>
|
|
|
|
<AxisLeft
|
|
|
|
scale={yScale}
|
|
|
|
left={margin.left}
|
|
|
|
hideAxisLine
|
|
|
|
hideTicks
|
|
|
|
numTicks={5}
|
|
|
|
tickLabelProps={() => {
|
|
|
|
return {
|
|
|
|
...leftTickLabelProps(),
|
|
|
|
className: styles.tickLabel,
|
|
|
|
dx: "1.25rem",
|
|
|
|
dy: "0.25rem",
|
|
|
|
fontSize: `${yTickLabelSize / 16}rem`,
|
|
|
|
};
|
|
|
|
}}
|
|
|
|
/>
|
|
|
|
<Group left={margin.left + xMax / (data.xValues.length * 2)}>
|
|
|
|
{actualData.map((lineData, i) => {
|
|
|
|
const isEven = i % 2 === 0;
|
|
|
|
return (
|
|
|
|
<Group key={`line-${i}`}>
|
|
|
|
<LinePath
|
|
|
|
onMouseMove={(e) => {
|
|
|
|
const eventSvgCoords = localPoint(
|
|
|
|
// ownerSVGElement is given by visx docs but not recognized by typescript
|
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
|
|
// @ts-ignore
|
|
|
|
e.target.ownerSVGElement as Element,
|
|
|
|
e
|
|
|
|
) as Point;
|
|
|
|
showTooltip({
|
|
|
|
tooltipData: data.lines[i].label,
|
|
|
|
tooltipTop: eventSvgCoords.y,
|
|
|
|
tooltipLeft: eventSvgCoords.x,
|
|
|
|
});
|
|
|
|
}}
|
|
|
|
onMouseOut={hideTooltip}
|
|
|
|
data={lineData}
|
|
|
|
className={styles.line}
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
|
|
x={(d) => xScale(getX(d))!}
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
|
|
y={(d) => yScale(getY(d))!}
|
|
|
|
stroke={
|
|
|
|
isEven ? Color.primaryAccent : Color.secondaryAccent
|
|
|
|
}
|
|
|
|
strokeWidth={4}
|
|
|
|
strokeOpacity={2}
|
|
|
|
/>
|
|
|
|
</Group>
|
|
|
|
);
|
|
|
|
})}
|
|
|
|
</Group>
|
|
|
|
</Group>
|
|
|
|
</svg>
|
|
|
|
<LegendOrdinal
|
|
|
|
className={styles.legend}
|
|
|
|
style={{
|
|
|
|
marginTop: legendMargin.top,
|
|
|
|
marginRight: legendMargin.right,
|
|
|
|
marginBottom: legendMargin.bottom,
|
|
|
|
marginLeft: legendMargin.left,
|
|
|
|
fontSize: legendLabelSize,
|
|
|
|
}}
|
|
|
|
scale={legendScale}
|
|
|
|
direction={legendPosition === "right" ? "column" : "row"}
|
|
|
|
itemMargin={
|
|
|
|
legendPosition === "right"
|
|
|
|
? `calc(${legendItemGap / 2}rem / 16) 0 calc(${
|
|
|
|
legendItemGap / 2
|
|
|
|
}rem / 16) 0`
|
|
|
|
: `0 calc(${legendItemGap / 2}rem / 16) 0 calc(${
|
|
|
|
legendItemGap / 2
|
|
|
|
}rem / 16)`
|
|
|
|
}
|
|
|
|
/>
|
2022-10-02 15:01:17 -04:00
|
|
|
|
2022-11-16 21:35:55 -05:00
|
|
|
{tooltipOpen && (
|
|
|
|
<TooltipWrapper
|
|
|
|
top={tooltipTop}
|
|
|
|
left={tooltipLeft}
|
|
|
|
header={tooltipData as string}
|
|
|
|
></TooltipWrapper>
|
|
|
|
)}
|
|
|
|
</div>
|
|
|
|
);
|
|
|
|
}
|
|
|
|
);
|