reflex 0.5.4a2__py3-none-any.whl → 0.5.5__py3-none-any.whl

reflex/components/recharts/cartesian.py

@@ -1,10 +1,12 @@
 """Cartesian charts in Recharts."""
+
 from __future__ import annotations
 
 from typing import Any, Dict, List, Union
 
 from reflex.constants import EventTriggers
 from reflex.constants.colors import Color
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 from .recharts import (
@@ -14,7 +16,9 @@ from .recharts import (
     LiteralIfOverflow,
     LiteralInterval,
     LiteralLayout,
+    LiteralLegendType,
     LiteralLineType,
+    LiteralOrientationLeftRight,
     LiteralOrientationTopBottom,
     LiteralOrientationTopBottomLeftRight,
     LiteralPolarRadiusType,
@@ -72,22 +76,44 @@ class Axis(Recharts):
     # The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
     name: Var[Union[str, int]]
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers that pass the component's value to the handler.
+    # Set the values of axis ticks manually.
+    ticks: Var[List[Union[str, int]]]
 
-        Returns:
-            A dict mapping the event trigger to the var that is passed to the handler.
-        """
-        return {
-            EventTriggers.ON_CLICK: lambda: [],
-            EventTriggers.ON_MOUSE_UP: lambda: [],
-            EventTriggers.ON_MOUSE_DOWN: lambda: [],
-            EventTriggers.ON_MOUSE_MOVE: lambda: [],
-            EventTriggers.ON_MOUSE_OVER: lambda: [],
-            EventTriggers.ON_MOUSE_OUT: lambda: [],
-            EventTriggers.ON_MOUSE_ENTER: lambda: [],
-            EventTriggers.ON_MOUSE_LEAVE: lambda: [],
-        }
+    # If set false, no ticks will be drawn.
+    tick: Var[bool]
+
+    # The count of axis ticks.
+    tick_count: Var[int]
+
+    # If set false, no axis tick lines will be drawn.
+    tick_line: Var[bool]
+
+    # The length of tick line.
+    tick_size: Var[int]
+
+    # The minimum gap between two adjacent labels
+    min_tick_gap: Var[int]
+
+    # The customized event handler of click on the ticks of this axis
+    on_click: EventHandler[lambda: []]
+
+    # The customized event handler of mousedown on the ticks of this axis
+    on_mouse_down: EventHandler[lambda: []]
+
+    # The customized event handler of mouseup on the ticks of this axis
+    on_mouse_up: EventHandler[lambda: []]
+
+    # The customized event handler of mousemove on the ticks of this axis
+    on_mouse_move: EventHandler[lambda: []]
+
+    # The customized event handler of mouseout on the ticks of this axis
+    on_mouse_out: EventHandler[lambda: []]
+
+    # The customized event handler of mouseenter on the ticks of this axis
+    on_mouse_enter: EventHandler[lambda: []]
+
+    # The customized event handler of mouseleave on the ticks of this axis
+    on_mouse_leave: EventHandler[lambda: []]
 
 
 class XAxis(Axis):
@@ -97,6 +123,9 @@ class XAxis(Axis):
 
     alias = "RechartsXAxis"
 
+    # The id of x-axis which is corresponding to the data.
+    x_axis_id: Var[Union[str, int]]
+
     # Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden
     include_hidden: Var[bool] = Var.create_safe(False)
 
@@ -108,9 +137,15 @@ class YAxis(Axis):
 
     alias = "RechartsYAxis"
 
+    # The orientation of axis 'left' | 'right'
+    orientation: Var[LiteralOrientationLeftRight]
+
     # The key of data displayed in the axis.
     data_key: Var[Union[str, int]]
 
+    # The id of y-axis which is corresponding to the data.
+    y_axis_id: Var[Union[str, int]]
+
 
 class ZAxis(Recharts):
     """A ZAxis component in Recharts."""
@@ -202,24 +237,31 @@ class Cartesian(Recharts):
     y_axis_id: Var[Union[str, int]]
 
     # 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
-    # legend_type: Var[LiteralLegendType]
+    legend_type: Var[LiteralLegendType]
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers that pass the component's value to the handler.
+    # The customized event handler of click on the component in this group
+    on_click: EventHandler[lambda: []]
 
-        Returns:
-            A dict mapping the event trigger to the var that is passed to the handler.
-        """
-        return {
-            EventTriggers.ON_CLICK: lambda: [],
-            EventTriggers.ON_MOUSE_MOVE: lambda: [],
-            EventTriggers.ON_MOUSE_UP: lambda: [],
-            EventTriggers.ON_MOUSE_DOWN: lambda: [],
-            EventTriggers.ON_MOUSE_OVER: lambda: [],
-            EventTriggers.ON_MOUSE_OUT: lambda: [],
-            EventTriggers.ON_MOUSE_ENTER: lambda: [],
-            EventTriggers.ON_MOUSE_LEAVE: lambda: [],
-        }
+    # The customized event handler of mousedown on the component in this group
+    on_mouse_down: EventHandler[lambda: []]
+
+    # The customized event handler of mouseup on the component in this group
+    on_mouse_up: EventHandler[lambda: []]
+
+    # The customized event handler of mousemove on the component in this group
+    on_mouse_move: EventHandler[lambda: []]
+
+    # The customized event handler of mouseover on the component in this group
+    on_mouse_over: EventHandler[lambda: []]
+
+    # The customized event handler of mouseout on the component in this group
+    on_mouse_out: EventHandler[lambda: []]
+
+    # The customized event handler of mouseenter on the component in this group
+    on_mouse_enter: EventHandler[lambda: []]
+
+    # The customized event handler of mouseleave on the component in this group
+    on_mouse_leave: EventHandler[lambda: []]
 
 
 class Area(Cartesian):
@@ -250,8 +292,14 @@ class Area(Cartesian):
     # If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally.
     label: Var[bool]
 
-    # The stack id of area, when two areas have the same value axis and same stackId, then the two areas area stacked in order.
-    stack_id: Var[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.
+    stack_id: Var[Union[str, int]]
+
+    # The unit of data. This option will be used in tooltip.
+    unit: Var[Union[str, int]]
+
+    # The name of data. This option will be used in tooltip and legend to represent a bar. If no value was set to this option, the value of dataKey will be used alternatively.
+    name: Var[Union[str, int]]
 
     # Valid children components
     _valid_children: List[str] = ["LabelList"]
@@ -279,10 +327,19 @@ class Bar(Cartesian):
     # If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally.
     label: Var[bool]
 
-    # The stack id of bar, when two areas have the same value axis and same stackId, then the two areas area stacked in order.
+    # The stack id of bar, when two bars have the same value axis and same stack_id, then the two bars are stacked in order.
     stack_id: Var[str]
 
-    # Size of the bar
+    # The unit of data. This option will be used in tooltip.
+    unit: Var[Union[str, int]]
+
+    # The minimal height of a bar in a horizontal BarChart, or the minimal width of a bar in a vertical BarChart. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point size to a pixel value like 3. In stacked bar charts, minPointSize might not be respected for tightly packed values. So we strongly recommend not using this prop in stacked BarCharts.
+    min_point_size: Var[int]
+
+    # The name of data. This option will be used in tooltip and legend to represent a bar. If no value was set to this option, the value of dataKey will be used alternatively.
+    name: Var[Union[str, int]]
+
+    # Size of the bar (if one bar_size is set then a bar_size must be set for all bars)
     bar_size: Var[int]
 
     # Max size of the bar
@@ -291,6 +348,24 @@ class Bar(Cartesian):
     # Valid children components
     _valid_children: List[str] = ["Cell", "LabelList", "ErrorBar"]
 
+    # If set false, animation of bar will be disabled.
+    is_animation_active: Var[bool]
+
+    # Specifies when the animation should begin, the unit of this option is ms, default 0.
+    animation_begin: Var[int]
+
+    # Specifies the duration of animation, the unit of this option is ms, default 1500.
+    animation_duration: Var[int]
+
+    # The type of easing function, default 'ease'
+    animation_easing: Var[LiteralAnimationEasing]
+
+    # The customized event handler of animation start
+    on_animation_begin: EventHandler[lambda: []]
+
+    # The customized event handler of animation end
+    on_animation_end: EventHandler[lambda: []]
+
 
 class Line(Cartesian):
     """A Line component in Recharts."""
@@ -323,11 +398,17 @@ class Line(Cartesian):
     # Whether to connect a graph line across null points.
     connect_nulls: Var[bool]
 
+    # The unit of data. This option will be used in tooltip.
+    unit: Var[Union[str, int]]
+
+    # The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
+    name: Var[Union[str, int]]
+
     # Valid children components
     _valid_children: List[str] = ["LabelList", "ErrorBar"]
 
 
-class Scatter(Cartesian):
+class Scatter(Recharts):
     """A Scatter component in Recharts."""
 
     tag = "Scatter"
@@ -337,6 +418,15 @@ class Scatter(Cartesian):
     # The source data, in which each element is an object.
     data: Var[List[Dict[str, Any]]]
 
+    # The type of icon in legend. If set to 'none', no legend item will be rendered. 'line' | 'plainline' | 'square' | 'rect'| 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' | 'none'
+    legend_type: Var[LiteralLegendType]
+
+    # The id of x-axis which is corresponding to the data.
+    x_axis_id: Var[Union[str, int]]
+
+    # The id of y-axis which is corresponding to the data.
+    y_axis_id: Var[Union[str, int]]
+
     # The id of z-axis which is corresponding to the data.
     z_axis_id: Var[str]
 
@@ -358,8 +448,44 @@ class Scatter(Cartesian):
     # Valid children components.
     _valid_children: List[str] = ["LabelList", "ErrorBar"]
 
+    # If set false, animation of bar will be disabled.
+    is_animation_active: Var[bool]
+
+    # Specifies when the animation should begin, the unit of this option is ms, default 0.
+    animation_begin: Var[int]
+
+    # Specifies the duration of animation, the unit of this option is ms, default 1500.
+    animation_duration: Var[int]
+
+    # The type of easing function, default 'ease'
+    animation_easing: Var[LiteralAnimationEasing]
+
+    # The customized event handler of click on the component in this group
+    on_click: EventHandler[lambda: []]
+
+    # The customized event handler of mousedown on the component in this group
+    on_mouse_down: EventHandler[lambda: []]
+
+    # The customized event handler of mouseup on the component in this group
+    on_mouse_up: EventHandler[lambda: []]
+
+    # The customized event handler of mousemove on the component in this group
+    on_mouse_move: EventHandler[lambda: []]
+
+    # The customized event handler of mouseover on the component in this group
+    on_mouse_over: EventHandler[lambda: []]
 
-class Funnel(Cartesian):
+    # The customized event handler of mouseout on the component in this group
+    on_mouse_out: EventHandler[lambda: []]
+
+    # The customized event handler of mouseenter on the component in this group
+    on_mouse_enter: EventHandler[lambda: []]
+
+    # The customized event handler of mouseleave on the component in this group
+    on_mouse_leave: EventHandler[lambda: []]
+
+
+class Funnel(Recharts):
     """A Funnel component in Recharts."""
 
     tag = "Funnel"
@@ -369,6 +495,18 @@ class Funnel(Cartesian):
     # The source data, in which each element is an object.
     data: Var[List[Dict[str, Any]]]
 
+    # The key of a group of data which should be unique in an area chart.
+    data_key: Var[Union[str, int]]
+
+    # The key or getter of a group of data which should be unique in a LineChart.
+    name_key: Var[str]
+
+    # The type of icon in legend. If set to 'none', no legend item will be rendered.
+    legend_type: Var[LiteralLegendType]
+
+    # If set false, animation of line will be disabled.
+    is_animation_active: Var[bool]
+
     # Specifies when the animation should begin, the unit of this option is ms.
     animation_begin: Var[int]
 
@@ -381,22 +519,35 @@ class Funnel(Cartesian):
     # Valid children components
     _valid_children: List[str] = ["LabelList", "Cell"]
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers that pass the component's value to the handler.
+    # The customized event handler of animation start
+    on_animation_start: EventHandler[lambda: []]
 
-        Returns:
-            A dict mapping the event trigger to the var that is passed to the handler.
-        """
-        return {
-            EventTriggers.ON_CLICK: lambda: [],
-            EventTriggers.ON_MOUSE_MOVE: lambda: [],
-            EventTriggers.ON_MOUSE_UP: lambda: [],
-            EventTriggers.ON_MOUSE_DOWN: lambda: [],
-            EventTriggers.ON_MOUSE_OVER: lambda: [],
-            EventTriggers.ON_MOUSE_OUT: lambda: [],
-            EventTriggers.ON_MOUSE_ENTER: lambda: [],
-            EventTriggers.ON_MOUSE_LEAVE: lambda: [],
-        }
+    # The customized event handler of animation end
+    on_animation_end: EventHandler[lambda: []]
+
+    # The customized event handler of click on the component in this group
+    on_click: EventHandler[lambda: []]
+
+    # The customized event handler of mousedown on the component in this group
+    on_mouse_down: EventHandler[lambda: []]
+
+    # The customized event handler of mouseup on the component in this group
+    on_mouse_up: EventHandler[lambda: []]
+
+    # The customized event handler of mousemove on the component in this group
+    on_mouse_move: EventHandler[lambda: []]
+
+    # The customized event handler of mouseover on the component in this group
+    on_mouse_over: EventHandler[lambda: []]
+
+    # The customized event handler of mouseout on the component in this group
+    on_mouse_out: EventHandler[lambda: []]
+
+    # The customized event handler of mouseenter on the component in this group
+    on_mouse_enter: EventHandler[lambda: []]
+
+    # The customized event handler of mouseleave on the component in this group
+    on_mouse_leave: EventHandler[lambda: []]
 
 
 class ErrorBar(Recharts):
@@ -431,15 +582,12 @@ class Reference(Recharts):
     # The id of y-axis which is corresponding to the data.
     y_axis_id: Var[Union[str, int]]
 
-    # If set a string or a number, a vertical line perpendicular to the x-axis specified by xAxisId will be drawn. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys, otherwise no line will be drawn.
-    x: Var[str]
-
-    # If set a string or a number, a horizontal line perpendicular to the y-axis specified by yAxisId will be drawn. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys, otherwise no line will be drawn.
-    y: Var[str]
-
     # Defines how to draw the reference line if it falls partly outside the canvas. If set to 'discard', the reference line will not be drawn at all. If set to 'hidden', the reference line will be clipped to the canvas. If set to 'visible', the reference line will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference line fits into the canvas.
     if_overflow: Var[LiteralIfOverflow]
 
+    # If set a string or a number, default label will be drawn, and the option is content.
+    label: Var[Union[str, int]]
+
     # If set true, the line will be rendered in front of bars in BarChart, etc.
     is_front: Var[bool]
 
@@ -451,12 +599,24 @@ class ReferenceLine(Reference):
 
     alias = "RechartsReferenceLine"
 
+    # If set a string or a number, a vertical line perpendicular to the x-axis specified by xAxisId will be drawn. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys, otherwise no line will be drawn.
+    x: Var[Union[str, int]]
+
+    # If set a string or a number, a horizontal line perpendicular to the y-axis specified by yAxisId will be drawn. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys, otherwise no line will be drawn.
+    y: Var[Union[str, int]]
+
+    # The color of the reference line.
+    stroke: Var[Union[str, Color]]
+
     # The width of the stroke.
-    stroke_width: Var[int]
+    stroke_width: Var[Union[str, int]]
 
     # Valid children components
     _valid_children: List[str] = ["Label"]
 
+    # Array of endpoints in { x, y } format. These endpoints would be used to draw the ReferenceLine.
+    segment: List[Any] = []
+
 
 class ReferenceDot(Reference):
     """A ReferenceDot component in Recharts."""
@@ -465,23 +625,47 @@ class ReferenceDot(Reference):
 
     alias = "RechartsReferenceDot"
 
+    # If set a string or a number, a vertical line perpendicular to the x-axis specified by xAxisId will be drawn. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys, otherwise no line will be drawn.
+    x: Var[Union[str, int]]
+
+    # If set a string or a number, a horizontal line perpendicular to the y-axis specified by yAxisId will be drawn. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys, otherwise no line will be drawn.
+    y: Var[Union[str, int]]
+
+    # The radius of dot.
+    r: Var[int]
+
+    # The color of the area fill.
+    fill: Var[Union[str, Color]]
+
+    # The color of the line stroke.
+    stroke: Var[Union[str, Color]]
+
     # Valid children components
     _valid_children: List[str] = ["Label"]
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers that pass the component's value to the handler.
+    # The customized event handler of click on the component in this chart
+    on_click: EventHandler[lambda: []]
 
-        Returns:
-            A dict mapping the event trigger to the var that is passed to the handler.
-        """
-        return {
-            EventTriggers.ON_CLICK: lambda: [],
-            EventTriggers.ON_MOUSE_MOVE: lambda: [],
-            EventTriggers.ON_MOUSE_OVER: lambda: [],
-            EventTriggers.ON_MOUSE_OUT: lambda: [],
-            EventTriggers.ON_MOUSE_ENTER: lambda: [],
-            EventTriggers.ON_MOUSE_LEAVE: lambda: [],
-        }
+    # The customized event handler of mousedown on the component in this chart
+    on_mouse_down: EventHandler[lambda: []]
+
+    # The customized event handler of mouseup on the component in this chart
+    on_mouse_up: EventHandler[lambda: []]
+
+    # The customized event handler of mouseover on the component in this chart
+    on_mouse_over: EventHandler[lambda: []]
+
+    # The customized event handler of mouseout on the component in this chart
+    on_mouse_out: EventHandler[lambda: []]
+
+    # The customized event handler of mouseenter on the component in this chart
+    on_mouse_enter: EventHandler[lambda: []]
+
+    # The customized event handler of mousemove on the component in this chart
+    on_mouse_move: EventHandler[lambda: []]
+
+    # The customized event handler of mouseleave on the component in this chart
+    on_mouse_leave: EventHandler[lambda: []]
 
 
 class ReferenceArea(Recharts):
@@ -552,10 +736,16 @@ class CartesianGrid(Grid):
     alias = "RechartsCartesianGrid"
 
     # The horizontal line configuration.
-    horizontal: Var[Dict[str, Any]]
+    horizontal: Var[bool]
 
     # The vertical line configuration.
-    vertical: Var[Dict[str, Any]]
+    vertical: Var[bool]
+
+    # The x-coordinates in pixel values of all vertical lines.
+    vertical_points: Var[List[Union[str, int]]]
+
+    # The x-coordinates in pixel values of all vertical lines.
+    horizontal_points: Var[List[Union[str, int]]]
 
     # The background of grid.
     fill: Var[Union[str, Color]]