浏览代码

default props comment for Funnel (#4119)

* default props comment for Funnel

* update
Carlos 7 月之前
父节点
当前提交
132a3d4d1d
共有 2 个文件被更改,包括 23 次插入16 次删除
  1. 11 8
      reflex/components/recharts/cartesian.py
  2. 12 8
      reflex/components/recharts/cartesian.pyi

+ 11 - 8
reflex/components/recharts/cartesian.py

@@ -528,30 +528,33 @@ class Funnel(Recharts):
     # 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.
+    # The key or getter of a group of data which should be unique in a FunnelChart.
     data_key: Var[Union[str, int]]
 
-    # The key or getter of a group of data which should be unique in a LineChart.
+    # The key of each sector's name. Default: "name"
     name_key: Var[str]
 
-    # The type of icon in legend. If set to 'none', no legend item will be rendered.
+    # The type of icon in legend. If set to 'none', no legend item will be rendered. Default: "line"
     legend_type: Var[LiteralLegendType]
 
-    # If set false, animation of line will be disabled.
+    # If set false, animation of line will be disabled. Default: True
     is_animation_active: Var[bool]
 
-    # Specifies when the animation should begin, the unit of this option is ms.
+    # 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.
+    # Specifies the duration of animation, the unit of this option is ms. Default: 1500
     animation_duration: Var[int]
 
-    # The type of easing function. 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear'
+    # The type of easing function. 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear'. Default "ease"
     animation_easing: Var[LiteralAnimationEasing]
 
-    # stroke color
+    # Stroke color. Default: rx.color("gray", 3)
     stroke: Var[Union[str, Color]] = LiteralVar.create(Color("gray", 3))
 
+    # The coordinates of all the trapezoids in the funnel, usually calculated internally.
+    trapezoids: Var[List[Dict[str, Any]]]
+
     # Valid children components
     _valid_children: List[str] = ["LabelList", "Cell"]
 

+ 12 - 8
reflex/components/recharts/cartesian.pyi

@@ -1481,6 +1481,9 @@ class Funnel(Recharts):
             ]
         ] = None,
         stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
+        trapezoids: Optional[
+            Union[List[Dict[str, Any]], Var[List[Dict[str, Any]]]]
+        ] = None,
         style: Optional[Style] = None,
         key: Optional[Any] = None,
         id: Optional[Any] = None,
@@ -1535,14 +1538,15 @@ class Funnel(Recharts):
         Args:
             *children: The children of the component.
             data: The source data, in which each element is an object.
-            data_key: The key of a group of data which should be unique in an area chart.
-            name_key: The key or getter of a group of data which should be unique in a LineChart.
-            legend_type: The type of icon in legend. If set to 'none', no legend item will be rendered.
-            is_animation_active: If set false, animation of line will be disabled.
-            animation_begin: Specifies when the animation should begin, the unit of this option is ms.
-            animation_duration: Specifies the duration of animation, the unit of this option is ms.
-            animation_easing: The type of easing function. 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear'
-            stroke: stroke color
+            data_key: The key or getter of a group of data which should be unique in a FunnelChart.
+            name_key: The key of each sector's name. Default: "name"
+            legend_type: The type of icon in legend. If set to 'none', no legend item will be rendered. Default: "line"
+            is_animation_active: If set false, animation of line will be disabled. Default: True
+            animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
+            animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
+            animation_easing: The type of easing function. 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear'. Default "ease"
+            stroke: Stroke color. Default: rx.color("gray", 3)
+            trapezoids: The coordinates of all the trapezoids in the funnel, usually calculated internally.
             style: The style of the component.
             key: A unique key for the component.
             id: The id for the component.