laipeng/reflex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

default props comment for Scatter (#4118)

Browse Source
This commit is contained in:
Carlos 2024-10-09 00:54:42 +02:00 committed by GitHub
parent 567cf7ea38
commit be980c6b1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 26 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
reflex/components/recharts/cartesian.py
View File

@ -459,46 +459,43 @@ class Scatter(Recharts):
# The source data, in which each element is an object. # The source data, in which each element is an object.
data: Var[List[Dict[str, Any]]] 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' # 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'. Default: "circle"
legend_type: Var[LiteralLegendType] legend_type: Var[LiteralLegendType]
# The id of x-axis which is corresponding to the data. # The id of x-axis which is corresponding to the data. Default: 0
x_axis_id: Var[Union[str, int]] x_axis_id: Var[Union[str, int]]
# The id of y-axis which is corresponding to the data. # The id of y-axis which is corresponding to the data. Default: 0
y_axis_id: Var[Union[str, int]] y_axis_id: Var[Union[str, int]]
# The id of z-axis which is corresponding to the data. # The id of z-axis which is corresponding to the data. Default: 0
z_axis_id: Var[str] z_axis_id: Var[Union[str, int]]
# If false set, line will not be drawn. If true set, line will be drawn which have the props calculated internally. # If false set, line will not be drawn. If true set, line will be drawn which have the props calculated internally. Default: False
line: Var[bool] line: Var[bool]
# If a string set, specified symbol will be used to show scatter item. 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' # If a string set, specified symbol will be used to show scatter item. 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye'. Default: "circle"
shape: Var[LiteralShape] shape: Var[LiteralShape]
# If 'joint' set, line will generated by just jointing all the points. If 'fitting' set, line will be generated by fitting algorithm. 'joint' | 'fitting' # If 'joint' set, line will generated by just jointing all the points. If 'fitting' set, line will be generated by fitting algorithm. 'joint' | 'fitting'. Default: "joint"
line_type: Var[LiteralLineType] line_type: Var[LiteralLineType]
# The fill # The fill color of the scatter. Default: rx.color("accent", 9)
fill: Var[Union[str, Color]] = LiteralVar.create(Color("accent", 9)) fill: Var[Union[str, Color]] = LiteralVar.create(Color("accent", 9))
# the name
name: Var[Union[str, int]]
# Valid children components. # Valid children components.
_valid_children: List[str] = ["LabelList", "ErrorBar"] _valid_children: List[str] = ["LabelList", "ErrorBar"]
# If set false, animation of bar will be disabled. # If set false, animation of bar will be disabled. Default: True in CSR, False in SSR
is_animation_active: Var[bool] is_animation_active: Var[bool]
# Specifies when the animation should begin, the unit of this option is ms, default 0. # Specifies when the animation should begin, the unit of this option is ms. Default: 0
animation_begin: Var[int] animation_begin: Var[int]
# Specifies the duration of animation, the unit of this option is ms, default 1500. # Specifies the duration of animation, the unit of this option is ms. Default: 1500
animation_duration: Var[int] animation_duration: Var[int]
# The type of easing function, default 'ease' # The type of easing function. Default: "ease"
animation_easing: Var[LiteralAnimationEasing] animation_easing: Var[LiteralAnimationEasing]
# The customized event handler of click on the component in this group # The customized event handler of click on the component in this group

28
reflex/components/recharts/cartesian.pyi
View File

@ -1331,7 +1331,7 @@ class Scatter(Recharts):
] = None, ] = None,
x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None, x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None, y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
z_axis_id: Optional[Union[Var[str], str]] = None, z_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
line: Optional[Union[Var[bool], bool]] = None, line: Optional[Union[Var[bool], bool]] = None,
shape: Optional[ shape: Optional[
Union[ Union[
@ -1355,7 +1355,6 @@ class Scatter(Recharts):
Union[Literal["fitting", "joint"], Var[Literal["fitting", "joint"]]] Union[Literal["fitting", "joint"], Var[Literal["fitting", "joint"]]]
] = None, ] = None,
fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None, fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
name: Optional[Union[Var[Union[int, str]], int, str]] = None,
is_animation_active: Optional[Union[Var[bool], bool]] = None, is_animation_active: Optional[Union[Var[bool], bool]] = None,
animation_begin: Optional[Union[Var[int], int]] = None, animation_begin: Optional[Union[Var[int], int]] = None,
animation_duration: Optional[Union[Var[int], int]] = None, animation_duration: Optional[Union[Var[int], int]] = None,
@ -1413,19 +1412,18 @@ class Scatter(Recharts):
Args: Args:
*children: The children of the component. *children: The children of the component.
data: The source data, in which each element is an object. data: The source data, in which each element is an object.
legend_type: 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: 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'. Default: "circle"
x_axis_id: The id of x-axis which is corresponding to the data. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
y_axis_id: The id of y-axis which is corresponding to the data. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
z_axis_id: The id of z-axis which is corresponding to the data. z_axis_id: The id of z-axis which is corresponding to the data. Default: 0
line: If false set, line will not be drawn. If true set, line will be drawn which have the props calculated internally. line: If false set, line will not be drawn. If true set, line will be drawn which have the props calculated internally. Default: False
shape: If a string set, specified symbol will be used to show scatter item. 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye' shape: If a string set, specified symbol will be used to show scatter item. 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye'. Default: "circle"
line_type: If 'joint' set, line will generated by just jointing all the points. If 'fitting' set, line will be generated by fitting algorithm. 'joint' | 'fitting' line_type: If 'joint' set, line will generated by just jointing all the points. If 'fitting' set, line will be generated by fitting algorithm. 'joint' | 'fitting'. Default: "joint"
fill: The fill fill: The fill color of the scatter. Default: rx.color("accent", 9)
name: the name is_animation_active: If set false, animation of bar will be disabled. Default: True in CSR, False in SSR
is_animation_active: If set false, animation of bar will be disabled. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
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_duration: Specifies the duration of animation, the unit of this option is ms, default 1500. animation_easing: The type of easing function. Default: "ease"
animation_easing: The type of easing function, default 'ease'
style: The style of the component. style: The style of the component.
key: A unique key for the component. key: A unique key for the component.
id: The id for the component. id: The id for the component.