Skip to content

docs(rechartsTimeSeries): update prop descriptions #47

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

Merged
merged 1 commit into from
Mar 25, 2024
Merged

docs(rechartsTimeSeries): update prop descriptions #47

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
6 changes: 5 additions & 1 deletion src/components/chart/rechartsTimeSeries.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ export default {
timeSeries: {
control: 'array',
description:
'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>',
'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>',
},
chartContainerMargin: {
description:
'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>',
},
},
parameters: {
Expand Down
2 changes: 1 addition & 1 deletion src/components/chart/rechartsTimeSeries.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export interface RechartsTimeSeriesProps {
width?: number
/** Chart type toggle will be hidden if the value is true. */
disableChartTypeToggle?: boolean
/** Define the default chart type: 'line', 'bar', or 'area'. */
/** Define the default chart type: `line`, `bar`, or `area`. */
defaultChartType?: TimeSeriesType
/** Pass a function to format y-axis label. Make sure to use tooltipFormatter and yAxisTickFormatter together so that the numbers are uniform. */
yAxisTickFormatter?: (value: number) => string
Expand Down