default props comment for XAxis (#4110)

* default props comment for XAxis

* axis id
This commit is contained in:
Carlos 2024-10-09 01:09:03 +02:00 committed by GitHub
parent 19df34d941
commit 9c7de9b189
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 15 additions and 13 deletions

View File

@ -129,20 +129,20 @@ class XAxis(Axis):
alias = "RechartsXAxis" alias = "RechartsXAxis"
# The orientation of axis 'top' | 'bottom' # The orientation of axis 'top' | 'bottom'. Default: "bottom"
orientation: Var[LiteralOrientationTopBottom] orientation: Var[LiteralOrientationTopBottom]
# 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]]
# Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden # Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden. Default: False
include_hidden: Var[bool] = LiteralVar.create(False) include_hidden: Var[bool]
# The range of the axis. Work best in conjuction with allow_data_overflow. # The angle of axis ticks. Default: 0
domain: Var[List] angle: Var[int]
# The range of the axis. Work best in conjuction with allow_data_overflow. # Specify the padding of x-axis. Default: {"left": 0, "right": 0}
domain: Var[List] padding: Var[Dict[str, int]]
class YAxis(Axis): class YAxis(Axis):

View File

@ -182,7 +182,8 @@ class XAxis(Axis):
] = 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,
include_hidden: Optional[Union[Var[bool], bool]] = None, include_hidden: Optional[Union[Var[bool], bool]] = None,
domain: Optional[Union[List, Var[List]]] = None, angle: Optional[Union[Var[int], int]] = None,
padding: Optional[Union[Dict[str, int], Var[Dict[str, int]]]] = None,
data_key: Optional[Union[Var[Union[int, str]], int, str]] = None, data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
hide: Optional[Union[Var[bool], bool]] = None, hide: Optional[Union[Var[bool], bool]] = None,
width: Optional[Union[Var[Union[int, str]], int, str]] = None, width: Optional[Union[Var[Union[int, str]], int, str]] = None,
@ -298,10 +299,11 @@ class XAxis(Axis):
Args: Args:
*children: The children of the component. *children: The children of the component.
orientation: The orientation of axis 'top' | 'bottom' orientation: The orientation of axis 'top' | 'bottom'. Default: "bottom"
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
include_hidden: Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden include_hidden: Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden. Default: False
domain: The range of the axis. Work best in conjuction with allow_data_overflow. angle: The angle of axis ticks. Default: 0
padding: Specify the padding of x-axis. Default: {"left": 0, "right": 0}
data_key: The key of data displayed in the axis. data_key: The key of data displayed in the axis.
hide: If set true, the axis do not display in the chart. hide: If set true, the axis do not display in the chart.
width: The width of axis which is usually calculated internally. width: The width of axis which is usually calculated internally.