feat: LineChart component API and docs improvements

This commit is contained in:
Demenech
2024-04-09 16:50:49 -03:00
parent d9c20528c5
commit c202d6cfc4
2 changed files with 38 additions and 31 deletions

View File

@@ -10,27 +10,30 @@ const meta: Meta = {
argTypes: {
data: {
description:
'Data to be displayed.\n\n E.g.: [["1990", 1], ["1991", 2]] \n\nOR\n\n "https://url.to/data.csv"',
'Data to be displayed. \n\n \
Must be an object with one of the following properties: `url` or `values` \n\n \
`url`: URL pointing to a CSV file. \n\n \
`values`: array of objects \n\n',
},
title: {
description: 'Title to display on the chart. Optional.',
description: 'Title to display on the chart.',
},
xAxis: {
description:
'Name of the X axis on the data. Required when the "data" parameter is an URL.',
'Name of the column header or object property that represents the X-axis on the data.',
},
xAxisType: {
description: 'Type of the X axis',
description: 'Type of the X-axis.',
},
xAxisTimeUnit: {
description: 'Time unit of the X axis (optional)',
description: 'Time unit of the X-axis, in case its type is `temporal.`',
},
yAxis: {
description:
'Name of the Y axis on the data. Required when the "data" parameter is an URL.',
'Name of the column header or object property that represents the Y-axis on the data.',
},
yAxisType: {
description: 'Type of the Y axis',
description: 'Type of the Y-axis',
},
fullWidth: {
description:
@@ -47,21 +50,27 @@ type Story = StoryObj<LineChartProps>;
export const FromDataPoints: Story = {
name: 'Line chart from array of data points',
args: {
data: [
['1850', -0.41765878],
['1851', -0.2333498],
['1852', -0.22939907],
['1853', -0.27035445],
['1854', -0.29163003],
],
data: {
values: [
{ year: '1850', value: -0.41765878 },
{ year: '1851', value: -0.2333498 },
{ year: '1852', value: -0.22939907 },
{ year: '1853', value: -0.27035445 },
{ year: '1854', value: -0.29163003 },
],
},
xAxis: 'year',
yAxis: 'value',
},
};
export const FromURL: Story = {
name: 'Line chart from URL',
args: {
data: {
url: 'https://raw.githubusercontent.com/datasets/oil-prices/main/data/wti-year.csv',
},
title: 'Oil Price x Year',
data: 'https://raw.githubusercontent.com/datasets/oil-prices/main/data/wti-year.csv',
xAxis: 'Date',
yAxis: 'Price',
},