cartesian.pyi 108 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162
  1. """Stub file for reflex/components/recharts/cartesian.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Dict, List, Literal, Optional, Union, overload
  6. from reflex.constants.colors import Color
  7. from reflex.event import EventType
  8. from reflex.style import Style
  9. from reflex.vars.base import Var
  10. from .recharts import Recharts
  11. class Axis(Recharts):
  12. @overload
  13. @classmethod
  14. def create( # type: ignore
  15. cls,
  16. *children,
  17. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  18. hide: Optional[Union[Var[bool], bool]] = None,
  19. width: Optional[Union[Var[Union[int, str]], int, str]] = None,
  20. height: Optional[Union[Var[Union[int, str]], int, str]] = None,
  21. type_: Optional[
  22. Union[Literal["category", "number"], Var[Literal["category", "number"]]]
  23. ] = None,
  24. interval: Optional[
  25. Union[
  26. Literal[
  27. "equidistantPreserveStart",
  28. "preserveEnd",
  29. "preserveStart",
  30. "preserveStartEnd",
  31. ],
  32. Var[
  33. Union[
  34. Literal[
  35. "equidistantPreserveStart",
  36. "preserveEnd",
  37. "preserveStart",
  38. "preserveStartEnd",
  39. ],
  40. int,
  41. ]
  42. ],
  43. int,
  44. ]
  45. ] = None,
  46. allow_decimals: Optional[Union[Var[bool], bool]] = None,
  47. allow_data_overflow: Optional[Union[Var[bool], bool]] = None,
  48. allow_duplicated_category: Optional[Union[Var[bool], bool]] = None,
  49. domain: Optional[Union[List, Var[List]]] = None,
  50. axis_line: Optional[Union[Var[bool], bool]] = None,
  51. mirror: Optional[Union[Var[bool], bool]] = None,
  52. reversed: Optional[Union[Var[bool], bool]] = None,
  53. label: Optional[
  54. Union[Dict[str, Any], Var[Union[Dict[str, Any], int, str]], int, str]
  55. ] = None,
  56. scale: Optional[
  57. Union[
  58. Literal[
  59. "auto",
  60. "band",
  61. "identity",
  62. "linear",
  63. "log",
  64. "ordinal",
  65. "point",
  66. "pow",
  67. "quantile",
  68. "quantize",
  69. "sequential",
  70. "sqrt",
  71. "threshold",
  72. "time",
  73. "utc",
  74. ],
  75. Var[
  76. Literal[
  77. "auto",
  78. "band",
  79. "identity",
  80. "linear",
  81. "log",
  82. "ordinal",
  83. "point",
  84. "pow",
  85. "quantile",
  86. "quantize",
  87. "sequential",
  88. "sqrt",
  89. "threshold",
  90. "time",
  91. "utc",
  92. ]
  93. ],
  94. ]
  95. ] = None,
  96. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  97. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  98. ticks: Optional[
  99. Union[List[Union[int, str]], Var[List[Union[int, str]]]]
  100. ] = None,
  101. tick: Optional[Union[Var[bool], bool]] = None,
  102. tick_count: Optional[Union[Var[int], int]] = None,
  103. tick_line: Optional[Union[Var[bool], bool]] = None,
  104. tick_size: Optional[Union[Var[int], int]] = None,
  105. min_tick_gap: Optional[Union[Var[int], int]] = None,
  106. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  107. text_anchor: Optional[
  108. Union[
  109. Literal["end", "middle", "start"],
  110. Var[Literal["end", "middle", "start"]],
  111. ]
  112. ] = None,
  113. style: Optional[Style] = None,
  114. key: Optional[Any] = None,
  115. id: Optional[Any] = None,
  116. class_name: Optional[Any] = None,
  117. autofocus: Optional[bool] = None,
  118. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  119. on_blur: Optional[EventType[()]] = None,
  120. on_click: Optional[EventType[()]] = None,
  121. on_context_menu: Optional[EventType[()]] = None,
  122. on_double_click: Optional[EventType[()]] = None,
  123. on_focus: Optional[EventType[()]] = None,
  124. on_mount: Optional[EventType[()]] = None,
  125. on_mouse_down: Optional[EventType[()]] = None,
  126. on_mouse_enter: Optional[EventType[()]] = None,
  127. on_mouse_leave: Optional[EventType[()]] = None,
  128. on_mouse_move: Optional[EventType[()]] = None,
  129. on_mouse_out: Optional[EventType[()]] = None,
  130. on_mouse_over: Optional[EventType[()]] = None,
  131. on_mouse_up: Optional[EventType[()]] = None,
  132. on_scroll: Optional[EventType[()]] = None,
  133. on_unmount: Optional[EventType[()]] = None,
  134. **props,
  135. ) -> "Axis":
  136. """Create the component.
  137. Args:
  138. *children: The children of the component.
  139. data_key: The key of data displayed in the axis.
  140. hide: If set true, the axis do not display in the chart. Default: False
  141. width: The width of axis which is usually calculated internally.
  142. height: The height of axis, which can be set by user.
  143. type_: The type of axis 'number' | 'category'
  144. interval: If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. Default: "preserveEnd"
  145. allow_decimals: Allow the ticks of Axis to be decimals or not. Default: True
  146. 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. Default: False
  147. allow_duplicated_category: Allow the axis has duplicated categorys or not when the type of axis is "category". Default: True
  148. domain: The range of the axis. Work best in conjunction with allow_data_overflow. Default: [0, "auto"]
  149. axis_line: If set false, no axis line will be drawn. Default: True
  150. mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. Default: False
  151. reversed: Reverse the ticks or not. Default: False
  152. label: The label of axis, which appears next to the axis.
  153. 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'. Default: "auto"
  154. unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
  155. name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
  156. ticks: Set the values of axis ticks manually.
  157. tick: If set false, no ticks will be drawn.
  158. tick_count: The count of axis ticks. Not used if 'type' is 'category'. Default: 5
  159. tick_line: If set false, no axis tick lines will be drawn. Default: True
  160. tick_size: The length of tick line. Default: 6
  161. min_tick_gap: The minimum gap between two adjacent labels. Default: 5
  162. stroke: The stroke color of axis. Default: rx.color("gray", 9)
  163. text_anchor: The text anchor of axis. Default: "middle"
  164. on_click: The customized event handler of click on the ticks of this axis
  165. on_mouse_down: The customized event handler of mousedown on the ticks of this axis
  166. on_mouse_up: The customized event handler of mouseup on the ticks of this axis
  167. on_mouse_move: The customized event handler of mousemove on the ticks of this axis
  168. on_mouse_out: The customized event handler of mouseout on the ticks of this axis
  169. on_mouse_enter: The customized event handler of mouseenter on the ticks of this axis
  170. on_mouse_leave: The customized event handler of mouseleave on the ticks of this axis
  171. style: The style of the component.
  172. key: A unique key for the component.
  173. id: The id for the component.
  174. class_name: The class name for the component.
  175. autofocus: Whether the component should take the focus once the page is loaded
  176. custom_attrs: custom attribute
  177. **props: The props of the component.
  178. Returns:
  179. The component.
  180. """
  181. ...
  182. class XAxis(Axis):
  183. @overload
  184. @classmethod
  185. def create( # type: ignore
  186. cls,
  187. *children,
  188. orientation: Optional[
  189. Union[Literal["bottom", "top"], Var[Literal["bottom", "top"]]]
  190. ] = None,
  191. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  192. include_hidden: Optional[Union[Var[bool], bool]] = None,
  193. angle: Optional[Union[Var[int], int]] = None,
  194. padding: Optional[Union[Dict[str, int], Var[Dict[str, int]]]] = None,
  195. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  196. hide: Optional[Union[Var[bool], bool]] = None,
  197. width: Optional[Union[Var[Union[int, str]], int, str]] = None,
  198. height: Optional[Union[Var[Union[int, str]], int, str]] = None,
  199. type_: Optional[
  200. Union[Literal["category", "number"], Var[Literal["category", "number"]]]
  201. ] = None,
  202. interval: Optional[
  203. Union[
  204. Literal[
  205. "equidistantPreserveStart",
  206. "preserveEnd",
  207. "preserveStart",
  208. "preserveStartEnd",
  209. ],
  210. Var[
  211. Union[
  212. Literal[
  213. "equidistantPreserveStart",
  214. "preserveEnd",
  215. "preserveStart",
  216. "preserveStartEnd",
  217. ],
  218. int,
  219. ]
  220. ],
  221. int,
  222. ]
  223. ] = None,
  224. allow_decimals: Optional[Union[Var[bool], bool]] = None,
  225. allow_data_overflow: Optional[Union[Var[bool], bool]] = None,
  226. allow_duplicated_category: Optional[Union[Var[bool], bool]] = None,
  227. domain: Optional[Union[List, Var[List]]] = None,
  228. axis_line: Optional[Union[Var[bool], bool]] = None,
  229. mirror: Optional[Union[Var[bool], bool]] = None,
  230. reversed: Optional[Union[Var[bool], bool]] = None,
  231. label: Optional[
  232. Union[Dict[str, Any], Var[Union[Dict[str, Any], int, str]], int, str]
  233. ] = None,
  234. scale: Optional[
  235. Union[
  236. Literal[
  237. "auto",
  238. "band",
  239. "identity",
  240. "linear",
  241. "log",
  242. "ordinal",
  243. "point",
  244. "pow",
  245. "quantile",
  246. "quantize",
  247. "sequential",
  248. "sqrt",
  249. "threshold",
  250. "time",
  251. "utc",
  252. ],
  253. Var[
  254. Literal[
  255. "auto",
  256. "band",
  257. "identity",
  258. "linear",
  259. "log",
  260. "ordinal",
  261. "point",
  262. "pow",
  263. "quantile",
  264. "quantize",
  265. "sequential",
  266. "sqrt",
  267. "threshold",
  268. "time",
  269. "utc",
  270. ]
  271. ],
  272. ]
  273. ] = None,
  274. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  275. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  276. ticks: Optional[
  277. Union[List[Union[int, str]], Var[List[Union[int, str]]]]
  278. ] = None,
  279. tick: Optional[Union[Var[bool], bool]] = None,
  280. tick_count: Optional[Union[Var[int], int]] = None,
  281. tick_line: Optional[Union[Var[bool], bool]] = None,
  282. tick_size: Optional[Union[Var[int], int]] = None,
  283. min_tick_gap: Optional[Union[Var[int], int]] = None,
  284. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  285. text_anchor: Optional[
  286. Union[
  287. Literal["end", "middle", "start"],
  288. Var[Literal["end", "middle", "start"]],
  289. ]
  290. ] = None,
  291. style: Optional[Style] = None,
  292. key: Optional[Any] = None,
  293. id: Optional[Any] = None,
  294. class_name: Optional[Any] = None,
  295. autofocus: Optional[bool] = None,
  296. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  297. on_blur: Optional[EventType[()]] = None,
  298. on_click: Optional[EventType[()]] = None,
  299. on_context_menu: Optional[EventType[()]] = None,
  300. on_double_click: Optional[EventType[()]] = None,
  301. on_focus: Optional[EventType[()]] = None,
  302. on_mount: Optional[EventType[()]] = None,
  303. on_mouse_down: Optional[EventType[()]] = None,
  304. on_mouse_enter: Optional[EventType[()]] = None,
  305. on_mouse_leave: Optional[EventType[()]] = None,
  306. on_mouse_move: Optional[EventType[()]] = None,
  307. on_mouse_out: Optional[EventType[()]] = None,
  308. on_mouse_over: Optional[EventType[()]] = None,
  309. on_mouse_up: Optional[EventType[()]] = None,
  310. on_scroll: Optional[EventType[()]] = None,
  311. on_unmount: Optional[EventType[()]] = None,
  312. **props,
  313. ) -> "XAxis":
  314. """Create the component.
  315. Args:
  316. *children: The children of the component.
  317. orientation: The orientation of axis 'top' | 'bottom'. Default: "bottom"
  318. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  319. include_hidden: Ensures that all datapoints within a chart contribute to its domain calculation, even when they are hidden. Default: False
  320. angle: The angle of axis ticks. Default: 0
  321. padding: Specify the padding of x-axis. Default: {"left": 0, "right": 0}
  322. data_key: The key of data displayed in the axis.
  323. hide: If set true, the axis do not display in the chart. Default: False
  324. width: The width of axis which is usually calculated internally.
  325. height: The height of axis, which can be set by user.
  326. type_: The type of axis 'number' | 'category'
  327. interval: If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. Default: "preserveEnd"
  328. allow_decimals: Allow the ticks of Axis to be decimals or not. Default: True
  329. 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. Default: False
  330. allow_duplicated_category: Allow the axis has duplicated categorys or not when the type of axis is "category". Default: True
  331. domain: The range of the axis. Work best in conjunction with allow_data_overflow. Default: [0, "auto"]
  332. axis_line: If set false, no axis line will be drawn. Default: True
  333. mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. Default: False
  334. reversed: Reverse the ticks or not. Default: False
  335. label: The label of axis, which appears next to the axis.
  336. 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'. Default: "auto"
  337. unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
  338. name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
  339. ticks: Set the values of axis ticks manually.
  340. tick: If set false, no ticks will be drawn.
  341. tick_count: The count of axis ticks. Not used if 'type' is 'category'. Default: 5
  342. tick_line: If set false, no axis tick lines will be drawn. Default: True
  343. tick_size: The length of tick line. Default: 6
  344. min_tick_gap: The minimum gap between two adjacent labels. Default: 5
  345. stroke: The stroke color of axis. Default: rx.color("gray", 9)
  346. text_anchor: The text anchor of axis. Default: "middle"
  347. on_click: The customized event handler of click on the ticks of this axis
  348. on_mouse_down: The customized event handler of mousedown on the ticks of this axis
  349. on_mouse_up: The customized event handler of mouseup on the ticks of this axis
  350. on_mouse_move: The customized event handler of mousemove on the ticks of this axis
  351. on_mouse_out: The customized event handler of mouseout on the ticks of this axis
  352. on_mouse_enter: The customized event handler of mouseenter on the ticks of this axis
  353. on_mouse_leave: The customized event handler of mouseleave on the ticks of this axis
  354. style: The style of the component.
  355. key: A unique key for the component.
  356. id: The id for the component.
  357. class_name: The class name for the component.
  358. autofocus: Whether the component should take the focus once the page is loaded
  359. custom_attrs: custom attribute
  360. **props: The props of the component.
  361. Returns:
  362. The component.
  363. """
  364. ...
  365. class YAxis(Axis):
  366. @overload
  367. @classmethod
  368. def create( # type: ignore
  369. cls,
  370. *children,
  371. orientation: Optional[
  372. Union[Literal["left", "right"], Var[Literal["left", "right"]]]
  373. ] = None,
  374. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  375. padding: Optional[Union[Dict[str, int], Var[Dict[str, int]]]] = None,
  376. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  377. hide: Optional[Union[Var[bool], bool]] = None,
  378. width: Optional[Union[Var[Union[int, str]], int, str]] = None,
  379. height: Optional[Union[Var[Union[int, str]], int, str]] = None,
  380. type_: Optional[
  381. Union[Literal["category", "number"], Var[Literal["category", "number"]]]
  382. ] = None,
  383. interval: Optional[
  384. Union[
  385. Literal[
  386. "equidistantPreserveStart",
  387. "preserveEnd",
  388. "preserveStart",
  389. "preserveStartEnd",
  390. ],
  391. Var[
  392. Union[
  393. Literal[
  394. "equidistantPreserveStart",
  395. "preserveEnd",
  396. "preserveStart",
  397. "preserveStartEnd",
  398. ],
  399. int,
  400. ]
  401. ],
  402. int,
  403. ]
  404. ] = None,
  405. allow_decimals: Optional[Union[Var[bool], bool]] = None,
  406. allow_data_overflow: Optional[Union[Var[bool], bool]] = None,
  407. allow_duplicated_category: Optional[Union[Var[bool], bool]] = None,
  408. domain: Optional[Union[List, Var[List]]] = None,
  409. axis_line: Optional[Union[Var[bool], bool]] = None,
  410. mirror: Optional[Union[Var[bool], bool]] = None,
  411. reversed: Optional[Union[Var[bool], bool]] = None,
  412. label: Optional[
  413. Union[Dict[str, Any], Var[Union[Dict[str, Any], int, str]], int, str]
  414. ] = None,
  415. scale: Optional[
  416. Union[
  417. Literal[
  418. "auto",
  419. "band",
  420. "identity",
  421. "linear",
  422. "log",
  423. "ordinal",
  424. "point",
  425. "pow",
  426. "quantile",
  427. "quantize",
  428. "sequential",
  429. "sqrt",
  430. "threshold",
  431. "time",
  432. "utc",
  433. ],
  434. Var[
  435. Literal[
  436. "auto",
  437. "band",
  438. "identity",
  439. "linear",
  440. "log",
  441. "ordinal",
  442. "point",
  443. "pow",
  444. "quantile",
  445. "quantize",
  446. "sequential",
  447. "sqrt",
  448. "threshold",
  449. "time",
  450. "utc",
  451. ]
  452. ],
  453. ]
  454. ] = None,
  455. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  456. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  457. ticks: Optional[
  458. Union[List[Union[int, str]], Var[List[Union[int, str]]]]
  459. ] = None,
  460. tick: Optional[Union[Var[bool], bool]] = None,
  461. tick_count: Optional[Union[Var[int], int]] = None,
  462. tick_line: Optional[Union[Var[bool], bool]] = None,
  463. tick_size: Optional[Union[Var[int], int]] = None,
  464. min_tick_gap: Optional[Union[Var[int], int]] = None,
  465. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  466. text_anchor: Optional[
  467. Union[
  468. Literal["end", "middle", "start"],
  469. Var[Literal["end", "middle", "start"]],
  470. ]
  471. ] = None,
  472. style: Optional[Style] = None,
  473. key: Optional[Any] = None,
  474. id: Optional[Any] = None,
  475. class_name: Optional[Any] = None,
  476. autofocus: Optional[bool] = None,
  477. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  478. on_blur: Optional[EventType[()]] = None,
  479. on_click: Optional[EventType[()]] = None,
  480. on_context_menu: Optional[EventType[()]] = None,
  481. on_double_click: Optional[EventType[()]] = None,
  482. on_focus: Optional[EventType[()]] = None,
  483. on_mount: Optional[EventType[()]] = None,
  484. on_mouse_down: Optional[EventType[()]] = None,
  485. on_mouse_enter: Optional[EventType[()]] = None,
  486. on_mouse_leave: Optional[EventType[()]] = None,
  487. on_mouse_move: Optional[EventType[()]] = None,
  488. on_mouse_out: Optional[EventType[()]] = None,
  489. on_mouse_over: Optional[EventType[()]] = None,
  490. on_mouse_up: Optional[EventType[()]] = None,
  491. on_scroll: Optional[EventType[()]] = None,
  492. on_unmount: Optional[EventType[()]] = None,
  493. **props,
  494. ) -> "YAxis":
  495. """Create the component.
  496. Args:
  497. *children: The children of the component.
  498. orientation: The orientation of axis 'left' | 'right'. Default: "left"
  499. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  500. padding: Specify the padding of y-axis. Default: {"top": 0, "bottom": 0}
  501. data_key: The key of data displayed in the axis.
  502. hide: If set true, the axis do not display in the chart. Default: False
  503. width: The width of axis which is usually calculated internally.
  504. height: The height of axis, which can be set by user.
  505. type_: The type of axis 'number' | 'category'
  506. interval: If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. Default: "preserveEnd"
  507. allow_decimals: Allow the ticks of Axis to be decimals or not. Default: True
  508. 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. Default: False
  509. allow_duplicated_category: Allow the axis has duplicated categorys or not when the type of axis is "category". Default: True
  510. domain: The range of the axis. Work best in conjunction with allow_data_overflow. Default: [0, "auto"]
  511. axis_line: If set false, no axis line will be drawn. Default: True
  512. mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. Default: False
  513. reversed: Reverse the ticks or not. Default: False
  514. label: The label of axis, which appears next to the axis.
  515. 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'. Default: "auto"
  516. unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
  517. name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
  518. ticks: Set the values of axis ticks manually.
  519. tick: If set false, no ticks will be drawn.
  520. tick_count: The count of axis ticks. Not used if 'type' is 'category'. Default: 5
  521. tick_line: If set false, no axis tick lines will be drawn. Default: True
  522. tick_size: The length of tick line. Default: 6
  523. min_tick_gap: The minimum gap between two adjacent labels. Default: 5
  524. stroke: The stroke color of axis. Default: rx.color("gray", 9)
  525. text_anchor: The text anchor of axis. Default: "middle"
  526. on_click: The customized event handler of click on the ticks of this axis
  527. on_mouse_down: The customized event handler of mousedown on the ticks of this axis
  528. on_mouse_up: The customized event handler of mouseup on the ticks of this axis
  529. on_mouse_move: The customized event handler of mousemove on the ticks of this axis
  530. on_mouse_out: The customized event handler of mouseout on the ticks of this axis
  531. on_mouse_enter: The customized event handler of mouseenter on the ticks of this axis
  532. on_mouse_leave: The customized event handler of mouseleave on the ticks of this axis
  533. style: The style of the component.
  534. key: A unique key for the component.
  535. id: The id for the component.
  536. class_name: The class name for the component.
  537. autofocus: Whether the component should take the focus once the page is loaded
  538. custom_attrs: custom attribute
  539. **props: The props of the component.
  540. Returns:
  541. The component.
  542. """
  543. ...
  544. class ZAxis(Recharts):
  545. @overload
  546. @classmethod
  547. def create( # type: ignore
  548. cls,
  549. *children,
  550. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  551. z_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  552. range: Optional[Union[List[int], Var[List[int]]]] = None,
  553. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  554. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  555. scale: Optional[
  556. Union[
  557. Literal[
  558. "auto",
  559. "band",
  560. "identity",
  561. "linear",
  562. "log",
  563. "ordinal",
  564. "point",
  565. "pow",
  566. "quantile",
  567. "quantize",
  568. "sequential",
  569. "sqrt",
  570. "threshold",
  571. "time",
  572. "utc",
  573. ],
  574. Var[
  575. Literal[
  576. "auto",
  577. "band",
  578. "identity",
  579. "linear",
  580. "log",
  581. "ordinal",
  582. "point",
  583. "pow",
  584. "quantile",
  585. "quantize",
  586. "sequential",
  587. "sqrt",
  588. "threshold",
  589. "time",
  590. "utc",
  591. ]
  592. ],
  593. ]
  594. ] = None,
  595. style: Optional[Style] = None,
  596. key: Optional[Any] = None,
  597. id: Optional[Any] = None,
  598. class_name: Optional[Any] = None,
  599. autofocus: Optional[bool] = None,
  600. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  601. on_blur: Optional[EventType[()]] = None,
  602. on_click: Optional[EventType[()]] = None,
  603. on_context_menu: Optional[EventType[()]] = None,
  604. on_double_click: Optional[EventType[()]] = None,
  605. on_focus: Optional[EventType[()]] = None,
  606. on_mount: Optional[EventType[()]] = None,
  607. on_mouse_down: Optional[EventType[()]] = None,
  608. on_mouse_enter: Optional[EventType[()]] = None,
  609. on_mouse_leave: Optional[EventType[()]] = None,
  610. on_mouse_move: Optional[EventType[()]] = None,
  611. on_mouse_out: Optional[EventType[()]] = None,
  612. on_mouse_over: Optional[EventType[()]] = None,
  613. on_mouse_up: Optional[EventType[()]] = None,
  614. on_scroll: Optional[EventType[()]] = None,
  615. on_unmount: Optional[EventType[()]] = None,
  616. **props,
  617. ) -> "ZAxis":
  618. """Create the component.
  619. Args:
  620. *children: The children of the component.
  621. data_key: The key of data displayed in the axis.
  622. z_axis_id: The unique id of z-axis. Default: 0
  623. range: The range of axis. Default: [10, 10]
  624. unit: The unit of data displayed in the axis. This option will be used to represent an index unit in a scatter chart.
  625. name: The name of data displayed in the axis. This option will be used to represent an index in a scatter chart.
  626. scale: If 'auto' set, the scale function is decided by the type of chart, and the props type. Default: "auto"
  627. style: The style of the component.
  628. key: A unique key for the component.
  629. id: The id for the component.
  630. class_name: The class name for the component.
  631. autofocus: Whether the component should take the focus once the page is loaded
  632. custom_attrs: custom attribute
  633. **props: The props of the component.
  634. Returns:
  635. The component.
  636. """
  637. ...
  638. class Brush(Recharts):
  639. def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
  640. @overload
  641. @classmethod
  642. def create( # type: ignore
  643. cls,
  644. *children,
  645. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  646. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  647. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  648. x: Optional[Union[Var[int], int]] = None,
  649. y: Optional[Union[Var[int], int]] = None,
  650. width: Optional[Union[Var[int], int]] = None,
  651. height: Optional[Union[Var[int], int]] = None,
  652. data: Optional[Union[List[Any], Var[List[Any]]]] = None,
  653. traveller_width: Optional[Union[Var[int], int]] = None,
  654. gap: Optional[Union[Var[int], int]] = None,
  655. start_index: Optional[Union[Var[int], int]] = None,
  656. end_index: Optional[Union[Var[int], int]] = None,
  657. style: Optional[Style] = None,
  658. key: Optional[Any] = None,
  659. id: Optional[Any] = None,
  660. class_name: Optional[Any] = None,
  661. autofocus: Optional[bool] = None,
  662. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  663. on_change: Optional[EventType[()]] = None,
  664. **props,
  665. ) -> "Brush":
  666. """Create the component.
  667. Args:
  668. *children: The children of the component.
  669. stroke: The stroke color of brush
  670. fill: The fill color of brush
  671. data_key: The key of data displayed in the axis.
  672. x: The x-coordinate of brush. Default: 0
  673. y: The y-coordinate of brush. Default: 0
  674. width: The width of brush. Default: 0
  675. height: The height of brush. Default: 40
  676. data: The original data of a LineChart, a BarChart or an AreaChart.
  677. traveller_width: The width of each traveller. Default: 5
  678. gap: The data with gap of refreshing chart. If the option is not set, the chart will be refreshed every time. Default: 1
  679. start_index: The default start index of brush. If the option is not set, the start index will be 0. Default: 0
  680. end_index: The default end index of brush. If the option is not set, the end index will be calculated by the length of data.
  681. style: The style of the component.
  682. key: A unique key for the component.
  683. id: The id for the component.
  684. class_name: The class name for the component.
  685. autofocus: Whether the component should take the focus once the page is loaded
  686. custom_attrs: custom attribute
  687. **props: The props of the component.
  688. Returns:
  689. The component.
  690. """
  691. ...
  692. class Cartesian(Recharts):
  693. @overload
  694. @classmethod
  695. def create( # type: ignore
  696. cls,
  697. *children,
  698. layout: Optional[
  699. Union[
  700. Literal["horizontal", "vertical"],
  701. Var[Literal["horizontal", "vertical"]],
  702. ]
  703. ] = None,
  704. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  705. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  706. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  707. legend_type: Optional[
  708. Union[
  709. Literal[
  710. "circle",
  711. "cross",
  712. "diamond",
  713. "line",
  714. "none",
  715. "plainline",
  716. "rect",
  717. "square",
  718. "star",
  719. "triangle",
  720. "wye",
  721. ],
  722. Var[
  723. Literal[
  724. "circle",
  725. "cross",
  726. "diamond",
  727. "line",
  728. "none",
  729. "plainline",
  730. "rect",
  731. "square",
  732. "star",
  733. "triangle",
  734. "wye",
  735. ]
  736. ],
  737. ]
  738. ] = None,
  739. is_animation_active: Optional[Union[Var[bool], bool]] = None,
  740. animation_begin: Optional[Union[Var[int], int]] = None,
  741. animation_duration: Optional[Union[Var[int], int]] = None,
  742. animation_easing: Optional[
  743. Union[
  744. Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
  745. Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
  746. ]
  747. ] = None,
  748. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  749. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  750. style: Optional[Style] = None,
  751. key: Optional[Any] = None,
  752. id: Optional[Any] = None,
  753. class_name: Optional[Any] = None,
  754. autofocus: Optional[bool] = None,
  755. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  756. on_animation_end: Optional[EventType[()]] = None,
  757. on_animation_start: Optional[EventType[()]] = None,
  758. on_blur: Optional[EventType[()]] = None,
  759. on_click: Optional[EventType[()]] = None,
  760. on_context_menu: Optional[EventType[()]] = None,
  761. on_double_click: Optional[EventType[()]] = None,
  762. on_focus: Optional[EventType[()]] = None,
  763. on_mount: Optional[EventType[()]] = None,
  764. on_mouse_down: Optional[EventType[()]] = None,
  765. on_mouse_enter: Optional[EventType[()]] = None,
  766. on_mouse_leave: Optional[EventType[()]] = None,
  767. on_mouse_move: Optional[EventType[()]] = None,
  768. on_mouse_out: Optional[EventType[()]] = None,
  769. on_mouse_over: Optional[EventType[()]] = None,
  770. on_mouse_up: Optional[EventType[()]] = None,
  771. on_scroll: Optional[EventType[()]] = None,
  772. on_unmount: Optional[EventType[()]] = None,
  773. **props,
  774. ) -> "Cartesian":
  775. """Create the component.
  776. Args:
  777. *children: The children of the component.
  778. layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
  779. data_key: The key of a group of data which should be unique in an area chart.
  780. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  781. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  782. 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
  783. is_animation_active: If set false, animation of bar will be disabled. Default: True
  784. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
  785. animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
  786. animation_easing: The type of easing function. Default: "ease"
  787. unit: The unit of data. This option will be used in tooltip.
  788. name: The name of data. This option will be used in tooltip and legend to represent the component. If no value was set to this option, the value of dataKey will be used alternatively.
  789. on_animation_start: The customized event handler of animation start
  790. on_animation_end: The customized event handler of animation end
  791. on_click: The customized event handler of click on the component in this group
  792. on_mouse_down: The customized event handler of mousedown on the component in this group
  793. on_mouse_up: The customized event handler of mouseup on the component in this group
  794. on_mouse_move: The customized event handler of mousemove on the component in this group
  795. on_mouse_over: The customized event handler of mouseover on the component in this group
  796. on_mouse_out: The customized event handler of mouseout on the component in this group
  797. on_mouse_enter: The customized event handler of mouseenter on the component in this group
  798. on_mouse_leave: The customized event handler of mouseleave on the component in this group
  799. style: The style of the component.
  800. key: A unique key for the component.
  801. id: The id for the component.
  802. class_name: The class name for the component.
  803. autofocus: Whether the component should take the focus once the page is loaded
  804. custom_attrs: custom attribute
  805. **props: The props of the component.
  806. Returns:
  807. The component.
  808. """
  809. ...
  810. class Area(Cartesian):
  811. @overload
  812. @classmethod
  813. def create( # type: ignore
  814. cls,
  815. *children,
  816. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  817. stroke_width: Optional[Union[Var[int], int]] = None,
  818. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  819. type_: Optional[
  820. Union[
  821. Literal[
  822. "basis",
  823. "basisClosed",
  824. "basisOpen",
  825. "bump",
  826. "bumpX",
  827. "bumpY",
  828. "linear",
  829. "linearClosed",
  830. "monotone",
  831. "monotoneX",
  832. "monotoneY",
  833. "natural",
  834. "step",
  835. "stepAfter",
  836. "stepBefore",
  837. ],
  838. Var[
  839. Literal[
  840. "basis",
  841. "basisClosed",
  842. "basisOpen",
  843. "bump",
  844. "bumpX",
  845. "bumpY",
  846. "linear",
  847. "linearClosed",
  848. "monotone",
  849. "monotoneX",
  850. "monotoneY",
  851. "natural",
  852. "step",
  853. "stepAfter",
  854. "stepBefore",
  855. ]
  856. ],
  857. ]
  858. ] = None,
  859. dot: Optional[
  860. Union[Dict[str, Any], Var[Union[Dict[str, Any], bool]], bool]
  861. ] = None,
  862. active_dot: Optional[
  863. Union[Dict[str, Any], Var[Union[Dict[str, Any], bool]], bool]
  864. ] = None,
  865. label: Optional[Union[Var[bool], bool]] = None,
  866. base_line: Optional[
  867. Union[List[Dict[str, Any]], Var[Union[List[Dict[str, Any]], str]], str]
  868. ] = None,
  869. points: Optional[Union[List[Dict[str, Any]], Var[List[Dict[str, Any]]]]] = None,
  870. stack_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  871. connect_nulls: Optional[Union[Var[bool], bool]] = None,
  872. layout: Optional[
  873. Union[
  874. Literal["horizontal", "vertical"],
  875. Var[Literal["horizontal", "vertical"]],
  876. ]
  877. ] = None,
  878. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  879. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  880. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  881. legend_type: Optional[
  882. Union[
  883. Literal[
  884. "circle",
  885. "cross",
  886. "diamond",
  887. "line",
  888. "none",
  889. "plainline",
  890. "rect",
  891. "square",
  892. "star",
  893. "triangle",
  894. "wye",
  895. ],
  896. Var[
  897. Literal[
  898. "circle",
  899. "cross",
  900. "diamond",
  901. "line",
  902. "none",
  903. "plainline",
  904. "rect",
  905. "square",
  906. "star",
  907. "triangle",
  908. "wye",
  909. ]
  910. ],
  911. ]
  912. ] = None,
  913. is_animation_active: Optional[Union[Var[bool], bool]] = None,
  914. animation_begin: Optional[Union[Var[int], int]] = None,
  915. animation_duration: Optional[Union[Var[int], int]] = None,
  916. animation_easing: Optional[
  917. Union[
  918. Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
  919. Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
  920. ]
  921. ] = None,
  922. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  923. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  924. style: Optional[Style] = None,
  925. key: Optional[Any] = None,
  926. id: Optional[Any] = None,
  927. class_name: Optional[Any] = None,
  928. autofocus: Optional[bool] = None,
  929. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  930. on_animation_end: Optional[EventType[()]] = None,
  931. on_animation_start: Optional[EventType[()]] = None,
  932. on_blur: Optional[EventType[()]] = None,
  933. on_click: Optional[EventType[()]] = None,
  934. on_context_menu: Optional[EventType[()]] = None,
  935. on_double_click: Optional[EventType[()]] = None,
  936. on_focus: Optional[EventType[()]] = None,
  937. on_mount: Optional[EventType[()]] = None,
  938. on_mouse_down: Optional[EventType[()]] = None,
  939. on_mouse_enter: Optional[EventType[()]] = None,
  940. on_mouse_leave: Optional[EventType[()]] = None,
  941. on_mouse_move: Optional[EventType[()]] = None,
  942. on_mouse_out: Optional[EventType[()]] = None,
  943. on_mouse_over: Optional[EventType[()]] = None,
  944. on_mouse_up: Optional[EventType[()]] = None,
  945. on_scroll: Optional[EventType[()]] = None,
  946. on_unmount: Optional[EventType[()]] = None,
  947. **props,
  948. ) -> "Area":
  949. """Create the component.
  950. Args:
  951. *children: The children of the component.
  952. stroke: The color of the line stroke. Default: rx.color("accent", 9)
  953. stroke_width: The width of the line stroke. Default: 1
  954. fill: The color of the area fill. Default: rx.color("accent", 5)
  955. 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'. Default: "monotone"
  956. dot: If false set, dots will not be drawn. If true set, dots will be drawn which have the props calculated internally. Default: False
  957. active_dot: The dot is shown when user enter an area chart and this chart has tooltip. If false set, no active dot will not be drawn. If true set, active dot will be drawn which have the props calculated internally. Default: {stroke: rx.color("accent", 2), fill: rx.color("accent", 10)}
  958. label: If set false, labels will not be drawn. If set true, labels will be drawn which have the props calculated internally. Default: False
  959. base_line: The value which can describle the line, usually calculated internally.
  960. points: The coordinates of all the points in the area, usually calculated internally.
  961. 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.
  962. connect_nulls: Whether to connect a graph area across null points. Default: False
  963. layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
  964. data_key: The key of a group of data which should be unique in an area chart.
  965. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  966. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  967. 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
  968. is_animation_active: If set false, animation of bar will be disabled. Default: True
  969. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
  970. animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
  971. animation_easing: The type of easing function. Default: "ease"
  972. unit: The unit of data. This option will be used in tooltip.
  973. name: The name of data. This option will be used in tooltip and legend to represent the component. If no value was set to this option, the value of dataKey will be used alternatively.
  974. on_animation_start: The customized event handler of animation start
  975. on_animation_end: The customized event handler of animation end
  976. on_click: The customized event handler of click on the component in this group
  977. on_mouse_down: The customized event handler of mousedown on the component in this group
  978. on_mouse_up: The customized event handler of mouseup on the component in this group
  979. on_mouse_move: The customized event handler of mousemove on the component in this group
  980. on_mouse_over: The customized event handler of mouseover on the component in this group
  981. on_mouse_out: The customized event handler of mouseout on the component in this group
  982. on_mouse_enter: The customized event handler of mouseenter on the component in this group
  983. on_mouse_leave: The customized event handler of mouseleave on the component in this group
  984. style: The style of the component.
  985. key: A unique key for the component.
  986. id: The id for the component.
  987. class_name: The class name for the component.
  988. autofocus: Whether the component should take the focus once the page is loaded
  989. custom_attrs: custom attribute
  990. **props: The props of the component.
  991. Returns:
  992. The component.
  993. """
  994. ...
  995. class Bar(Cartesian):
  996. @overload
  997. @classmethod
  998. def create( # type: ignore
  999. cls,
  1000. *children,
  1001. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1002. stroke_width: Optional[Union[Var[int], int]] = None,
  1003. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1004. background: Optional[Union[Var[bool], bool]] = None,
  1005. label: Optional[Union[Var[bool], bool]] = None,
  1006. stack_id: Optional[Union[Var[str], str]] = None,
  1007. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1008. min_point_size: Optional[Union[Var[int], int]] = None,
  1009. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1010. bar_size: Optional[Union[Var[int], int]] = None,
  1011. max_bar_size: Optional[Union[Var[int], int]] = None,
  1012. radius: Optional[Union[List[int], Var[Union[List[int], int]], int]] = None,
  1013. layout: Optional[
  1014. Union[
  1015. Literal["horizontal", "vertical"],
  1016. Var[Literal["horizontal", "vertical"]],
  1017. ]
  1018. ] = None,
  1019. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1020. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1021. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1022. legend_type: Optional[
  1023. Union[
  1024. Literal[
  1025. "circle",
  1026. "cross",
  1027. "diamond",
  1028. "line",
  1029. "none",
  1030. "plainline",
  1031. "rect",
  1032. "square",
  1033. "star",
  1034. "triangle",
  1035. "wye",
  1036. ],
  1037. Var[
  1038. Literal[
  1039. "circle",
  1040. "cross",
  1041. "diamond",
  1042. "line",
  1043. "none",
  1044. "plainline",
  1045. "rect",
  1046. "square",
  1047. "star",
  1048. "triangle",
  1049. "wye",
  1050. ]
  1051. ],
  1052. ]
  1053. ] = None,
  1054. is_animation_active: Optional[Union[Var[bool], bool]] = None,
  1055. animation_begin: Optional[Union[Var[int], int]] = None,
  1056. animation_duration: Optional[Union[Var[int], int]] = None,
  1057. animation_easing: Optional[
  1058. Union[
  1059. Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
  1060. Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
  1061. ]
  1062. ] = None,
  1063. style: Optional[Style] = None,
  1064. key: Optional[Any] = None,
  1065. id: Optional[Any] = None,
  1066. class_name: Optional[Any] = None,
  1067. autofocus: Optional[bool] = None,
  1068. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1069. on_animation_end: Optional[EventType[()]] = None,
  1070. on_animation_start: Optional[EventType[()]] = None,
  1071. on_blur: Optional[EventType[()]] = None,
  1072. on_click: Optional[EventType[()]] = None,
  1073. on_context_menu: Optional[EventType[()]] = None,
  1074. on_double_click: Optional[EventType[()]] = None,
  1075. on_focus: Optional[EventType[()]] = None,
  1076. on_mount: Optional[EventType[()]] = None,
  1077. on_mouse_down: Optional[EventType[()]] = None,
  1078. on_mouse_enter: Optional[EventType[()]] = None,
  1079. on_mouse_leave: Optional[EventType[()]] = None,
  1080. on_mouse_move: Optional[EventType[()]] = None,
  1081. on_mouse_out: Optional[EventType[()]] = None,
  1082. on_mouse_over: Optional[EventType[()]] = None,
  1083. on_mouse_up: Optional[EventType[()]] = None,
  1084. on_scroll: Optional[EventType[()]] = None,
  1085. on_unmount: Optional[EventType[()]] = None,
  1086. **props,
  1087. ) -> "Bar":
  1088. """Create the component.
  1089. Args:
  1090. *children: The children of the component.
  1091. stroke: The color of the line stroke.
  1092. stroke_width: The width of the line stroke.
  1093. fill: The width of the line stroke. Default: Color("accent", 9)
  1094. 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. Default: False
  1095. label: If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally. Default: False
  1096. 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.
  1097. unit: The unit of data. This option will be used in tooltip.
  1098. 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.
  1099. name: The name of data. This option will be used in tooltip and legend to represent the component. If no value was set to this option, the value of dataKey will be used alternatively.
  1100. bar_size: Size of the bar (if one bar_size is set then a bar_size must be set for all bars)
  1101. max_bar_size: Max size of the bar
  1102. radius: If set a value, the option is the radius of all the rounded corners. If set a array, the option are in turn the radiuses of top-left corner, top-right corner, bottom-right corner, bottom-left corner. Default: 0
  1103. layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
  1104. data_key: The key of a group of data which should be unique in an area chart.
  1105. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  1106. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  1107. 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
  1108. is_animation_active: If set false, animation of bar will be disabled. Default: True
  1109. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
  1110. animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
  1111. animation_easing: The type of easing function. Default: "ease"
  1112. on_animation_start: The customized event handler of animation start
  1113. on_animation_end: The customized event handler of animation end
  1114. on_click: The customized event handler of click on the component in this group
  1115. on_mouse_down: The customized event handler of mousedown on the component in this group
  1116. on_mouse_up: The customized event handler of mouseup on the component in this group
  1117. on_mouse_move: The customized event handler of mousemove on the component in this group
  1118. on_mouse_over: The customized event handler of mouseover on the component in this group
  1119. on_mouse_out: The customized event handler of mouseout on the component in this group
  1120. on_mouse_enter: The customized event handler of mouseenter on the component in this group
  1121. on_mouse_leave: The customized event handler of mouseleave on the component in this group
  1122. style: The style of the component.
  1123. key: A unique key for the component.
  1124. id: The id for the component.
  1125. class_name: The class name for the component.
  1126. autofocus: Whether the component should take the focus once the page is loaded
  1127. custom_attrs: custom attribute
  1128. **props: The props of the component.
  1129. Returns:
  1130. The component.
  1131. """
  1132. ...
  1133. class Line(Cartesian):
  1134. @overload
  1135. @classmethod
  1136. def create( # type: ignore
  1137. cls,
  1138. *children,
  1139. type_: Optional[
  1140. Union[
  1141. Literal[
  1142. "basis",
  1143. "basisClosed",
  1144. "basisOpen",
  1145. "bump",
  1146. "bumpX",
  1147. "bumpY",
  1148. "linear",
  1149. "linearClosed",
  1150. "monotone",
  1151. "monotoneX",
  1152. "monotoneY",
  1153. "natural",
  1154. "step",
  1155. "stepAfter",
  1156. "stepBefore",
  1157. ],
  1158. Var[
  1159. Literal[
  1160. "basis",
  1161. "basisClosed",
  1162. "basisOpen",
  1163. "bump",
  1164. "bumpX",
  1165. "bumpY",
  1166. "linear",
  1167. "linearClosed",
  1168. "monotone",
  1169. "monotoneX",
  1170. "monotoneY",
  1171. "natural",
  1172. "step",
  1173. "stepAfter",
  1174. "stepBefore",
  1175. ]
  1176. ],
  1177. ]
  1178. ] = None,
  1179. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1180. stroke_width: Optional[Union[Var[int], int]] = None,
  1181. dot: Optional[
  1182. Union[Dict[str, Any], Var[Union[Dict[str, Any], bool]], bool]
  1183. ] = None,
  1184. active_dot: Optional[
  1185. Union[Dict[str, Any], Var[Union[Dict[str, Any], bool]], bool]
  1186. ] = None,
  1187. label: Optional[Union[Var[bool], bool]] = None,
  1188. hide: Optional[Union[Var[bool], bool]] = None,
  1189. connect_nulls: Optional[Union[Var[bool], bool]] = None,
  1190. unit: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1191. points: Optional[Union[List[Dict[str, Any]], Var[List[Dict[str, Any]]]]] = None,
  1192. stroke_dasharray: Optional[Union[Var[str], str]] = None,
  1193. layout: Optional[
  1194. Union[
  1195. Literal["horizontal", "vertical"],
  1196. Var[Literal["horizontal", "vertical"]],
  1197. ]
  1198. ] = None,
  1199. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1200. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1201. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1202. legend_type: Optional[
  1203. Union[
  1204. Literal[
  1205. "circle",
  1206. "cross",
  1207. "diamond",
  1208. "line",
  1209. "none",
  1210. "plainline",
  1211. "rect",
  1212. "square",
  1213. "star",
  1214. "triangle",
  1215. "wye",
  1216. ],
  1217. Var[
  1218. Literal[
  1219. "circle",
  1220. "cross",
  1221. "diamond",
  1222. "line",
  1223. "none",
  1224. "plainline",
  1225. "rect",
  1226. "square",
  1227. "star",
  1228. "triangle",
  1229. "wye",
  1230. ]
  1231. ],
  1232. ]
  1233. ] = None,
  1234. is_animation_active: Optional[Union[Var[bool], bool]] = None,
  1235. animation_begin: Optional[Union[Var[int], int]] = None,
  1236. animation_duration: Optional[Union[Var[int], int]] = None,
  1237. animation_easing: Optional[
  1238. Union[
  1239. Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
  1240. Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
  1241. ]
  1242. ] = None,
  1243. name: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1244. style: Optional[Style] = None,
  1245. key: Optional[Any] = None,
  1246. id: Optional[Any] = None,
  1247. class_name: Optional[Any] = None,
  1248. autofocus: Optional[bool] = None,
  1249. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1250. on_animation_end: Optional[EventType[()]] = None,
  1251. on_animation_start: Optional[EventType[()]] = None,
  1252. on_blur: Optional[EventType[()]] = None,
  1253. on_click: Optional[EventType[()]] = None,
  1254. on_context_menu: Optional[EventType[()]] = None,
  1255. on_double_click: Optional[EventType[()]] = None,
  1256. on_focus: Optional[EventType[()]] = None,
  1257. on_mount: Optional[EventType[()]] = None,
  1258. on_mouse_down: Optional[EventType[()]] = None,
  1259. on_mouse_enter: Optional[EventType[()]] = None,
  1260. on_mouse_leave: Optional[EventType[()]] = None,
  1261. on_mouse_move: Optional[EventType[()]] = None,
  1262. on_mouse_out: Optional[EventType[()]] = None,
  1263. on_mouse_over: Optional[EventType[()]] = None,
  1264. on_mouse_up: Optional[EventType[()]] = None,
  1265. on_scroll: Optional[EventType[()]] = None,
  1266. on_unmount: Optional[EventType[()]] = None,
  1267. **props,
  1268. ) -> "Line":
  1269. """Create the component.
  1270. Args:
  1271. *children: The children of the component.
  1272. type_: The interpolation type of line. And customized interpolation function can be set to type. It's the same as type in Area.
  1273. stroke: The color of the line stroke. Default: rx.color("accent", 9)
  1274. stroke_width: The width of the line stroke. Default: 1
  1275. dot: The dot is shown when mouse enter a line chart and this chart has tooltip. If false set, no active dot will not be drawn. If true set, active dot will be drawn which have the props calculated internally. Default: {"stroke": rx.color("accent", 10), "fill": rx.color("accent", 4)}
  1276. active_dot: The dot is shown when user enter an area chart and this chart has tooltip. If false set, no active dot will not be drawn. If true set, active dot will be drawn which have the props calculated internally. Default: {"stroke": rx.color("accent", 2), "fill": rx.color("accent", 10)}
  1277. label: If false set, labels will not be drawn. If true set, labels will be drawn which have the props calculated internally. Default: False
  1278. hide: Hides the line when true, useful when toggling visibility state via legend. Default: False
  1279. connect_nulls: Whether to connect a graph line across null points.
  1280. unit: The unit of data. This option will be used in tooltip.
  1281. points: The coordinates of all the points in the line, usually calculated internally.
  1282. stroke_dasharray: The pattern of dashes and gaps used to paint the line.
  1283. layout: The layout of bar in the chart, usually inherited from parent. 'horizontal' | 'vertical'
  1284. data_key: The key of a group of data which should be unique in an area chart.
  1285. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  1286. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  1287. 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
  1288. is_animation_active: If set false, animation of bar will be disabled. Default: True
  1289. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
  1290. animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
  1291. animation_easing: The type of easing function. Default: "ease"
  1292. name: The name of data. This option will be used in tooltip and legend to represent the component. If no value was set to this option, the value of dataKey will be used alternatively.
  1293. on_animation_start: The customized event handler of animation start
  1294. on_animation_end: The customized event handler of animation end
  1295. on_click: The customized event handler of click on the component in this group
  1296. on_mouse_down: The customized event handler of mousedown on the component in this group
  1297. on_mouse_up: The customized event handler of mouseup on the component in this group
  1298. on_mouse_move: The customized event handler of mousemove on the component in this group
  1299. on_mouse_over: The customized event handler of mouseover on the component in this group
  1300. on_mouse_out: The customized event handler of mouseout on the component in this group
  1301. on_mouse_enter: The customized event handler of mouseenter on the component in this group
  1302. on_mouse_leave: The customized event handler of mouseleave on the component in this group
  1303. style: The style of the component.
  1304. key: A unique key for the component.
  1305. id: The id for the component.
  1306. class_name: The class name for the component.
  1307. autofocus: Whether the component should take the focus once the page is loaded
  1308. custom_attrs: custom attribute
  1309. **props: The props of the component.
  1310. Returns:
  1311. The component.
  1312. """
  1313. ...
  1314. class Scatter(Recharts):
  1315. @overload
  1316. @classmethod
  1317. def create( # type: ignore
  1318. cls,
  1319. *children,
  1320. data: Optional[Union[List[Dict[str, Any]], Var[List[Dict[str, Any]]]]] = None,
  1321. legend_type: Optional[
  1322. Union[
  1323. Literal[
  1324. "circle",
  1325. "cross",
  1326. "diamond",
  1327. "line",
  1328. "none",
  1329. "plainline",
  1330. "rect",
  1331. "square",
  1332. "star",
  1333. "triangle",
  1334. "wye",
  1335. ],
  1336. Var[
  1337. Literal[
  1338. "circle",
  1339. "cross",
  1340. "diamond",
  1341. "line",
  1342. "none",
  1343. "plainline",
  1344. "rect",
  1345. "square",
  1346. "star",
  1347. "triangle",
  1348. "wye",
  1349. ]
  1350. ],
  1351. ]
  1352. ] = None,
  1353. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1354. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1355. z_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1356. line: Optional[Union[Var[bool], bool]] = None,
  1357. shape: Optional[
  1358. Union[
  1359. Literal[
  1360. "circle", "cross", "diamond", "square", "star", "triangle", "wye"
  1361. ],
  1362. Var[
  1363. Literal[
  1364. "circle",
  1365. "cross",
  1366. "diamond",
  1367. "square",
  1368. "star",
  1369. "triangle",
  1370. "wye",
  1371. ]
  1372. ],
  1373. ]
  1374. ] = None,
  1375. line_type: Optional[
  1376. Union[Literal["fitting", "joint"], Var[Literal["fitting", "joint"]]]
  1377. ] = None,
  1378. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1379. is_animation_active: Optional[Union[Var[bool], bool]] = None,
  1380. animation_begin: Optional[Union[Var[int], int]] = None,
  1381. animation_duration: Optional[Union[Var[int], int]] = None,
  1382. animation_easing: Optional[
  1383. Union[
  1384. Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
  1385. Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
  1386. ]
  1387. ] = None,
  1388. style: Optional[Style] = None,
  1389. key: Optional[Any] = None,
  1390. id: Optional[Any] = None,
  1391. class_name: Optional[Any] = None,
  1392. autofocus: Optional[bool] = None,
  1393. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1394. on_blur: Optional[EventType[()]] = None,
  1395. on_click: Optional[EventType[()]] = None,
  1396. on_context_menu: Optional[EventType[()]] = None,
  1397. on_double_click: Optional[EventType[()]] = None,
  1398. on_focus: Optional[EventType[()]] = None,
  1399. on_mount: Optional[EventType[()]] = None,
  1400. on_mouse_down: Optional[EventType[()]] = None,
  1401. on_mouse_enter: Optional[EventType[()]] = None,
  1402. on_mouse_leave: Optional[EventType[()]] = None,
  1403. on_mouse_move: Optional[EventType[()]] = None,
  1404. on_mouse_out: Optional[EventType[()]] = None,
  1405. on_mouse_over: Optional[EventType[()]] = None,
  1406. on_mouse_up: Optional[EventType[()]] = None,
  1407. on_scroll: Optional[EventType[()]] = None,
  1408. on_unmount: Optional[EventType[()]] = None,
  1409. **props,
  1410. ) -> "Scatter":
  1411. """Create the component.
  1412. Args:
  1413. *children: The children of the component.
  1414. data: The source data, in which each element is an object.
  1415. 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'. Default: "circle"
  1416. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  1417. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  1418. z_axis_id: The id of z-axis which is corresponding to the data. Default: 0
  1419. line: If false set, line will not be drawn. If true set, line will be drawn which have the props calculated internally. Default: False
  1420. shape: If a string set, specified symbol will be used to show scatter item. 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye'. Default: "circle"
  1421. 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'. Default: "joint"
  1422. fill: The fill color of the scatter. Default: rx.color("accent", 9)
  1423. is_animation_active: If set false, animation of bar will be disabled. Default: True in CSR, False in SSR
  1424. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
  1425. animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
  1426. animation_easing: The type of easing function. Default: "ease"
  1427. on_click: The customized event handler of click on the component in this group
  1428. on_mouse_down: The customized event handler of mousedown on the component in this group
  1429. on_mouse_up: The customized event handler of mouseup on the component in this group
  1430. on_mouse_move: The customized event handler of mousemove on the component in this group
  1431. on_mouse_over: The customized event handler of mouseover on the component in this group
  1432. on_mouse_out: The customized event handler of mouseout on the component in this group
  1433. on_mouse_enter: The customized event handler of mouseenter on the component in this group
  1434. on_mouse_leave: The customized event handler of mouseleave on the component in this group
  1435. style: The style of the component.
  1436. key: A unique key for the component.
  1437. id: The id for the component.
  1438. class_name: The class name for the component.
  1439. autofocus: Whether the component should take the focus once the page is loaded
  1440. custom_attrs: custom attribute
  1441. **props: The props of the component.
  1442. Returns:
  1443. The component.
  1444. """
  1445. ...
  1446. class Funnel(Recharts):
  1447. @overload
  1448. @classmethod
  1449. def create( # type: ignore
  1450. cls,
  1451. *children,
  1452. data: Optional[Union[List[Dict[str, Any]], Var[List[Dict[str, Any]]]]] = None,
  1453. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1454. name_key: Optional[Union[Var[str], str]] = None,
  1455. legend_type: Optional[
  1456. Union[
  1457. Literal[
  1458. "circle",
  1459. "cross",
  1460. "diamond",
  1461. "line",
  1462. "none",
  1463. "plainline",
  1464. "rect",
  1465. "square",
  1466. "star",
  1467. "triangle",
  1468. "wye",
  1469. ],
  1470. Var[
  1471. Literal[
  1472. "circle",
  1473. "cross",
  1474. "diamond",
  1475. "line",
  1476. "none",
  1477. "plainline",
  1478. "rect",
  1479. "square",
  1480. "star",
  1481. "triangle",
  1482. "wye",
  1483. ]
  1484. ],
  1485. ]
  1486. ] = None,
  1487. is_animation_active: Optional[Union[Var[bool], bool]] = None,
  1488. animation_begin: Optional[Union[Var[int], int]] = None,
  1489. animation_duration: Optional[Union[Var[int], int]] = None,
  1490. animation_easing: Optional[
  1491. Union[
  1492. Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"],
  1493. Var[Literal["ease", "ease-in", "ease-in-out", "ease-out", "linear"]],
  1494. ]
  1495. ] = None,
  1496. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1497. trapezoids: Optional[
  1498. Union[List[Dict[str, Any]], Var[List[Dict[str, Any]]]]
  1499. ] = None,
  1500. style: Optional[Style] = None,
  1501. key: Optional[Any] = None,
  1502. id: Optional[Any] = None,
  1503. class_name: Optional[Any] = None,
  1504. autofocus: Optional[bool] = None,
  1505. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1506. on_animation_end: Optional[EventType[()]] = None,
  1507. on_animation_start: Optional[EventType[()]] = None,
  1508. on_blur: Optional[EventType[()]] = None,
  1509. on_click: Optional[EventType[()]] = None,
  1510. on_context_menu: Optional[EventType[()]] = None,
  1511. on_double_click: Optional[EventType[()]] = None,
  1512. on_focus: Optional[EventType[()]] = None,
  1513. on_mount: Optional[EventType[()]] = None,
  1514. on_mouse_down: Optional[EventType[()]] = None,
  1515. on_mouse_enter: Optional[EventType[()]] = None,
  1516. on_mouse_leave: Optional[EventType[()]] = None,
  1517. on_mouse_move: Optional[EventType[()]] = None,
  1518. on_mouse_out: Optional[EventType[()]] = None,
  1519. on_mouse_over: Optional[EventType[()]] = None,
  1520. on_mouse_up: Optional[EventType[()]] = None,
  1521. on_scroll: Optional[EventType[()]] = None,
  1522. on_unmount: Optional[EventType[()]] = None,
  1523. **props,
  1524. ) -> "Funnel":
  1525. """Create the component.
  1526. Args:
  1527. *children: The children of the component.
  1528. data: The source data, in which each element is an object.
  1529. data_key: The key or getter of a group of data which should be unique in a FunnelChart.
  1530. name_key: The key of each sector's name. Default: "name"
  1531. legend_type: The type of icon in legend. If set to 'none', no legend item will be rendered. Default: "line"
  1532. is_animation_active: If set false, animation of line will be disabled. Default: True
  1533. animation_begin: Specifies when the animation should begin, the unit of this option is ms. Default: 0
  1534. animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
  1535. animation_easing: The type of easing function. 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear'. Default "ease"
  1536. stroke: Stroke color. Default: rx.color("gray", 3)
  1537. trapezoids: The coordinates of all the trapezoids in the funnel, usually calculated internally.
  1538. on_animation_start: The customized event handler of animation start
  1539. on_animation_end: The customized event handler of animation end
  1540. on_click: The customized event handler of click on the component in this group
  1541. on_mouse_down: The customized event handler of mousedown on the component in this group
  1542. on_mouse_up: The customized event handler of mouseup on the component in this group
  1543. on_mouse_move: The customized event handler of mousemove on the component in this group
  1544. on_mouse_over: The customized event handler of mouseover on the component in this group
  1545. on_mouse_out: The customized event handler of mouseout on the component in this group
  1546. on_mouse_enter: The customized event handler of mouseenter on the component in this group
  1547. on_mouse_leave: The customized event handler of mouseleave on the component in this group
  1548. style: The style of the component.
  1549. key: A unique key for the component.
  1550. id: The id for the component.
  1551. class_name: The class name for the component.
  1552. autofocus: Whether the component should take the focus once the page is loaded
  1553. custom_attrs: custom attribute
  1554. **props: The props of the component.
  1555. Returns:
  1556. The component.
  1557. """
  1558. ...
  1559. class ErrorBar(Recharts):
  1560. @overload
  1561. @classmethod
  1562. def create( # type: ignore
  1563. cls,
  1564. *children,
  1565. direction: Optional[Union[Literal["x", "y"], Var[Literal["x", "y"]]]] = None,
  1566. data_key: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1567. width: Optional[Union[Var[int], int]] = None,
  1568. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1569. stroke_width: Optional[Union[Var[Union[float, int]], float, int]] = None,
  1570. style: Optional[Style] = None,
  1571. key: Optional[Any] = None,
  1572. id: Optional[Any] = None,
  1573. class_name: Optional[Any] = None,
  1574. autofocus: Optional[bool] = None,
  1575. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1576. on_blur: Optional[EventType[()]] = None,
  1577. on_click: Optional[EventType[()]] = None,
  1578. on_context_menu: Optional[EventType[()]] = None,
  1579. on_double_click: Optional[EventType[()]] = None,
  1580. on_focus: Optional[EventType[()]] = None,
  1581. on_mount: Optional[EventType[()]] = None,
  1582. on_mouse_down: Optional[EventType[()]] = None,
  1583. on_mouse_enter: Optional[EventType[()]] = None,
  1584. on_mouse_leave: Optional[EventType[()]] = None,
  1585. on_mouse_move: Optional[EventType[()]] = None,
  1586. on_mouse_out: Optional[EventType[()]] = None,
  1587. on_mouse_over: Optional[EventType[()]] = None,
  1588. on_mouse_up: Optional[EventType[()]] = None,
  1589. on_scroll: Optional[EventType[()]] = None,
  1590. on_unmount: Optional[EventType[()]] = None,
  1591. **props,
  1592. ) -> "ErrorBar":
  1593. """Create the component.
  1594. Args:
  1595. *children: The children of the component.
  1596. direction: Only used for ScatterChart with error bars in two directions. Only accepts a value of "x" or "y" and makes the error bars lie in that direction.
  1597. data_key: The key of a group of data which should be unique in an area chart.
  1598. width: The width of the error bar ends. Default: 5
  1599. stroke: The stroke color of error bar. Default: rx.color("gray", 8)
  1600. stroke_width: The stroke width of error bar. Default: 1.5
  1601. style: The style of the component.
  1602. key: A unique key for the component.
  1603. id: The id for the component.
  1604. class_name: The class name for the component.
  1605. autofocus: Whether the component should take the focus once the page is loaded
  1606. custom_attrs: custom attribute
  1607. **props: The props of the component.
  1608. Returns:
  1609. The component.
  1610. """
  1611. ...
  1612. class Reference(Recharts):
  1613. @overload
  1614. @classmethod
  1615. def create( # type: ignore
  1616. cls,
  1617. *children,
  1618. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1619. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1620. if_overflow: Optional[
  1621. Union[
  1622. Literal["discard", "extendDomain", "hidden", "visible"],
  1623. Var[Literal["discard", "extendDomain", "hidden", "visible"]],
  1624. ]
  1625. ] = None,
  1626. label: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1627. is_front: Optional[Union[Var[bool], bool]] = None,
  1628. style: Optional[Style] = None,
  1629. key: Optional[Any] = None,
  1630. id: Optional[Any] = None,
  1631. class_name: Optional[Any] = None,
  1632. autofocus: Optional[bool] = None,
  1633. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1634. on_blur: Optional[EventType[()]] = None,
  1635. on_click: Optional[EventType[()]] = None,
  1636. on_context_menu: Optional[EventType[()]] = None,
  1637. on_double_click: Optional[EventType[()]] = None,
  1638. on_focus: Optional[EventType[()]] = None,
  1639. on_mount: Optional[EventType[()]] = None,
  1640. on_mouse_down: Optional[EventType[()]] = None,
  1641. on_mouse_enter: Optional[EventType[()]] = None,
  1642. on_mouse_leave: Optional[EventType[()]] = None,
  1643. on_mouse_move: Optional[EventType[()]] = None,
  1644. on_mouse_out: Optional[EventType[()]] = None,
  1645. on_mouse_over: Optional[EventType[()]] = None,
  1646. on_mouse_up: Optional[EventType[()]] = None,
  1647. on_scroll: Optional[EventType[()]] = None,
  1648. on_unmount: Optional[EventType[()]] = None,
  1649. **props,
  1650. ) -> "Reference":
  1651. """Create the component.
  1652. Args:
  1653. *children: The children of the component.
  1654. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  1655. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  1656. 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. Default: "discard"
  1657. label: If set a string or a number, default label will be drawn, and the option is content.
  1658. is_front: If set true, the line will be rendered in front of bars in BarChart, etc. Default: False
  1659. style: The style of the component.
  1660. key: A unique key for the component.
  1661. id: The id for the component.
  1662. class_name: The class name for the component.
  1663. autofocus: Whether the component should take the focus once the page is loaded
  1664. custom_attrs: custom attribute
  1665. **props: The props of the component.
  1666. Returns:
  1667. The component.
  1668. """
  1669. ...
  1670. class ReferenceLine(Reference):
  1671. @overload
  1672. @classmethod
  1673. def create( # type: ignore
  1674. cls,
  1675. *children,
  1676. x: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1677. y: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1678. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1679. stroke_width: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1680. segment: Optional[List[Any]] = None,
  1681. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1682. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1683. if_overflow: Optional[
  1684. Union[
  1685. Literal["discard", "extendDomain", "hidden", "visible"],
  1686. Var[Literal["discard", "extendDomain", "hidden", "visible"]],
  1687. ]
  1688. ] = None,
  1689. label: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1690. is_front: Optional[Union[Var[bool], bool]] = None,
  1691. style: Optional[Style] = None,
  1692. key: Optional[Any] = None,
  1693. id: Optional[Any] = None,
  1694. class_name: Optional[Any] = None,
  1695. autofocus: Optional[bool] = None,
  1696. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1697. on_blur: Optional[EventType[()]] = None,
  1698. on_click: Optional[EventType[()]] = None,
  1699. on_context_menu: Optional[EventType[()]] = None,
  1700. on_double_click: Optional[EventType[()]] = None,
  1701. on_focus: Optional[EventType[()]] = None,
  1702. on_mount: Optional[EventType[()]] = None,
  1703. on_mouse_down: Optional[EventType[()]] = None,
  1704. on_mouse_enter: Optional[EventType[()]] = None,
  1705. on_mouse_leave: Optional[EventType[()]] = None,
  1706. on_mouse_move: Optional[EventType[()]] = None,
  1707. on_mouse_out: Optional[EventType[()]] = None,
  1708. on_mouse_over: Optional[EventType[()]] = None,
  1709. on_mouse_up: Optional[EventType[()]] = None,
  1710. on_scroll: Optional[EventType[()]] = None,
  1711. on_unmount: Optional[EventType[()]] = None,
  1712. **props,
  1713. ) -> "ReferenceLine":
  1714. """Create the component.
  1715. Args:
  1716. *children: The children of the component.
  1717. 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.
  1718. 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.
  1719. stroke: The color of the reference line.
  1720. stroke_width: The width of the stroke. Default: 1
  1721. segment: Array of endpoints in { x, y } format. These endpoints would be used to draw the ReferenceLine.
  1722. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  1723. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  1724. 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. Default: "discard"
  1725. label: If set a string or a number, default label will be drawn, and the option is content.
  1726. is_front: If set true, the line will be rendered in front of bars in BarChart, etc. Default: False
  1727. style: The style of the component.
  1728. key: A unique key for the component.
  1729. id: The id for the component.
  1730. class_name: The class name for the component.
  1731. autofocus: Whether the component should take the focus once the page is loaded
  1732. custom_attrs: custom attribute
  1733. **props: The props of the component.
  1734. Returns:
  1735. The component.
  1736. """
  1737. ...
  1738. class ReferenceDot(Reference):
  1739. @overload
  1740. @classmethod
  1741. def create( # type: ignore
  1742. cls,
  1743. *children,
  1744. x: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1745. y: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1746. r: Optional[Union[Var[int], int]] = None,
  1747. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1748. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1749. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1750. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1751. if_overflow: Optional[
  1752. Union[
  1753. Literal["discard", "extendDomain", "hidden", "visible"],
  1754. Var[Literal["discard", "extendDomain", "hidden", "visible"]],
  1755. ]
  1756. ] = None,
  1757. label: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1758. is_front: Optional[Union[Var[bool], bool]] = None,
  1759. style: Optional[Style] = None,
  1760. key: Optional[Any] = None,
  1761. id: Optional[Any] = None,
  1762. class_name: Optional[Any] = None,
  1763. autofocus: Optional[bool] = None,
  1764. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1765. on_blur: Optional[EventType[()]] = None,
  1766. on_click: Optional[EventType[()]] = None,
  1767. on_context_menu: Optional[EventType[()]] = None,
  1768. on_double_click: Optional[EventType[()]] = None,
  1769. on_focus: Optional[EventType[()]] = None,
  1770. on_mount: Optional[EventType[()]] = None,
  1771. on_mouse_down: Optional[EventType[()]] = None,
  1772. on_mouse_enter: Optional[EventType[()]] = None,
  1773. on_mouse_leave: Optional[EventType[()]] = None,
  1774. on_mouse_move: Optional[EventType[()]] = None,
  1775. on_mouse_out: Optional[EventType[()]] = None,
  1776. on_mouse_over: Optional[EventType[()]] = None,
  1777. on_mouse_up: Optional[EventType[()]] = None,
  1778. on_scroll: Optional[EventType[()]] = None,
  1779. on_unmount: Optional[EventType[()]] = None,
  1780. **props,
  1781. ) -> "ReferenceDot":
  1782. """Create the component.
  1783. Args:
  1784. *children: The children of the component.
  1785. 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.
  1786. 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.
  1787. r: The radius of dot.
  1788. fill: The color of the area fill.
  1789. stroke: The color of the line stroke.
  1790. on_click: The customized event handler of click on the component in this chart
  1791. on_mouse_down: The customized event handler of mousedown on the component in this chart
  1792. on_mouse_up: The customized event handler of mouseup on the component in this chart
  1793. on_mouse_over: The customized event handler of mouseover on the component in this chart
  1794. on_mouse_out: The customized event handler of mouseout on the component in this chart
  1795. on_mouse_enter: The customized event handler of mouseenter on the component in this chart
  1796. on_mouse_move: The customized event handler of mousemove on the component in this chart
  1797. on_mouse_leave: The customized event handler of mouseleave on the component in this chart
  1798. x_axis_id: The id of x-axis which is corresponding to the data. Default: 0
  1799. y_axis_id: The id of y-axis which is corresponding to the data. Default: 0
  1800. 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. Default: "discard"
  1801. label: If set a string or a number, default label will be drawn, and the option is content.
  1802. is_front: If set true, the line will be rendered in front of bars in BarChart, etc. Default: False
  1803. style: The style of the component.
  1804. key: A unique key for the component.
  1805. id: The id for the component.
  1806. class_name: The class name for the component.
  1807. autofocus: Whether the component should take the focus once the page is loaded
  1808. custom_attrs: custom attribute
  1809. **props: The props of the component.
  1810. Returns:
  1811. The component.
  1812. """
  1813. ...
  1814. class ReferenceArea(Recharts):
  1815. @overload
  1816. @classmethod
  1817. def create( # type: ignore
  1818. cls,
  1819. *children,
  1820. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1821. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1822. fill_opacity: Optional[Union[Var[float], float]] = None,
  1823. x_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1824. y_axis_id: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1825. x1: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1826. x2: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1827. y1: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1828. y2: Optional[Union[Var[Union[int, str]], int, str]] = None,
  1829. if_overflow: Optional[
  1830. Union[
  1831. Literal["discard", "extendDomain", "hidden", "visible"],
  1832. Var[Literal["discard", "extendDomain", "hidden", "visible"]],
  1833. ]
  1834. ] = None,
  1835. is_front: Optional[Union[Var[bool], bool]] = None,
  1836. style: Optional[Style] = None,
  1837. key: Optional[Any] = None,
  1838. id: Optional[Any] = None,
  1839. class_name: Optional[Any] = None,
  1840. autofocus: Optional[bool] = None,
  1841. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1842. on_blur: Optional[EventType[()]] = None,
  1843. on_click: Optional[EventType[()]] = None,
  1844. on_context_menu: Optional[EventType[()]] = None,
  1845. on_double_click: Optional[EventType[()]] = None,
  1846. on_focus: Optional[EventType[()]] = None,
  1847. on_mount: Optional[EventType[()]] = None,
  1848. on_mouse_down: Optional[EventType[()]] = None,
  1849. on_mouse_enter: Optional[EventType[()]] = None,
  1850. on_mouse_leave: Optional[EventType[()]] = None,
  1851. on_mouse_move: Optional[EventType[()]] = None,
  1852. on_mouse_out: Optional[EventType[()]] = None,
  1853. on_mouse_over: Optional[EventType[()]] = None,
  1854. on_mouse_up: Optional[EventType[()]] = None,
  1855. on_scroll: Optional[EventType[()]] = None,
  1856. on_unmount: Optional[EventType[()]] = None,
  1857. **props,
  1858. ) -> "ReferenceArea":
  1859. """Create the component.
  1860. Args:
  1861. *children: The children of the component.
  1862. stroke: Stroke color
  1863. fill: Fill color
  1864. fill_opacity: The opacity of area.
  1865. x_axis_id: The id of x-axis which is corresponding to the data.
  1866. y_axis_id: The id of y-axis which is corresponding to the data.
  1867. 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.
  1868. 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.
  1869. 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.
  1870. 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.
  1871. 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. Default: "discard"
  1872. is_front: If set true, the line will be rendered in front of bars in BarChart, etc. Default: False
  1873. style: The style of the component.
  1874. key: A unique key for the component.
  1875. id: The id for the component.
  1876. class_name: The class name for the component.
  1877. autofocus: Whether the component should take the focus once the page is loaded
  1878. custom_attrs: custom attribute
  1879. **props: The props of the component.
  1880. Returns:
  1881. The component.
  1882. """
  1883. ...
  1884. class Grid(Recharts):
  1885. @overload
  1886. @classmethod
  1887. def create( # type: ignore
  1888. cls,
  1889. *children,
  1890. x: Optional[Union[Var[int], int]] = None,
  1891. y: Optional[Union[Var[int], int]] = None,
  1892. width: Optional[Union[Var[int], int]] = None,
  1893. height: Optional[Union[Var[int], int]] = None,
  1894. style: Optional[Style] = None,
  1895. key: Optional[Any] = None,
  1896. id: Optional[Any] = None,
  1897. class_name: Optional[Any] = None,
  1898. autofocus: Optional[bool] = None,
  1899. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1900. on_blur: Optional[EventType[()]] = None,
  1901. on_click: Optional[EventType[()]] = None,
  1902. on_context_menu: Optional[EventType[()]] = None,
  1903. on_double_click: Optional[EventType[()]] = None,
  1904. on_focus: Optional[EventType[()]] = None,
  1905. on_mount: Optional[EventType[()]] = None,
  1906. on_mouse_down: Optional[EventType[()]] = None,
  1907. on_mouse_enter: Optional[EventType[()]] = None,
  1908. on_mouse_leave: Optional[EventType[()]] = None,
  1909. on_mouse_move: Optional[EventType[()]] = None,
  1910. on_mouse_out: Optional[EventType[()]] = None,
  1911. on_mouse_over: Optional[EventType[()]] = None,
  1912. on_mouse_up: Optional[EventType[()]] = None,
  1913. on_scroll: Optional[EventType[()]] = None,
  1914. on_unmount: Optional[EventType[()]] = None,
  1915. **props,
  1916. ) -> "Grid":
  1917. """Create the component.
  1918. Args:
  1919. *children: The children of the component.
  1920. x: The x-coordinate of grid. Default: 0
  1921. y: The y-coordinate of grid. Default: 0
  1922. width: The width of grid. Default: 0
  1923. height: The height of grid. Default: 0
  1924. style: The style of the component.
  1925. key: A unique key for the component.
  1926. id: The id for the component.
  1927. class_name: The class name for the component.
  1928. autofocus: Whether the component should take the focus once the page is loaded
  1929. custom_attrs: custom attribute
  1930. **props: The props of the component.
  1931. Returns:
  1932. The component.
  1933. """
  1934. ...
  1935. class CartesianGrid(Grid):
  1936. @overload
  1937. @classmethod
  1938. def create( # type: ignore
  1939. cls,
  1940. *children,
  1941. horizontal: Optional[Union[Var[bool], bool]] = None,
  1942. vertical: Optional[Union[Var[bool], bool]] = None,
  1943. vertical_points: Optional[
  1944. Union[List[Union[int, str]], Var[List[Union[int, str]]]]
  1945. ] = None,
  1946. horizontal_points: Optional[
  1947. Union[List[Union[int, str]], Var[List[Union[int, str]]]]
  1948. ] = None,
  1949. fill: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1950. fill_opacity: Optional[Union[Var[float], float]] = None,
  1951. stroke_dasharray: Optional[Union[Var[str], str]] = None,
  1952. stroke: Optional[Union[Color, Var[Union[Color, str]], str]] = None,
  1953. x: Optional[Union[Var[int], int]] = None,
  1954. y: Optional[Union[Var[int], int]] = None,
  1955. width: Optional[Union[Var[int], int]] = None,
  1956. height: Optional[Union[Var[int], int]] = None,
  1957. style: Optional[Style] = None,
  1958. key: Optional[Any] = None,
  1959. id: Optional[Any] = None,
  1960. class_name: Optional[Any] = None,
  1961. autofocus: Optional[bool] = None,
  1962. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  1963. on_blur: Optional[EventType[()]] = None,
  1964. on_click: Optional[EventType[()]] = None,
  1965. on_context_menu: Optional[EventType[()]] = None,
  1966. on_double_click: Optional[EventType[()]] = None,
  1967. on_focus: Optional[EventType[()]] = None,
  1968. on_mount: Optional[EventType[()]] = None,
  1969. on_mouse_down: Optional[EventType[()]] = None,
  1970. on_mouse_enter: Optional[EventType[()]] = None,
  1971. on_mouse_leave: Optional[EventType[()]] = None,
  1972. on_mouse_move: Optional[EventType[()]] = None,
  1973. on_mouse_out: Optional[EventType[()]] = None,
  1974. on_mouse_over: Optional[EventType[()]] = None,
  1975. on_mouse_up: Optional[EventType[()]] = None,
  1976. on_scroll: Optional[EventType[()]] = None,
  1977. on_unmount: Optional[EventType[()]] = None,
  1978. **props,
  1979. ) -> "CartesianGrid":
  1980. """Create the component.
  1981. Args:
  1982. *children: The children of the component.
  1983. horizontal: The horizontal line configuration. Default: True
  1984. vertical: The vertical line configuration. Default: True
  1985. vertical_points: The x-coordinates in pixel values of all vertical lines. Default: []
  1986. horizontal_points: The x-coordinates in pixel values of all vertical lines. Default: []
  1987. fill: The background of grid.
  1988. fill_opacity: The opacity of the background used to fill the space between grid lines.
  1989. stroke_dasharray: The pattern of dashes and gaps used to paint the lines of the grid.
  1990. stroke: the stroke color of grid. Default: rx.color("gray", 7)
  1991. x: The x-coordinate of grid. Default: 0
  1992. y: The y-coordinate of grid. Default: 0
  1993. width: The width of grid. Default: 0
  1994. height: The height of grid. Default: 0
  1995. style: The style of the component.
  1996. key: A unique key for the component.
  1997. id: The id for the component.
  1998. class_name: The class name for the component.
  1999. autofocus: Whether the component should take the focus once the page is loaded
  2000. custom_attrs: custom attribute
  2001. **props: The props of the component.
  2002. Returns:
  2003. The component.
  2004. """
  2005. ...
  2006. class CartesianAxis(Grid):
  2007. @overload
  2008. @classmethod
  2009. def create( # type: ignore
  2010. cls,
  2011. *children,
  2012. orientation: Optional[
  2013. Union[
  2014. Literal["bottom", "left", "right", "top"],
  2015. Var[Literal["bottom", "left", "right", "top"]],
  2016. ]
  2017. ] = None,
  2018. view_box: Optional[Union[Dict[str, Any], Var[Dict[str, Any]]]] = None,
  2019. axis_line: Optional[Union[Var[bool], bool]] = None,
  2020. tick: Optional[Union[Var[bool], bool]] = None,
  2021. tick_line: Optional[Union[Var[bool], bool]] = None,
  2022. tick_size: Optional[Union[Var[int], int]] = None,
  2023. interval: Optional[
  2024. Union[
  2025. Literal["preserveEnd", "preserveStart", "preserveStartEnd"],
  2026. Var[Literal["preserveEnd", "preserveStart", "preserveStartEnd"]],
  2027. ]
  2028. ] = None,
  2029. label: Optional[Union[Var[Union[int, str]], int, str]] = None,
  2030. mirror: Optional[Union[Var[bool], bool]] = None,
  2031. tick_margin: Optional[Union[Var[int], int]] = None,
  2032. x: Optional[Union[Var[int], int]] = None,
  2033. y: Optional[Union[Var[int], int]] = None,
  2034. width: Optional[Union[Var[int], int]] = None,
  2035. height: Optional[Union[Var[int], int]] = None,
  2036. style: Optional[Style] = None,
  2037. key: Optional[Any] = None,
  2038. id: Optional[Any] = None,
  2039. class_name: Optional[Any] = None,
  2040. autofocus: Optional[bool] = None,
  2041. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  2042. on_blur: Optional[EventType[()]] = None,
  2043. on_click: Optional[EventType[()]] = None,
  2044. on_context_menu: Optional[EventType[()]] = None,
  2045. on_double_click: Optional[EventType[()]] = None,
  2046. on_focus: Optional[EventType[()]] = None,
  2047. on_mount: Optional[EventType[()]] = None,
  2048. on_mouse_down: Optional[EventType[()]] = None,
  2049. on_mouse_enter: Optional[EventType[()]] = None,
  2050. on_mouse_leave: Optional[EventType[()]] = None,
  2051. on_mouse_move: Optional[EventType[()]] = None,
  2052. on_mouse_out: Optional[EventType[()]] = None,
  2053. on_mouse_over: Optional[EventType[()]] = None,
  2054. on_mouse_up: Optional[EventType[()]] = None,
  2055. on_scroll: Optional[EventType[()]] = None,
  2056. on_unmount: Optional[EventType[()]] = None,
  2057. **props,
  2058. ) -> "CartesianAxis":
  2059. """Create the component.
  2060. Args:
  2061. *children: The children of the component.
  2062. orientation: The orientation of axis 'top' | 'bottom' | 'left' | 'right'. Default: "bottom"
  2063. view_box: The box of viewing area. Default: {"x": 0, "y": 0, "width": 0, "height": 0}
  2064. axis_line: If set false, no axis line will be drawn. If set a object, the option is the configuration of axis line. Default: True
  2065. tick: If set false, no ticks will be drawn.
  2066. tick_line: If set false, no axis tick lines will be drawn. If set a object, the option is the configuration of tick lines. Default: True
  2067. tick_size: The length of tick line. Default: 6
  2068. interval: If set 0, all the ticks will be shown. If set preserveStart", "preserveEnd" or "preserveStartEnd", the ticks which is to be shown or hidden will be calculated automatically. Default: "preserveEnd"
  2069. label: If set a string or a number, default label will be drawn, and the option is content.
  2070. mirror: If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside. Default: False
  2071. tick_margin: The margin between tick line and tick.
  2072. x: The x-coordinate of grid. Default: 0
  2073. y: The y-coordinate of grid. Default: 0
  2074. width: The width of grid. Default: 0
  2075. height: The height of grid. Default: 0
  2076. style: The style of the component.
  2077. key: A unique key for the component.
  2078. id: The id for the component.
  2079. class_name: The class name for the component.
  2080. autofocus: Whether the component should take the focus once the page is loaded
  2081. custom_attrs: custom attribute
  2082. **props: The props of the component.
  2083. Returns:
  2084. The component.
  2085. """
  2086. ...
  2087. area = Area.create
  2088. bar = Bar.create
  2089. line = Line.create
  2090. scatter = Scatter.create
  2091. x_axis = XAxis.create
  2092. y_axis = YAxis.create
  2093. z_axis = ZAxis.create
  2094. brush = Brush.create
  2095. cartesian_axis = CartesianAxis.create
  2096. cartesian_grid = CartesianGrid.create
  2097. reference_line = ReferenceLine.create
  2098. reference_dot = ReferenceDot.create
  2099. reference_area = ReferenceArea.create
  2100. error_bar = ErrorBar.create
  2101. funnel = Funnel.create