0af4770180
* build pyi files when building/publishing 3rd party * fix typo in workflow * add future annotation * add tests to pass coverage check * add more unit tests * omit pyi_generator from test coverage * change black from dev deps to direct deps * remake all pyi * format pyi if black is present, return as if otherwise * fix requested changes --------- Co-authored-by: Masen Furer <m_github@0x26.net>
896 lines
48 KiB
Python
896 lines
48 KiB
Python
"""Stub file for reflex/components/recharts/charts.py"""
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
|
|
from typing import Any, Dict, Literal, Optional, Union, overload
|
|
from reflex.vars import Var, BaseVar, ComputedVar
|
|
from reflex.event import EventChain, EventHandler, EventSpec
|
|
from reflex.style import Style
|
|
from typing import Any, Dict, List, Union
|
|
from reflex.components.component import Component
|
|
from reflex.components.recharts.general import ResponsiveContainer
|
|
from reflex.constants import EventTriggers
|
|
from reflex.vars import Var
|
|
from .recharts import (
|
|
LiteralAnimationEasing,
|
|
LiteralComposedChartBaseValue,
|
|
LiteralLayout,
|
|
LiteralStackOffset,
|
|
LiteralSyncMethod,
|
|
RechartsCharts,
|
|
)
|
|
|
|
class ChartBase(RechartsCharts):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "ChartBase":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class AreaChart(ChartBase):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
base_value: Optional[
|
|
Union[
|
|
Var[Union[int, Literal["dataMin", "dataMax", "auto"]]],
|
|
Union[int, Literal["dataMin", "dataMax", "auto"]],
|
|
]
|
|
] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "AreaChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
base_value: The base value of area. Number | 'dataMin' | 'dataMax' | 'auto'
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class BarChart(ChartBase):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
bar_category_gap: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
bar_gap: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
bar_size: Optional[Union[Var[int], int]] = None,
|
|
max_bar_size: Optional[Union[Var[int], int]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
reverse_stack_order: Optional[Union[Var[bool], bool]] = None,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "BarChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
bar_category_gap: The gap between two bar categories, which can be a percent value or a fixed value. Percentage | Number
|
|
bar_gap: The gap between two bars in the same category, which can be a percent value or a fixed value. Percentage | Number
|
|
bar_size: The width of all the bars in the chart. Number
|
|
max_bar_size: The maximum width of all the bars in a horizontal BarChart, or maximum height in a vertical BarChart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
reverse_stack_order: If false set, stacked items will be rendered left to right. If true set, stacked items will be rendered right to left. (Render direction affects SVG layering, not x position.)
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class LineChart(ChartBase):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "LineChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class ComposedChart(ChartBase):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
base_value: Optional[
|
|
Union[
|
|
Var[Union[int, Literal["dataMin", "dataMax", "auto"]]],
|
|
Union[int, Literal["dataMin", "dataMax", "auto"]],
|
|
]
|
|
] = None,
|
|
bar_category_gap: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
bar_gap: Optional[Union[Var[int], int]] = None,
|
|
bar_size: Optional[Union[Var[int], int]] = None,
|
|
reverse_stack_order: Optional[Union[Var[bool], bool]] = None,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "ComposedChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
base_value: The base value of area. Number | 'dataMin' | 'dataMax' | 'auto'
|
|
bar_category_gap: The gap between two bar categories, which can be a percent value or a fixed value. Percentage | Number
|
|
bar_gap: The gap between two bars in the same category, which can be a percent value or a fixed value. Percentage | Number
|
|
bar_size: The width of all the bars in the chart. Number
|
|
reverse_stack_order: If false set, stacked items will be rendered left to right. If true set, stacked items will be rendered right to left. (Render direction affects SVG layering, not x position.)
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class PieChart(ChartBase):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "PieChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class RadarChart(ChartBase):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
cx: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
cy: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
start_angle: Optional[Union[Var[int], int]] = None,
|
|
end_angle: Optional[Union[Var[int], int]] = None,
|
|
inner_radius: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
outer_radius: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "RadarChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
cx: The The x-coordinate of center. If set a percentage, the final value is obtained by multiplying the percentage of width. Number | Percentage
|
|
cy: The The y-coordinate of center. If set a percentage, the final value is obtained by multiplying the percentage of height. Number | Percentage
|
|
start_angle: The angle of first radial direction line.
|
|
end_angle: The angle of last point in the circle which should be startAngle - 360 or startAngle + 360. We'll calculate the direction of chart by 'startAngle' and 'endAngle'.
|
|
inner_radius: The inner radius of first circle grid. If set a percentage, the final value is obtained by multiplying the percentage of maxRadius which is calculated by the width, height, cx, cy. Number | Percentage
|
|
outer_radius: The outer radius of last circle grid. If set a percentage, the final value is obtained by multiplying the percentage of maxRadius which is calculated by the width, height, cx, cy. Number | Percentage
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class RadialBarChart(ChartBase):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
cx: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
cy: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
start_angle: Optional[Union[Var[int], int]] = None,
|
|
end_angle: Optional[Union[Var[int], int]] = None,
|
|
inner_radius: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
outer_radius: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
bar_category_gap: Optional[Union[Var[Union[int, str]], Union[int, str]]] = None,
|
|
bar_gap: Optional[Union[Var[str], str]] = None,
|
|
bar_size: Optional[Union[Var[int], int]] = None,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "RadialBarChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
cx: The The x-coordinate of center. If set a percentage, the final value is obtained by multiplying the percentage of width. Number | Percentage
|
|
cy: The The y-coordinate of center. If set a percentage, the final value is obtained by multiplying the percentage of height. Number | Percentage
|
|
start_angle: The angle of first radial direction line.
|
|
end_angle: The angle of last point in the circle which should be startAngle - 360 or startAngle + 360. We'll calculate the direction of chart by 'startAngle' and 'endAngle'.
|
|
inner_radius: The inner radius of first circle grid. If set a percentage, the final value is obtained by multiplying the percentage of maxRadius which is calculated by the width, height, cx, cy. Number | Percentage
|
|
outer_radius: The outer radius of last circle grid. If set a percentage, the final value is obtained by multiplying the percentage of maxRadius which is calculated by the width, height, cx, cy. Number | Percentage
|
|
bar_category_gap: The gap between two bar categories, which can be a percent value or a fixed value. Percentage | Number
|
|
bar_gap: The gap between two bars in the same category, which can be a percent value or a fixed value. Percentage | Number
|
|
bar_size: The size of each bar. If the barSize is not specified, the size of bar will be calculated by the barCategoryGap, barGap and the quantity of bar groups.
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class ScatterChart(ChartBase):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[
|
|
Union[Var[Literal["index", "value"]], Literal["index", "value"]]
|
|
] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "ScatterChart":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of area in the chart. 'horizontal' | 'vertical'
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The chart component wrapped in a responsive container.
|
|
"""
|
|
...
|
|
|
|
class FunnelChart(RechartsCharts):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
sync_id: Optional[Union[Var[str], str]] = None,
|
|
sync_method: Optional[Union[Var[str], str]] = None,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
layout: Optional[Union[Var[str], str]] = None,
|
|
margin: Optional[Union[Var[Dict[str, Any]], Dict[str, Any]]] = None,
|
|
stack_offset: Optional[
|
|
Union[
|
|
Var[Literal["expand", "none", "wiggle", "silhouette"]],
|
|
Literal["expand", "none", "wiggle", "silhouette"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "FunnelChart":
|
|
"""Create a new memoization leaf component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
data: The source data, in which each element is an object.
|
|
sync_id: If any two categorical charts(rx.line_chart, rx.area_chart, rx.bar_chart, rx.composed_chart) have the same sync_id, these two charts can sync the position GraphingTooltip, and the start_index, end_index of Brush.
|
|
sync_method: When sync_id is provided, allows customisation of how the charts will synchronize GraphingTooltips and brushes. Using 'index' (default setting), other charts will reuse current datum's index within the data array. In cases where data does not have the same length, this might yield unexpected results. In that case use 'value' which will try to match other charts values, or a fully custom function which will receive tick, data as argument and should return an index. 'index' | 'value' | function
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
layout: The layout of bars in the chart. centeric
|
|
margin: The sizes of whitespace around the chart.
|
|
stack_offset: The type of offset function used to generate the lower and upper values in the series array. The four types are built-in offsets in d3-shape. 'expand' | 'none' | 'wiggle' | 'silhouette'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The props of the component.
|
|
|
|
Returns:
|
|
The memoization leaf
|
|
"""
|
|
...
|
|
|
|
class Treemap(RechartsCharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
width: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
height: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
data_key: Optional[Union[Var[Union[str, int]], Union[str, int]]] = None,
|
|
aspect_ratio: Optional[Union[Var[int], int]] = 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[
|
|
Var[Literal["ease", "ease-in", "ease-out", "ease-in-out", "linear"]],
|
|
Literal["ease", "ease-in", "ease-out", "ease-in-out", "linear"],
|
|
]
|
|
] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_blur: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "Treemap":
|
|
"""Create a chart component.
|
|
|
|
Args:
|
|
*children: The children of the chart component.
|
|
width: The width of chart container. String or Integer
|
|
height: The height of chart container.
|
|
data: data of treemap. Array
|
|
data_key: The key of a group of data which should be unique in a treemap. String | Number | Function
|
|
aspect_ratio: The treemap will try to keep every single rectangle's aspect ratio near the aspectRatio given. Number
|
|
is_animation_active: If set false, animation of area 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'
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props: The properties of the chart component.
|
|
|
|
Returns:
|
|
The Treemap component wrapped in a responsive container.
|
|
"""
|
|
...
|