default props comment for CartesianAxis (#4127)

This commit is contained in:
Carlos 2024-10-08 21:36:19 +02:00 committed by GitHub
parent 5e3cfecdea
commit 02d4428e39
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 24 additions and 19 deletions

View File

@ -811,28 +811,31 @@ class CartesianAxis(Grid):
alias = "RechartsCartesianAxis" alias = "RechartsCartesianAxis"
# The orientation of axis 'top' | 'bottom' | 'left' | 'right' # The orientation of axis 'top' | 'bottom' | 'left' | 'right'. Default: "bottom"
orientation: Var[LiteralOrientationTopBottomLeftRight] orientation: Var[LiteralOrientationTopBottomLeftRight]
# If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line. # The box of viewing area. Default: {"x": 0, "y": 0, "width": 0, "height": 0}
view_box: Var[Dict[str, Any]]
# If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line. Default: True
axis_line: Var[bool] axis_line: Var[bool]
# If set false, no axis tick lines will be drawn. If set a object, the option is the configuration of tick lines. # If set false, no ticks will be drawn.
tick: Var[bool]
# If set false, no axis tick lines will be drawn. If set a object, the option is the configuration of tick lines. Default: True
tick_line: Var[bool] tick_line: Var[bool]
# The length of tick line. # The length of tick line. Default: 6
tick_size: Var[int] tick_size: Var[int]
# If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. # If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. Default: "preserveEnd"
interval: Var[LiteralInterval] interval: Var[LiteralInterval]
# If set false, no ticks will be drawn.
ticks: Var[bool]
# If set a string or a number, default label will be drawn, and the option is content. # If set a string or a number, default label will be drawn, and the option is content.
label: Var[str] label: Var[Union[str, int]]
# If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. # If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. Default: False
mirror: Var[bool] mirror: Var[bool]
# The margin between tick line and tick. # The margin between tick line and tick.

View File

@ -2179,7 +2179,9 @@ class CartesianAxis(Grid):
Var[Literal["bottom", "left", "right", "top"]], Var[Literal["bottom", "left", "right", "top"]],
] ]
] = None, ] = None,
view_box: Optional[Union[Dict[str, Any], Var[Dict[str, Any]]]] = None,
axis_line: Optional[Union[Var[bool], bool]] = None, axis_line: Optional[Union[Var[bool], bool]] = None,
tick: Optional[Union[Var[bool], bool]] = None,
tick_line: Optional[Union[Var[bool], bool]] = None, tick_line: Optional[Union[Var[bool], bool]] = None,
tick_size: Optional[Union[Var[int], int]] = None, tick_size: Optional[Union[Var[int], int]] = None,
interval: Optional[ interval: Optional[
@ -2188,8 +2190,7 @@ class CartesianAxis(Grid):
Var[Literal["preserveEnd", "preserveStart", "preserveStartEnd"]], Var[Literal["preserveEnd", "preserveStart", "preserveStartEnd"]],
] ]
] = None, ] = None,
ticks: Optional[Union[Var[bool], bool]] = None, label: Optional[Union[Var[Union[int, str]], int, str]] = None,
label: Optional[Union[Var[str], str]] = None,
mirror: Optional[Union[Var[bool], bool]] = None, mirror: Optional[Union[Var[bool], bool]] = None,
tick_margin: Optional[Union[Var[int], int]] = None, tick_margin: Optional[Union[Var[int], int]] = None,
x: Optional[Union[Var[int], int]] = None, x: Optional[Union[Var[int], int]] = None,
@ -2243,14 +2244,15 @@ class CartesianAxis(Grid):
Args: Args:
*children: The children of the component. *children: The children of the component.
orientation: The orientation of axis 'top' | 'bottom' | 'left' | 'right' orientation: The orientation of axis 'top' | 'bottom' | 'left' | 'right'. Default: "bottom"
axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line. view_box: The box of viewing area. Default: {"x": 0, "y": 0, "width": 0, "height": 0}
tick_line: If set false, no axis tick lines will be drawn. If set a object, the option is the configuration of tick lines. axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line. Default: True
tick_size: The length of tick line. tick: If set false, no ticks will be drawn.
interval: If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. tick_line: If set false, no axis tick lines will be drawn. If set a object, the option is the configuration of tick lines. Default: True
ticks: If set false, no ticks will be drawn. tick_size: The length of tick line. Default: 6
interval: If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. Default: "preserveEnd"
label: If set a string or a number, default label will be drawn, and the option is content. label: If set a string or a number, default label will be drawn, and the option is content.
mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. Default: False
tick_margin: The margin between tick line and tick. tick_margin: The margin between tick line and tick.
x: The x-coordinate of grid. x: The x-coordinate of grid.
y: The y-coordinate of grid. y: The y-coordinate of grid.