Skip to content

Commit d2931cc

Browse files
authored
Merge pull request #47 from kaseyvee/o-main
docs(rechartsTimeSeries): update prop descriptions
2 parents de972d2 + 1ee2b28 commit d2931cc

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/components/chart/rechartsTimeSeries.stories.tsx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ export default {
99
timeSeries: {
1010
control: 'array',
1111
description:
12-
'Data to be displayed in the time series chart. The first field is used as the x-axis field. We currently support formatting timestamps in seconds and milliseconds. Other data types will be displayed as given. \n<pre>```interface TimeSeriesData:{\n timestamp: number\n [key: string]: number\n}```</pre>',
12+
'Data to be displayed in the time series chart. The first field is used as the x-axis field. We currently support formatting timestamps in seconds and milliseconds. Other data types will be displayed as given. \n<pre>```interface TimeSeriesData {\n timestamp: number\n [key: string]: number\n}```</pre>',
13+
},
14+
chartContainerMargin: {
15+
description:
16+
'Margin of chart container in pixel. For example, adding left margin could show larger numbers properly.\n<pre>```interface Margin {\n top?: number\n right?: number\n bottom?: number\n left?: number\n}```</pre>',
1317
},
1418
},
1519
parameters: {

src/components/chart/rechartsTimeSeries.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export interface RechartsTimeSeriesProps {
7474
width?: number
7575
/** Chart type toggle will be hidden if the value is true. */
7676
disableChartTypeToggle?: boolean
77-
/** Define the default chart type: 'line', 'bar', or 'area'. */
77+
/** Define the default chart type: `line`, `bar`, or `area`. */
7878
defaultChartType?: TimeSeriesType
7979
/** Pass a function to format y-axis label. Make sure to use tooltipFormatter and yAxisTickFormatter together so that the numbers are uniform. */
8080
yAxisTickFormatter?: (value: number) => string

0 commit comments

Comments
 (0)