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

default props comment for Cartesian

Browse Source
This commit is contained in:
carlosabadia 2024-10-08 16:36:09 +02:00
parent af83161fed
commit 208ddf03ee
2 changed files with 83 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -254,15 +254,33 @@ class Cartesian(Recharts):
# The key of a group of data which should be unique in an area chart. # The key of a group of data which should be unique in an area chart.
data_key: Var[Union[str, int]] data_key: Var[Union[str, int]]
# 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 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 # 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]
# If set false, animation of bar will be disabled. Default: True in CSR, and False in SSR
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 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 the component. If no value was set to this option, the value of dataKey will be used alternatively.
name: Var[Union[str, int]]
# The customized event handler of click on the component in this group # The customized event handler of click on the component in this group
on_click: EventHandler[lambda: []] on_click: EventHandler[lambda: []]

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

@ -722,6 +722,17 @@ class Cartesian(Recharts):
], ],
] ]
] = None, ] = None,
is_animation_active: Optional[Union[Var[bool], bool]] = None,
animation_begin: Optional[Union[Var[int], int]] = None,
animation_duration: Optional[Union[Var[int], int]] = None,
animation_easing: Optional[
Union[
Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
]
] = None,
unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
name: Optional[Union[Var[Union[int, str]], int, str]] = None,
style: Optional[Style] = None, style: Optional[Style] = None,
key: Optional[Any] = None, key: Optional[Any] = None,
id: Optional[Any] = None, id: Optional[Any] = None,
@ -771,9 +782,15 @@ class Cartesian(Recharts):
*children: The children of the component. *children: The children of the component.
layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical' layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
data_key: The key of a group of data which should be unique in an area chart. data_key: The key of a group of data which should be unique in an area chart.
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
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' | 'star' | 'triangle' | 'wye' | 'none'optional 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' | 'star' | 'triangle' | 'wye' | 'none' optional
is_animation_active: If set false, animation of bar will be disabled. Default: True in CSR, and False in SSR
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. Default: "ease"
unit: The unit of data. This option will be used in tooltip.
name: 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.
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.
@ -887,6 +904,15 @@ class Area(Cartesian):
], ],
] ]
] = None, ] = None,
is_animation_active: Optional[Union[Var[bool], bool]] = None,
animation_begin: Optional[Union[Var[int], int]] = None,
animation_duration: Optional[Union[Var[int], int]] = None,
animation_easing: Optional[
Union[
Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
]
] = None,
style: Optional[Style] = None, style: Optional[Style] = None,
key: Optional[Any] = None, key: Optional[Any] = None,
id: Optional[Any] = None, id: Optional[Any] = None,
@ -943,12 +969,16 @@ class Area(Cartesian):
label: If set false, labels will not be drawn. If set true, labels will be drawn which have the props calculated internally. label: If set false, labels will not be drawn. If set true, labels will be drawn which have the props calculated internally.
stack_id: 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: 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.
unit: The unit of data. This option will be used in tooltip. unit: The unit of data. This option will be used in tooltip.
name: 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: 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.
layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical' layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
data_key: The key of a group of data which should be unique in an area chart. data_key: The key of a group of data which should be unique in an area chart.
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
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' | 'star' | 'triangle' | 'wye' | 'none'optional 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' | 'star' | 'triangle' | 'wye' | 'none' optional
is_animation_active: If set false, animation of bar will be disabled. Default: True in CSR, and False in SSR
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. 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.
@ -1090,18 +1120,18 @@ class Bar(Cartesian):
stack_id: 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: 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.
unit: The unit of data. This option will be used in tooltip. unit: The unit of data. This option will be used in tooltip.
min_point_size: 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: 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.
name: 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: 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.
bar_size: Size of the bar (if one bar_size is set then a bar_size must be set for all bars) bar_size: Size of the bar (if one bar_size is set then a bar_size must be set for all bars)
max_bar_size: Max size of the bar max_bar_size: Max size of the bar
is_animation_active: If set false, animation of bar will be disabled. is_animation_active: If set false, animation of bar will be disabled. Default: True in CSR, and False in SSR
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"
layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical' layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
data_key: The key of a group of data which should be unique in an area chart. data_key: The key of a group of data which should be unique in an area chart.
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
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' | 'star' | 'triangle' | 'wye' | 'none'optional 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' | 'star' | 'triangle' | 'wye' | 'none' optional
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.
@ -1215,6 +1245,15 @@ class Line(Cartesian):
], ],
] ]
] = None, ] = None,
is_animation_active: Optional[Union[Var[bool], bool]] = None,
animation_begin: Optional[Union[Var[int], int]] = None,
animation_duration: Optional[Union[Var[int], int]] = None,
animation_easing: Optional[
Union[
Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
]
] = None,
style: Optional[Style] = None, style: Optional[Style] = None,
key: Optional[Any] = None, key: Optional[Any] = None,
id: Optional[Any] = None, id: Optional[Any] = None,
@ -1271,12 +1310,16 @@ class Line(Cartesian):
hide: Hides the line when true, useful when toggling visibility state via legend. hide: Hides the line when true, useful when toggling visibility state via legend.
connect_nulls: Whether to connect a graph line across null points. connect_nulls: Whether to connect a graph line across null points.
unit: The unit of data. This option will be used in tooltip. unit: The unit of data. This option will be used in tooltip.
name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart. name: 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.
layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical' layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
data_key: The key of a group of data which should be unique in an area chart. data_key: The key of a group of data which should be unique in an area chart.
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
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' | 'star' | 'triangle' | 'wye' | 'none'optional 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' | 'star' | 'triangle' | 'wye' | 'none' optional
is_animation_active: If set false, animation of bar will be disabled. Default: True in CSR, and False in SSR
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. 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.