Leave Yamada UI a star

Star
Yamada UIYamada UIv1.6.4

LineChart

LineChart is a component for drawing line charts to compare multiple sets of data.

Source@yamada-ui/charts

Props

LineChartProps

data

Required

Description

Chart data.

Type

Dict<any>[]

dataKey

Required

Description

The key of a group of data which should be unique in an chart.

Type

string

series

Required

Description

An array of objects with dataKey and color keys. Determines which data should be consumed from the data array.

Type

LineProps[]

chartProps

Description

Props passed down to recharts LineChart component.

Type

LineChartProps

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

connectNulls

Description

Determines whether points with null values should be connected.

Type

boolean

Default

true

containerProps

Description

Props passed down to recharts ResponsiveContainer component.

Type

ResponsiveContainerProps

curveType

Description

Type of the curve.

Type

ChartCurveType

Default

`monotone`

fillOpacity

Description

Controls fill opacity of all lines.

Type

number | [number, number]

Default

1

gridAxis

Description

Specifies which lines should be displayed in the grid.

Type

ChartAxisType

Default

'x'

gridProps

Description

Props passed down to recharts 'CartesianGrid' component.

Type

GridProps

labelFormatter

Description

A function to format labels on inside the tooltip.

Type

(label: string) => string

layoutType

Description

Chart orientation.

Type

ChartLayoutType

Default

'horizontal'

legendProps

Description

Props passed down to recharts 'Legend' component.

Type

LegendProps

lineProps

Description

Props for the lines.

Type

Partial<LineProps>

referenceLineProps

Description

Reference lines that should be displayed on the chart.

Type

ReferenceLineProps[]

size

Description

The size of the LineChart.

Type

"sm" | "md" | "lg" | "full"

Default

"full"

strokeDasharray

Description

Dash array for the grid lines and cursor. The first number is the length of the solid line section and the second number is the length of the interval.

Type

string | number

Default

'5 5'

strokeWidth

Description

Stroke width for the chart lines.

Type

number

Default

2

syncId

Description

If any two categorical charts have the same syncId, these two charts can sync the position tooltip, and the startIndex, endIndex of Brush.

Type

string | number

tickLine

Description

The option is the configuration of tick lines.

Type

ChartAxisType

Default

'y'

tooltipAnimationDuration

Description

Specifies the duration of animation, the unit of this option is ms.

Type

number

Default

0

tooltipProps

Description

Props passed down to recharts 'Tooltip' component.

Type

TooltipProps

type

Description

Controls how chart areas are positioned relative to each other

Type

AreaChartType

Default

`default`

unit

Description

Unit displayed next to each tick in y-axis.

Type

string

valueFormatter

Description

A function to format values on inside the tooltip.

Type

(value: any) => string

variant

Description

The variant of the LineChart.

Type

string

withActiveDots

Description

Determines whether activeDots should be displayed.

Type

boolean

Default

true

withDots

Description

Determines whether dots should be displayed.

Type

boolean

Default

true

withLegend

Description

If true, legend is visible.

Type

boolean

Default

false

withTooltip

Description

If true, tooltip is visible.

Type

boolean

Default

true

withXAxis

Description

If true, X axis is visible.

Type

boolean

Default

true

withYAxis

Description

If true, Y axis is visible.

Type

boolean

Default

true

xAxisLabel

Description

A label to display below the X axis.

Type

string

xAxisLabelProps

Description

Props passed down to recharts 'XAxisLabel' component.

Type

LabelProps

xAxisProps

Description

Props passed down to recharts 'XAxis' component.

Type

XAxisProps

xAxisTickFormatter

Description

A function to format X axis tick.

Type

(value: any) => string

yAxisLabel

Description

A label to display below the Y axis.

Type

string

yAxisLabelProps

Description

Props passed down to recharts 'YAxisLabel' component.

Type

LabelProps

yAxisProps

Description

Props passed down to recharts 'YAxis' component.

Type

YAxisProps

yAxisTickFormatter

Description

A function to format Y axis tick.

Type

(value: any) => string

LineProps

activeDot

Type

DotProps

color

Type

UIValue<"border" | ({} & string) | Color | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

dimDot

Type

DotProps

dimLine

Type

Partial<LineProps>

dot

Type

DotProps

DotProps

Edit this page on GitHub

PreviousCalendarNextAreaChart