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.

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

Jump to bottom

Audit typescript props and add a demo for VictoryCursorContainer #1532

Merged
merged 2 commits into from
Apr 28, 2020
Merged

Audit typescript props and add a demo for VictoryCursorContainer #1532

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e2e019
Audit typescript props and add a demo for VictoryCursorContainer
maddles Apr 24, 2020
f6c6986
Allow any and void for cursorLabel in VictoryContainerProps
maddles Apr 27, 2020
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
2 changes: 2 additions & 0 deletions demo/ts/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import BrushContainerDemo from "./components/victory-brush-container-demo";
import BrushLineDemo from "./components/victory-brush-line-demo";
import CandlestickDemo from "./components/victory-candlestick-demo";
import ChartDemo from "./components/victory-chart-demo";
import CursorContainerDemo from "./components/victory-cursor-container-demo";
import LegendDemo from "./components/victory-legend-demo";
import LineDemo from "./components/victory-line-demo";
import PieDemo from "./components/victory-pie-demo";
Expand All @@ -28,6 +29,7 @@ const MAP = {
"/brush-line": { component: BrushLineDemo, name: "BrushLineDemo" },
"/candlestick": { component: CandlestickDemo, name: "CandlestickDemo" },
"/chart": { component: ChartDemo, name: "ChartDemo" },
"/cursor-container": { component: CursorContainerDemo, name: "CursorContainerDemo" },
"/line": { component: LineDemo, name: "LineDemo" },
"/tooltip": { component: TooltipDemo, name: "TooltipDemo" },
"/legend": { component: LegendDemo, name: "LegendDemo" },
Expand Down
315 changes: 315 additions & 0 deletions demo/ts/components/victory-cursor-container-demo.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,315 @@
/*global window:false*/
/*eslint-disable no-magic-numbers */
import React from "react";
import { random, range, round } from "lodash";
import { VictoryChart } from "@packages/victory-chart";
import { VictoryStack } from "@packages/victory-stack";
import { VictoryGroup } from "@packages/victory-group";
import { VictoryBar } from "@packages/victory-bar";
import { VictoryLine } from "@packages/victory-line";
import { VictoryScatter } from "@packages/victory-scatter";
import { VictoryCursorContainer } from "@packages/victory-cursor-container";
import { VictoryTooltip } from "@packages/victory-tooltip";
import { VictoryLegend } from "@packages/victory-legend";
import { VictoryTheme, CursorData } from "@packages/victory-core";

interface VictoryCursorContainerStateInterface {
data: { a: number; b: number }[];
cursorValue: CursorData;
bigData: CursorData[];
}

const makeData = () => range(1500).map((x) => ({ x, y: x + 10 * Math.random() }));

class App extends React.Component<any, VictoryCursorContainerStateInterface> {
defaultCursorValue?: CursorData = undefined;
setStateInterval?: number = undefined;

constructor(props: any) {
super(props);
this.defaultCursorValue = { x: 2.25, y: 1.75 };

this.state = {
data: this.getData(),
cursorValue: this.defaultCursorValue,
bigData: makeData()
};
}

componentDidMount() {
/* eslint-disable react/no-did-mount-set-state */
this.setStateInterval = window.setInterval(() => {
this.setState({
data: this.getData()
});
}, 3000);
}

componentWillUnmount() {
window.clearInterval(this.setStateInterval);
}

getData() {
const bars = random(6, 10);
return range(bars).map((bar) => {
return { a: bar + 1, b: random(2, 10) };
});
}

render() {
const containerStyle: React.CSSProperties = {
display: "flex",
flexDirection: "row",
flexWrap: "wrap",
alignItems: "center",
justifyContent: "center"
};

const chartStyle = { parent: { border: "1px solid #ccc", margin: "2%", maxWidth: "40%" } };

const cursorLabel = (datum: CursorData) => round(datum.x, 2);

return (
<div className="demo">
<div style={containerStyle}>
<VictoryChart
style={chartStyle}
theme={VictoryTheme.material}
height={400}
padding={{ top: 100, bottom: 40, left: 50, right: 50 }}
containerComponent={<VictoryCursorContainer cursorLabel={cursorLabel} />}
>
<VictoryLegend
x={90}
y={10}
title="Legend"
centerTitle
orientation="horizontal"
gutter={20}
style={{ border: { stroke: "black" }, title: { fontSize: 20 } }}
data={[
{ name: "One", symbol: { fill: "tomato" } },
{ name: "Two", symbol: { fill: "orange" } },
{ name: "Three", symbol: { fill: "gold" } }
]}
/>
<VictoryLine data={this.state.bigData} />
</VictoryChart>

<VictoryChart
horizontal
style={chartStyle}
theme={VictoryTheme.material}
domainPadding={{ x: 15 }}
containerComponent={
<VictoryCursorContainer
cursorLabel={cursorLabel}
cursorDimension="y"
defaultCursorValue={3}
/>
}
>
<VictoryGroup offset={10}>
<VictoryBar
data={[
{ x: 1, y: 5, l: "one" },
{ x: 2, y: 4, l: "two" },
{ x: 3, y: -2, l: "three" }
]}
style={{
labels: { fill: "tomato" }
}}
/>

<VictoryBar
data={[
{ x: 1, y: -3, l: "red" },
{ x: 2, y: 5, l: "green" },
{ x: 3, y: 3, l: "blue" }
]}
style={{
labels: { fill: "blue" }
}}
/>

<VictoryBar
data={[
{ x: 1, y: 5, l: "cat" },
{ x: 2, y: -4, l: "dog" },
{ x: 3, y: -2, l: "bird" }
]}
style={{
labels: { fill: "black" }
}}
/>
</VictoryGroup>
</VictoryChart>

<VictoryScatter
animate={{ duration: 1000 }}
style={{
parent: chartStyle.parent,
data: {
fill: ({ active }) => (active ? "tomato" : "black")
}
}}
containerComponent={
<VictoryCursorContainer
cursorLabel={(datum: CursorData) => round(datum.x, 2)}
cursorDimension="x"
defaultCursorValue={1}
/>
}
size={({ active }) => (active ? 5 : 3)}
data={this.state.data}
x="a"
y="b"
/>

<VictoryScatter
style={{
parent: chartStyle.parent,
data: {
fill: ({ active }) => (active ? "tomato" : "black")
}
}}
containerComponent={
<VictoryCursorContainer
style={{
stroke: "tomato",
strokeWidth: 2,
fill: "tomato",
fillOpacity: 0.1
}}
/>
}
size={({ active }) => (active ? 5 : 3)}
y={(d) => d.x * d.x}
/>

<VictoryChart
style={chartStyle}
containerComponent={
<VictoryCursorContainer
defaultCursorValue={2}
cursorDimension="x"
cursorLabel={(datum: CursorData) => round(datum.x, 2)}
cursorLabelOffset={15}
/>
}
>
<VictoryGroup style={chartStyle}>
<VictoryScatter
style={{
data: { fill: "tomato" }
}}
size={({ active }) => (active ? 5 : 3)}
labels={({ datum }) => datum.y}
labelComponent={<VictoryTooltip />}
data={[
{ x: 1, y: -5 },
{ x: 2, y: 4 },
{ x: 3, y: 2 },
{ x: 4, y: 0 },
{ x: 5, y: 1 },
{ x: 6, y: -3 },
{ x: 7, y: 3 }
]}
/>
<VictoryScatter
style={{
data: { fill: "blue" }
}}
size={({ active }) => (active ? 5 : 3)}
labels={({ datum }) => datum.y}
labelComponent={<VictoryTooltip />}
data={[
{ x: 1, y: -3 },
{ x: 2, y: 5 },
{ x: 3, y: 3 },
{ x: 4, y: 0 },
{ x: 5, y: -2 },
{ x: 6, y: -2 },
{ x: 7, y: 5 }
]}
/>
<VictoryScatter
data={[
{ x: 1, y: 5 },
{ x: 2, y: -4 },
{ x: 3, y: -2 },
{ x: 4, y: -3 },
{ x: 5, y: -1 },
{ x: 6, y: 3 },
{ x: 7, y: -3 }
]}
labels={(d) => d.y}
labelComponent={<VictoryTooltip />}
size={({ active }) => (active ? 5 : 3)}
/>
</VictoryGroup>
</VictoryChart>

<VictoryStack style={chartStyle} containerComponent={<VictoryCursorContainer />}>
<VictoryBar
style={{
data: {
fill: "tomato",
stroke: ({ active }) => (active ? "black" : "none"),
strokeWidth: 2
}
}}
data={[
{ x: 1, y: -5 },
{ x: 2, y: 4 },
{ x: 3, y: 2 },
{ x: 4, y: 3 },
{ x: 5, y: 1 },
{ x: 6, y: -3 },
{ x: 7, y: 3 }
]}
/>
<VictoryBar
style={{
data: {
fill: "orange",
stroke: ({ active }) => (active ? "black" : "none"),
strokeWidth: 2
}
}}
data={[
{ x: 1, y: -3 },
{ x: 2, y: 5 },
{ x: 3, y: 3 },
{ x: 4, y: 0 },
{ x: 5, y: -2 },
{ x: 6, y: -2 },
{ x: 7, y: 5 }
]}
/>
<VictoryBar
style={{
data: {
fill: "gold",
stroke: ({ active }) => (active ? "black" : "none"),
strokeWidth: 2
}
}}
data={[
{ x: 1, y: 5 },
{ x: 2, y: -4 },
{ x: 3, y: -2 },
{ x: 4, y: -3 },
{ x: 5, y: -1 },
{ x: 6, y: 3 },
{ x: 7, y: -3 }
]}
/>
</VictoryStack>
</div>
</div>
);
}
}

export default App;
2 changes: 1 addition & 1 deletion packages/victory-cursor-container/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { VictoryContainerProps, CursorData } from "victory-core";
export interface VictoryCursorContainerProps extends VictoryContainerProps {
cursorComponent?: React.ReactElement;
cursorDimension?: "x" | "y";
cursorLabel?: (point: CursorData) => void;
cursorLabel?: (point: CursorData) => number;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. cursorLabel should be able to return a string, too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall I do string | number, or is there a situation where void should be accepted too?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, folks sometimes return null to render no label for a given data point. Let's leave this one as flexible as possible.

cursorLabelComponent?: React.ReactElement;
cursorLabelOffset?: number | CursorData;
defaultCursorValue?: number | CursorData;
Expand Down