data
RequiredDescription
Chart data.
Type
Dict<any>[]
Leave Yamada UI a star
StarBarChart
is a component for drawing bar charts to compare multiple sets of data.
Description
Chart data.
Type
Dict<any>[]
Description
The key of a group of data which should be unique in an chart.
Type
string
Description
An array of objects with name
and color
keys. Determines which data should be consumed from the data
array.
Type
BarProps[]
Description
Props for the bars.
Type
Partial<BarProps>
Description
A function that returns a component that renders the bar cells.
Type
string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | FC<...>
Description
Props passed down to recharts BarChart
component.
Type
BarChartProps
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"
Description
Props passed down to recharts ResponsiveContainer
component.
Type
ResponsiveContainerProps
Description
Specifies which lines should be displayed in the grid.
Type
ChartAxisType
Default
'x'
Description
Props passed down to recharts 'CartesianGrid' component.
Type
GridProps
Description
A function to format labels on inside the tooltip.
Type
(label: string) => string
Description
Chart orientation.
Type
ChartLayoutType
Default
'horizontal'
Description
Props passed down to recharts 'Legend' component.
Type
LegendProps
Description
Reference lines that should be displayed on the chart.
Type
ReferenceLineProps[]
Description
The size of the BarChart.
Type
"sm" | "md" | "lg" | "full"
Default
"full"
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
Description
The option is the configuration of tick lines.
Type
ChartAxisType
Default
'y'
Description
Specifies the duration of animation, the unit of this option is ms.
Type
number
Default
0
Description
Props passed down to recharts 'Tooltip' component.
Type
TooltipProps
Description
Controls how chart bars are positioned relative to each other. Controls how chart areas are positioned relative to each other
Type
"default" | "percent" | "stacked"
Default
`default`
Description
Unit displayed next to each tick in y-axis.
Type
string
Description
A function to format values on inside the tooltip.
Type
(value: any) => string
Description
The variant of the BarChart.
Type
string
Description
If true
, legend is visible.
Type
boolean
Default
false
Description
If true
, tooltip is visible.
Type
boolean
Default
true
Description
If true
, X axis is visible.
Type
boolean
Default
true
Description
If true
, Y axis is visible.
Type
boolean
Default
true
Description
A label to display below the X axis.
Type
string
Description
Props passed down to recharts 'XAxisLabel' component.
Type
LabelProps
Description
Props passed down to recharts 'XAxis' component.
Type
XAxisProps
Description
A function to format X axis tick.
Type
(value: any) => string
Description
A label to display below the Y axis.
Type
string
Description
Props passed down to recharts 'YAxisLabel' component.
Type
LabelProps
Description
Props passed down to recharts 'YAxis' component.
Type
YAxisProps
Description
A function to format Y axis tick.
Type
(value: any) => string
Type
Merge<SVGProps<SVGPathElement>, CSSUIProps>
Type
Merge<SVGProps<SVGPathElement>, CSSUIProps>
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">
Type
Partial<BarProps>
Edit this page on GitHub