b20f3ac29a
* update graphing * fix pyi * update graphing rebase# * fix pyi * precommit fail * fix pyi generator file * update pyi again * pyi * fix pyi generator to have single line builtin check * change dict to Dict --------- Co-authored-by: Tom Gotsman <tomgotsman@toms-mbp.lan> Co-authored-by: Tom Gotsman <tomgotsman@Toms-MacBook-Pro.local> Co-authored-by: Lendemor <thomas.brandeho@gmail.com>
2457 lines
106 KiB
Python
2457 lines
106 KiB
Python
"""Stub file for reflex/components/recharts/cartesian.py"""
|
|
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
from typing import Any, Callable, Dict, List, Literal, Optional, Union, overload
|
|
|
|
from reflex.constants.colors import Color
|
|
from reflex.event import EventHandler, EventSpec
|
|
from reflex.style import Style
|
|
from reflex.vars import BaseVar, Var
|
|
|
|
from .recharts import (
|
|
Recharts,
|
|
)
|
|
|
|
class Axis(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
hide: Optional[Union[Var[bool], bool]] = None,
|
|
width: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
height: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
orientation: Optional[
|
|
Union[Var[Literal["top", "bottom"]], Literal["top", "bottom"]]
|
|
] = None,
|
|
type_: Optional[
|
|
Union[Var[Literal["number", "category"]], Literal["number", "category"]]
|
|
] = None,
|
|
allow_decimals: Optional[Union[Var[bool], bool]] = None,
|
|
allow_data_overflow: Optional[Union[Var[bool], bool]] = None,
|
|
allow_duplicated_category: Optional[Union[Var[bool], bool]] = None,
|
|
axis_line: Optional[Union[Var[bool], bool]] = None,
|
|
mirror: Optional[Union[Var[bool], bool]] = None,
|
|
reversed: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[
|
|
Union[Var[Union[Dict[str, Any], int, str]], str, int, Dict[str, Any]]
|
|
] = None,
|
|
scale: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
]
|
|
],
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
],
|
|
]
|
|
] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
ticks: Optional[
|
|
Union[Var[List[Union[int, str]]], List[Union[int, str]]]
|
|
] = None,
|
|
tick: Optional[Union[Var[bool], bool]] = None,
|
|
tick_count: Optional[Union[Var[int], int]] = None,
|
|
tick_line: Optional[Union[Var[bool], bool]] = None,
|
|
tick_size: Optional[Union[Var[int], int]] = None,
|
|
min_tick_gap: Optional[Union[Var[int], int]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
text_anchor: Optional[Union[Var[str], str]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Axis":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
data_key: The key of a group of data which should be unique in an area chart.
|
|
hide: If set true, the axis do not display in the chart.
|
|
width: The width of axis which is usually calculated internally.
|
|
height: The height of axis, which can be setted by user.
|
|
orientation: The orientation of axis 'top' | 'bottom'
|
|
type_: The type of axis 'number' | 'category'
|
|
allow_decimals: Allow the ticks of XAxis to be decimals or not.
|
|
allow_data_overflow: When domain of the axis is specified and the type of the axis is 'number', if allowDataOverflow is set to be false, the domain will be adjusted when the minimum value of data is smaller than domain[0] or the maximum value of data is greater than domain[1] so that the axis displays all data values. If set to true, graphic elements (line, area, bars) will be clipped to conform to the specified domain.
|
|
allow_duplicated_category: Allow the axis has duplicated categorys or not when the type of axis is "category".
|
|
axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line.
|
|
mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside.
|
|
reversed: Reverse the ticks or not.
|
|
label: The label of axis, which appears next to the axis.
|
|
scale: If 'auto' set, the scale function is decided by the type of chart, and the props type. 'auto' | 'linear' | 'pow' | 'sqrt' | 'log' | 'identity' | 'time' | 'band' | 'point' | 'ordinal' | 'quantile' | 'quantize' | 'utc' | 'sequential' | 'threshold' | Function
|
|
unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
|
|
name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
|
|
ticks: Set the values of axis ticks manually.
|
|
tick: If set false, no ticks will be drawn.
|
|
tick_count: The count of axis ticks.
|
|
tick_line: If set false, no axis tick lines will be drawn.
|
|
tick_size: The length of tick line.
|
|
min_tick_gap: The minimum gap between two adjacent labels
|
|
stroke: The stroke color of axis
|
|
text_anchor: The text anchor of axis
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class XAxis(Axis):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
include_hidden: Optional[Union[Var[bool], bool]] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
hide: Optional[Union[Var[bool], bool]] = None,
|
|
width: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
height: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
orientation: Optional[
|
|
Union[Var[Literal["top", "bottom"]], Literal["top", "bottom"]]
|
|
] = None,
|
|
type_: Optional[
|
|
Union[Var[Literal["number", "category"]], Literal["number", "category"]]
|
|
] = None,
|
|
allow_decimals: Optional[Union[Var[bool], bool]] = None,
|
|
allow_data_overflow: Optional[Union[Var[bool], bool]] = None,
|
|
allow_duplicated_category: Optional[Union[Var[bool], bool]] = None,
|
|
axis_line: Optional[Union[Var[bool], bool]] = None,
|
|
mirror: Optional[Union[Var[bool], bool]] = None,
|
|
reversed: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[
|
|
Union[Var[Union[Dict[str, Any], int, str]], str, int, Dict[str, Any]]
|
|
] = None,
|
|
scale: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
]
|
|
],
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
],
|
|
]
|
|
] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
ticks: Optional[
|
|
Union[Var[List[Union[int, str]]], List[Union[int, str]]]
|
|
] = None,
|
|
tick: Optional[Union[Var[bool], bool]] = None,
|
|
tick_count: Optional[Union[Var[int], int]] = None,
|
|
tick_line: Optional[Union[Var[bool], bool]] = None,
|
|
tick_size: Optional[Union[Var[int], int]] = None,
|
|
min_tick_gap: Optional[Union[Var[int], int]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
text_anchor: Optional[Union[Var[str], str]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "XAxis":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
include_hidden: Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden
|
|
data_key: The key of a group of data which should be unique in an area chart.
|
|
hide: If set true, the axis do not display in the chart.
|
|
width: The width of axis which is usually calculated internally.
|
|
height: The height of axis, which can be setted by user.
|
|
orientation: The orientation of axis 'top' | 'bottom'
|
|
type_: The type of axis 'number' | 'category'
|
|
allow_decimals: Allow the ticks of XAxis to be decimals or not.
|
|
allow_data_overflow: When domain of the axis is specified and the type of the axis is 'number', if allowDataOverflow is set to be false, the domain will be adjusted when the minimum value of data is smaller than domain[0] or the maximum value of data is greater than domain[1] so that the axis displays all data values. If set to true, graphic elements (line, area, bars) will be clipped to conform to the specified domain.
|
|
allow_duplicated_category: Allow the axis has duplicated categorys or not when the type of axis is "category".
|
|
axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line.
|
|
mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside.
|
|
reversed: Reverse the ticks or not.
|
|
label: The label of axis, which appears next to the axis.
|
|
scale: If 'auto' set, the scale function is decided by the type of chart, and the props type. 'auto' | 'linear' | 'pow' | 'sqrt' | 'log' | 'identity' | 'time' | 'band' | 'point' | 'ordinal' | 'quantile' | 'quantize' | 'utc' | 'sequential' | 'threshold' | Function
|
|
unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
|
|
name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
|
|
ticks: Set the values of axis ticks manually.
|
|
tick: If set false, no ticks will be drawn.
|
|
tick_count: The count of axis ticks.
|
|
tick_line: If set false, no axis tick lines will be drawn.
|
|
tick_size: The length of tick line.
|
|
min_tick_gap: The minimum gap between two adjacent labels
|
|
stroke: The stroke color of axis
|
|
text_anchor: The text anchor of axis
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class YAxis(Axis):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
orientation: Optional[
|
|
Union[Var[Literal["left", "right"]], Literal["left", "right"]]
|
|
] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
hide: Optional[Union[Var[bool], bool]] = None,
|
|
width: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
height: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
type_: Optional[
|
|
Union[Var[Literal["number", "category"]], Literal["number", "category"]]
|
|
] = None,
|
|
allow_decimals: Optional[Union[Var[bool], bool]] = None,
|
|
allow_data_overflow: Optional[Union[Var[bool], bool]] = None,
|
|
allow_duplicated_category: Optional[Union[Var[bool], bool]] = None,
|
|
axis_line: Optional[Union[Var[bool], bool]] = None,
|
|
mirror: Optional[Union[Var[bool], bool]] = None,
|
|
reversed: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[
|
|
Union[Var[Union[Dict[str, Any], int, str]], str, int, Dict[str, Any]]
|
|
] = None,
|
|
scale: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
]
|
|
],
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
],
|
|
]
|
|
] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
ticks: Optional[
|
|
Union[Var[List[Union[int, str]]], List[Union[int, str]]]
|
|
] = None,
|
|
tick: Optional[Union[Var[bool], bool]] = None,
|
|
tick_count: Optional[Union[Var[int], int]] = None,
|
|
tick_line: Optional[Union[Var[bool], bool]] = None,
|
|
tick_size: Optional[Union[Var[int], int]] = None,
|
|
min_tick_gap: Optional[Union[Var[int], int]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
text_anchor: Optional[Union[Var[str], str]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "YAxis":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
orientation: The orientation of axis 'top' | 'bottom'
|
|
data_key: The key of a group of data which should be unique in an area chart.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
hide: If set true, the axis do not display in the chart.
|
|
width: The width of axis which is usually calculated internally.
|
|
height: The height of axis, which can be setted by user.
|
|
type_: The type of axis 'number' | 'category'
|
|
allow_decimals: Allow the ticks of XAxis to be decimals or not.
|
|
allow_data_overflow: When domain of the axis is specified and the type of the axis is 'number', if allowDataOverflow is set to be false, the domain will be adjusted when the minimum value of data is smaller than domain[0] or the maximum value of data is greater than domain[1] so that the axis displays all data values. If set to true, graphic elements (line, area, bars) will be clipped to conform to the specified domain.
|
|
allow_duplicated_category: Allow the axis has duplicated categorys or not when the type of axis is "category".
|
|
axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line.
|
|
mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside.
|
|
reversed: Reverse the ticks or not.
|
|
label: The label of axis, which appears next to the axis.
|
|
scale: If 'auto' set, the scale function is decided by the type of chart, and the props type. 'auto' | 'linear' | 'pow' | 'sqrt' | 'log' | 'identity' | 'time' | 'band' | 'point' | 'ordinal' | 'quantile' | 'quantize' | 'utc' | 'sequential' | 'threshold' | Function
|
|
unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
|
|
name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
|
|
ticks: Set the values of axis ticks manually.
|
|
tick: If set false, no ticks will be drawn.
|
|
tick_count: The count of axis ticks.
|
|
tick_line: If set false, no axis tick lines will be drawn.
|
|
tick_size: The length of tick line.
|
|
min_tick_gap: The minimum gap between two adjacent labels
|
|
stroke: The stroke color of axis
|
|
text_anchor: The text anchor of axis
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class ZAxis(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
range: Optional[Union[Var[List[int]], List[int]]] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
scale: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
]
|
|
],
|
|
Literal[
|
|
"auto",
|
|
"linear",
|
|
"pow",
|
|
"sqrt",
|
|
"log",
|
|
"identity",
|
|
"time",
|
|
"band",
|
|
"point",
|
|
"ordinal",
|
|
"quantile",
|
|
"quantize",
|
|
"utc",
|
|
"sequential",
|
|
"threshold",
|
|
],
|
|
]
|
|
] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "ZAxis":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
data_key: The key of data displayed in the axis.
|
|
range: The range of axis.
|
|
unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
|
|
name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
|
|
scale: If 'auto' set, the scale function is decided by the type of chart, and the props type.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Brush(Recharts):
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x: Optional[Union[Var[int], int]] = None,
|
|
y: Optional[Union[Var[int], int]] = None,
|
|
width: Optional[Union[Var[int], int]] = None,
|
|
height: Optional[Union[Var[int], int]] = None,
|
|
data: Optional[Union[Var[List[Any]], List[Any]]] = None,
|
|
traveller_width: Optional[Union[Var[int], int]] = None,
|
|
gap: Optional[Union[Var[int], int]] = None,
|
|
start_index: Optional[Union[Var[int], int]] = None,
|
|
end_index: Optional[Union[Var[int], int]] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = 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_change: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Brush":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
data_key: The key of data displayed in the axis.
|
|
x: The x-coordinate of brush.
|
|
y: The y-coordinate of brush.
|
|
width: The width of brush.
|
|
height: The height of brush.
|
|
data: The data domain of brush, [min, max].
|
|
traveller_width: The width of each traveller.
|
|
gap: The data with gap of refreshing chart. If the option is not set, the chart will be refreshed every time
|
|
start_index: The default start index of brush. If the option is not set, the start index will be 0.
|
|
end_index: The default end index of brush. If the option is not set, the end index will be 1.
|
|
fill: The fill color of brush
|
|
stroke: The stroke color of brush
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Cartesian(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
legend_type: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
]
|
|
],
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
],
|
|
]
|
|
] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Cartesian":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
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.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
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.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Area(Cartesian):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stroke_width: Optional[Union[Var[int], int]] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
type_: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"basis",
|
|
"basisClosed",
|
|
"basisOpen",
|
|
"bumpX",
|
|
"bumpY",
|
|
"bump",
|
|
"linear",
|
|
"linearClosed",
|
|
"natural",
|
|
"monotoneX",
|
|
"monotoneY",
|
|
"monotone",
|
|
"step",
|
|
"stepBefore",
|
|
"stepAfter",
|
|
]
|
|
],
|
|
Literal[
|
|
"basis",
|
|
"basisClosed",
|
|
"basisOpen",
|
|
"bumpX",
|
|
"bumpY",
|
|
"bump",
|
|
"linear",
|
|
"linearClosed",
|
|
"natural",
|
|
"monotoneX",
|
|
"monotoneY",
|
|
"monotone",
|
|
"step",
|
|
"stepBefore",
|
|
"stepAfter",
|
|
],
|
|
]
|
|
] = None,
|
|
dot: Optional[Union[Var[bool], bool]] = None,
|
|
active_dot: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[Union[Var[bool], bool]] = None,
|
|
stack_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
legend_type: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
]
|
|
],
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
],
|
|
]
|
|
] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Area":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
stroke: The color of the line stroke.
|
|
stroke_width: The width of the line stroke.
|
|
fill: The color of the area fill.
|
|
type_: The interpolation type of area. And customized interpolation function can be set to type. 'basis' | 'basisClosed' | 'basisOpen' | 'bumpX' | 'bumpY' | 'bump' | 'linear' | 'linearClosed' | 'natural' | 'monotoneX' | 'monotoneY' | 'monotone' | 'step' | 'stepBefore' | 'stepAfter' |
|
|
dot: If set false, dots will not be drawn. If set true, dots will be drawn which have the props calculated internally.
|
|
active_dot: The dot is shown when a user enters an area chart and this chart has a tooltip. If set false, no active dot will be drawn. If set true, an active dot will be drawn which will 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.
|
|
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.
|
|
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.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
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.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Bar(Cartesian):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stroke_width: Optional[Union[Var[int], int]] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
background: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[Union[Var[bool], bool]] = None,
|
|
stack_id: Optional[Union[Var[str], str]] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
min_point_size: Optional[Union[Var[int], int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
bar_size: Optional[Union[Var[int], int]] = None,
|
|
max_bar_size: 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,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
legend_type: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
]
|
|
],
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
],
|
|
]
|
|
] = 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_animation_begin: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_animation_end: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_blur: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Bar":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
stroke: The color of the line stroke.
|
|
stroke_width: The width of the line stroke.
|
|
fill: The width of the line stroke.
|
|
background: If false set, background of bars will not be drawn. If true set, background of bars will be drawn which have the props calculated internally.
|
|
label: If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally.
|
|
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.
|
|
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.
|
|
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
|
|
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_duration: Specifies the duration of animation, the unit of this option is ms, default 1500.
|
|
animation_easing: The type of easing function, default 'ease'
|
|
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.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
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.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Line(Cartesian):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
type_: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"basis",
|
|
"basisClosed",
|
|
"basisOpen",
|
|
"bumpX",
|
|
"bumpY",
|
|
"bump",
|
|
"linear",
|
|
"linearClosed",
|
|
"natural",
|
|
"monotoneX",
|
|
"monotoneY",
|
|
"monotone",
|
|
"step",
|
|
"stepBefore",
|
|
"stepAfter",
|
|
]
|
|
],
|
|
Literal[
|
|
"basis",
|
|
"basisClosed",
|
|
"basisOpen",
|
|
"bumpX",
|
|
"bumpY",
|
|
"bump",
|
|
"linear",
|
|
"linearClosed",
|
|
"natural",
|
|
"monotoneX",
|
|
"monotoneY",
|
|
"monotone",
|
|
"step",
|
|
"stepBefore",
|
|
"stepAfter",
|
|
],
|
|
]
|
|
] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stoke_width: Optional[Union[Var[int], int]] = None,
|
|
dot: Optional[Union[Var[bool], bool]] = None,
|
|
active_dot: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[Union[Var[bool], bool]] = None,
|
|
hide: Optional[Union[Var[bool], bool]] = None,
|
|
connect_nulls: Optional[Union[Var[bool], bool]] = None,
|
|
unit: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
layout: Optional[
|
|
Union[
|
|
Var[Literal["horizontal", "vertical"]],
|
|
Literal["horizontal", "vertical"],
|
|
]
|
|
] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
legend_type: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
]
|
|
],
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
],
|
|
]
|
|
] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Line":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
type_: The interpolation type of line. And customized interpolation function can be set to type. It's the same as type in Area.
|
|
stroke: The color of the line stroke.
|
|
stoke_width: The width of the line stroke.
|
|
dot: If set false, dots will not be drawn. If set true, dots will be drawn which have the props calculated internally.
|
|
active_dot: The dot is shown when a user enters an area chart and this chart has a tooltip. If set false, no active dot will be drawn. If set true, an active dot will be drawn which will have the props calculated internally.
|
|
label: If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally.
|
|
hide: Hides the line when true, useful when toggling visibility state via legend.
|
|
connect_nulls: Whether to connect a graph line across null points.
|
|
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.
|
|
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.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
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.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Scatter(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
legend_type: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
]
|
|
],
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
],
|
|
]
|
|
] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
z_axis_id: Optional[Union[Var[str], str]] = None,
|
|
line: Optional[Union[Var[bool], bool]] = None,
|
|
shape: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"square",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
]
|
|
],
|
|
Literal[
|
|
"square", "circle", "cross", "diamond", "star", "triangle", "wye"
|
|
],
|
|
]
|
|
] = None,
|
|
line_type: Optional[
|
|
Union[Var[Literal["joint", "fitting"]], Literal["joint", "fitting"]]
|
|
] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
name: Optional[Union[Var[Union[int, str]], str, 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Scatter":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
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'
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
z_axis_id: The id of z-axis which is corresponding to the data.
|
|
line: If false set, line will not be drawn. If true set, line will be drawn which have the props calculated internally.
|
|
shape: If a string set, specified symbol will be used to show scatter item. 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye'
|
|
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'
|
|
fill: The fill
|
|
name: the name
|
|
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_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.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Funnel(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Union[Var[List[Dict[str, Any]]], List[Dict[str, Any]]]] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
name_key: Optional[Union[Var[str], str]] = None,
|
|
legend_type: Optional[
|
|
Union[
|
|
Var[
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"none",
|
|
]
|
|
],
|
|
Literal[
|
|
"line",
|
|
"plainline",
|
|
"square",
|
|
"rect",
|
|
"circle",
|
|
"cross",
|
|
"diamond",
|
|
"star",
|
|
"triangle",
|
|
"wye",
|
|
"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[
|
|
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_animation_end: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_animation_start: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_blur: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Funnel":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
data: The source data, in which each element is an object.
|
|
data_key: The key of a group of data which should be unique in an area chart.
|
|
name_key: The key or getter of a group of data which should be unique in a LineChart.
|
|
legend_type: The type of icon in legend. If set to 'none', no legend item will be rendered.
|
|
is_animation_active: If set false, animation of line 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 props of the component.
|
|
|
|
Returns:
|
|
The component.
|
|
"""
|
|
...
|
|
|
|
class ErrorBar(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
direction: Optional[
|
|
Union[Var[Literal["x", "y", "both"]], Literal["x", "y", "both"]]
|
|
] = None,
|
|
data_key: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
width: Optional[Union[Var[int], int]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stroke_width: Optional[Union[Var[int], int]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "ErrorBar":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
direction: The direction of error bar. 'x' | 'y' | 'both'
|
|
data_key: The key of a group of data which should be unique in an area chart.
|
|
width: The width of the error bar ends.
|
|
stroke: The stroke color of error bar.
|
|
stroke_width: The stroke width of error bar.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Reference(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
if_overflow: Optional[
|
|
Union[
|
|
Var[Literal["discard", "hidden", "visible", "extendDomain"]],
|
|
Literal["discard", "hidden", "visible", "extendDomain"],
|
|
]
|
|
] = None,
|
|
label: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
is_front: Optional[Union[Var[bool], bool]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Reference":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
if_overflow: Defines how to draw the reference line if it falls partly outside the canvas. If set to 'discard', the reference line will not be drawn at all. If set to 'hidden', the reference line will be clipped to the canvas. If set to 'visible', the reference line will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference line fits into the canvas.
|
|
label: If set a string or a number, default label will be drawn, and the option is content.
|
|
is_front: If set true, the line will be rendered in front of bars in BarChart, etc.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class ReferenceLine(Reference):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
x: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stroke_width: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
segment: Optional[List[Any]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
if_overflow: Optional[
|
|
Union[
|
|
Var[Literal["discard", "hidden", "visible", "extendDomain"]],
|
|
Literal["discard", "hidden", "visible", "extendDomain"],
|
|
]
|
|
] = None,
|
|
label: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
is_front: Optional[Union[Var[bool], bool]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "ReferenceLine":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
x: If set a string or a number, a vertical line perpendicular to the x-axis specified by xAxisId will be drawn. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys, otherwise no line will be drawn.
|
|
y: If set a string or a number, a horizontal line perpendicular to the y-axis specified by yAxisId will be drawn. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys, otherwise no line will be drawn.
|
|
stroke: The color of the reference line.
|
|
stroke_width: The width of the stroke.
|
|
segment: Array of endpoints in { x, y } format. These endpoints would be used to draw the ReferenceLine.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
if_overflow: Defines how to draw the reference line if it falls partly outside the canvas. If set to 'discard', the reference line will not be drawn at all. If set to 'hidden', the reference line will be clipped to the canvas. If set to 'visible', the reference line will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference line fits into the canvas.
|
|
label: If set a string or a number, default label will be drawn, and the option is content.
|
|
is_front: If set true, the line will be rendered in front of bars in BarChart, etc.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class ReferenceDot(Reference):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
x: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
r: Optional[Union[Var[int], int]] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
if_overflow: Optional[
|
|
Union[
|
|
Var[Literal["discard", "hidden", "visible", "extendDomain"]],
|
|
Literal["discard", "hidden", "visible", "extendDomain"],
|
|
]
|
|
] = None,
|
|
label: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
is_front: Optional[Union[Var[bool], bool]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "ReferenceDot":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
x: If set a string or a number, a vertical line perpendicular to the x-axis specified by xAxisId will be drawn. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys, otherwise no line will be drawn.
|
|
y: If set a string or a number, a horizontal line perpendicular to the y-axis specified by yAxisId will be drawn. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys, otherwise no line will be drawn.
|
|
r: The radius of dot.
|
|
fill: The color of the area fill.
|
|
stroke: The color of the line stroke.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
if_overflow: Defines how to draw the reference line if it falls partly outside the canvas. If set to 'discard', the reference line will not be drawn at all. If set to 'hidden', the reference line will be clipped to the canvas. If set to 'visible', the reference line will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference line fits into the canvas.
|
|
label: If set a string or a number, default label will be drawn, and the option is content.
|
|
is_front: If set true, the line will be rendered in front of bars in BarChart, etc.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class ReferenceArea(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
stroke: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
fill_opacity: Optional[Union[Var[float], float]] = None,
|
|
x_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y_axis_id: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x1: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
x2: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y1: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
y2: Optional[Union[Var[Union[int, str]], str, int]] = None,
|
|
if_overflow: Optional[
|
|
Union[
|
|
Var[Literal["discard", "hidden", "visible", "extendDomain"]],
|
|
Literal["discard", "hidden", "visible", "extendDomain"],
|
|
]
|
|
] = None,
|
|
is_front: Optional[Union[Var[bool], bool]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "ReferenceArea":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
stroke: Stroke color
|
|
fill: Fill color
|
|
fill_opacity: The opacity of area.
|
|
x_axis_id: The id of x-axis which is corresponding to the data.
|
|
y_axis_id: The id of y-axis which is corresponding to the data.
|
|
x1: A boundary value of the area. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys. If one of x1 or x2 is invalidate, the area will cover along x-axis.
|
|
x2: A boundary value of the area. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys. If one of x1 or x2 is invalidate, the area will cover along x-axis.
|
|
y1: A boundary value of the area. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys. If one of y1 or y2 is invalidate, the area will cover along y-axis.
|
|
y2: A boundary value of the area. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys. If one of y1 or y2 is invalidate, the area will cover along y-axis.
|
|
if_overflow: Defines how to draw the reference line if it falls partly outside the canvas. If set to 'discard', the reference line will not be drawn at all. If set to 'hidden', the reference line will be clipped to the canvas. If set to 'visible', the reference line will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference line fits into the canvas.
|
|
is_front: If set true, the line will be rendered in front of bars in BarChart, etc.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class Grid(Recharts):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
x: Optional[Union[Var[int], int]] = None,
|
|
y: Optional[Union[Var[int], int]] = None,
|
|
width: Optional[Union[Var[int], int]] = None,
|
|
height: Optional[Union[Var[int], int]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "Grid":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
x: The x-coordinate of grid.
|
|
y: The y-coordinate of grid.
|
|
width: The width of grid.
|
|
height: The height of grid.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class CartesianGrid(Grid):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
horizontal: Optional[Union[Var[bool], bool]] = None,
|
|
vertical: Optional[Union[Var[bool], bool]] = None,
|
|
vertical_points: Optional[
|
|
Union[Var[List[Union[int, str]]], List[Union[int, str]]]
|
|
] = None,
|
|
horizontal_points: Optional[
|
|
Union[Var[List[Union[int, str]]], List[Union[int, str]]]
|
|
] = None,
|
|
fill: Optional[Union[Var[Union[Color, str]], str, Color]] = None,
|
|
fill_opacity: Optional[Union[Var[float], float]] = None,
|
|
stroke_dasharray: Optional[Union[Var[str], str]] = None,
|
|
x: Optional[Union[Var[int], int]] = None,
|
|
y: Optional[Union[Var[int], int]] = None,
|
|
width: Optional[Union[Var[int], int]] = None,
|
|
height: Optional[Union[Var[int], int]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "CartesianGrid":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
horizontal: The horizontal line configuration.
|
|
vertical: The vertical line configuration.
|
|
vertical_points: The x-coordinates in pixel values of all vertical lines.
|
|
horizontal_points: The x-coordinates in pixel values of all vertical lines.
|
|
fill: The background of grid.
|
|
fill_opacity: The opacity of the background used to fill the space between grid lines
|
|
stroke_dasharray: The pattern of dashes and gaps used to paint the lines of the grid
|
|
x: The x-coordinate of grid.
|
|
y: The y-coordinate of grid.
|
|
width: The width of grid.
|
|
height: The height of grid.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
class CartesianAxis(Grid):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
orientation: Optional[
|
|
Union[
|
|
Var[Literal["top", "bottom", "left", "right"]],
|
|
Literal["top", "bottom", "left", "right"],
|
|
]
|
|
] = None,
|
|
axis_line: Optional[Union[Var[bool], bool]] = None,
|
|
tick_line: Optional[Union[Var[bool], bool]] = None,
|
|
tick_size: Optional[Union[Var[int], int]] = None,
|
|
interval: Optional[
|
|
Union[
|
|
Var[Literal["preserveStart", "preserveEnd", "preserveStartEnd"]],
|
|
Literal["preserveStart", "preserveEnd", "preserveStartEnd"],
|
|
]
|
|
] = None,
|
|
ticks: Optional[Union[Var[bool], bool]] = None,
|
|
label: Optional[Union[Var[str], str]] = None,
|
|
mirror: Optional[Union[Var[bool], bool]] = None,
|
|
tick_margin: Optional[Union[Var[int], int]] = None,
|
|
x: Optional[Union[Var[int], int]] = None,
|
|
y: Optional[Union[Var[int], int]] = None,
|
|
width: Optional[Union[Var[int], int]] = None,
|
|
height: Optional[Union[Var[int], int]] = 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, Callable, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, BaseVar]
|
|
] = None,
|
|
**props,
|
|
) -> "CartesianAxis":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
orientation: The orientation of axis 'top' | 'bottom' | 'left' | 'right'
|
|
axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line.
|
|
tick_line: If set false, no axis tick lines will be drawn. If set a object, the option is the configuration of tick lines.
|
|
tick_size: The length of tick line.
|
|
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.
|
|
ticks: If set false, no ticks will be drawn.
|
|
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.
|
|
tick_margin: The margin between tick line and tick.
|
|
x: The x-coordinate of grid.
|
|
y: The y-coordinate of grid.
|
|
width: The width of grid.
|
|
height: The height of grid.
|
|
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 component.
|
|
"""
|
|
...
|
|
|
|
area = Area.create
|
|
bar = Bar.create
|
|
line = Line.create
|
|
scatter = Scatter.create
|
|
x_axis = XAxis.create
|
|
y_axis = YAxis.create
|
|
z_axis = ZAxis.create
|
|
brush = Brush.create
|
|
cartesian_axis = CartesianAxis.create
|
|
cartesian_grid = CartesianGrid.create
|
|
reference_line = ReferenceLine.create
|
|
reference_dot = ReferenceDot.create
|
|
reference_area = ReferenceArea.create
|
|
error_bar = ErrorBar.create
|
|
funnel = Funnel.create
|