For AI agents: the complete documentation index is at llms.txt. Markdown versions are available by appending .md or sending Accept: text/markdown.
Reflex Logo
Docs Logo
Library

/

Graphing

/

Charts

/

Areachart

Area Chart

A Recharts area chart displays quantitative data using filled areas between a line connecting data points and the axis.

Basic Example

Syncing Charts

The sync_id prop allows you to sync two graphs. In the example, it is set to "1" for both charts, indicating that they should be synchronized. This means that any interactions (such as brushing) performed on one chart will be reflected in the other chart.

Expand

Stacking Charts

The stack_id prop allows you to stack multiple graphs on top of each other. In the example, it is set to "1" for both charts, indicating that they should be stacked together. This means that the bars or areas of the charts will be vertically stacked, with the values of each chart contributing to the total height of the stacked areas or bars.

This is similar to the sync_id prop, but instead of synchronizing the interaction between the charts, it just stacks the charts on top of each other.

Expand

Multiple Axis

Multiple axes can be used for displaying different data series with varying scales or units on the same chart. This allows for a more comprehensive comparison and analysis of the data.

Expand

Layout

Use the layout prop to set the orientation to either "horizontal" (default) or "vertical".

Include margins around your graph to ensure proper spacing and enhance readability. By default, provide margins on all sides of the chart to create a visually appealing and functional representation of your data.

Stateful Example

Here is an example of an area graph with a State. Here we have defined a function randomize_data, which randomly changes the data for both graphs when the first defined area is clicked on using on_click=AreaState.randomize_data.

Curve Type:

Expand

API Reference

rx.recharts.AreaChart

An Area chart component in Recharts.

Props

PropTypeDescription
width
Union[int, str]

The width of chart container. String or Integer.

height
Union[int, str]

The height of chart container.

data
Sequence

The source data, in which each element is an object.

margin
Dict[str, Any]

The sizes of whitespace around the chart, i.e. {"top": 50, "right": 30, "left": 20, "bottom": 5}.

sync_id
str

If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.

sync_method
"index""value"

When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function.

layout
"vertical""horizontal"

The layout of area in the chart. 'horizontal' | 'vertical'.

stack_offset
"expand""none""wiggle""silhouette"

The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'.

base_value
"dataMin""dataMax""auto"

The base value of area. Number | 'dataMin' | 'dataMax' | 'auto'.

Valid Children

XAxisYAxisReferenceAreaReferenceDotReferenceLineBrushCartesianGridLegendGraphingTooltipAreaDefs

rx.recharts.Area

An Area component in Recharts.

Props

PropTypeDescription
layout
"vertical""horizontal"

The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'.

data_key
Union[int, str]

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

x_axis_id
Union[int, str]

The id of x-axis which is corresponding to the data.

y_axis_id
Union[int, str]

The id of y-axis which is corresponding to the data.

legend_type
"circle""cross""diamond""line""plainline""rect""square""star""triangle""wye""none"

The type of icon in legend. If set to 'none', no legend item will be rendered. 'line' | 'plainline' | 'square' | 'rect'| 'circle' | 'cross' | 'diamond' | 'star' | 'triangle' | 'wye' | 'none' optional.

label
Union[dict, bool]

If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally.

is_animation_active
bool

If set false, animation of bar will be disabled.

animation_begin
int

Specifies when the animation should begin, the unit of this option is ms.

animation_duration
int

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

animation_easing
"ease""ease-in""ease-out""ease-in-out""linear"

The type of easing function.

unit
Union[int, str]

The unit of data. This option will be used in tooltip.

name
Union[int, str]

The name of data. This option will be used in tooltip and legend to represent the component. If no value was set to this option, the value of dataKey will be used alternatively.

stroke
Union[str, Color]

The color of the line stroke.

stroke_width
Union[str, int, float]

The width of the line stroke.

fill
Union[str, Color]

The color of the area fill.

type_
"basis""basisClosed""basisOpen""bumpX""bumpY""bump""linear""linearClosed""natural""monotoneX""monotoneY""monotone""step""stepBefore""stepAfter"

The interpolation type of area. And customized interpolation function can be set to type. 'basis' | 'basisClosed' | 'basisOpen' | 'bumpX' | 'bumpY' | 'bump' | 'linear' | 'linearClosed' | 'natural' | 'monotoneX' | 'monotoneY' | 'monotone' | 'step' | 'stepBefore' | 'stepAfter'.

dot
Union[dict, bool]

If false set, dots will not be drawn. If true set, dots will be drawn which have the props calculated internally.

active_dot
Union[dict, bool]

The dot is shown when user enter an area chart and this chart has tooltip. If false set, no active dot will not be drawn. If true set, active dot will be drawn which have the props calculated internally.

base_line
Union[int, Sequence]

The value which can describle the line, usually calculated internally.

points
Sequence

The coordinates of all the points in the area, usually calculated internally.

stack_id
Union[int, str]

The stack id of area, when two areas have the same value axis and same stack_id, then the two areas are stacked in order.

connect_nulls
bool

Whether to connect a graph area across null points.

Valid Children

LabelList

Event Triggers

See the full list of default event triggers
TriggerDescription
on_animation_startThe customized event handler of animation start.
on_animation_endThe customized event handler of animation end.
Built with Reflex