@solidports/recharts 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (306) hide show
  1. package/LICENSE +22 -0
  2. package/NOTICE +19 -0
  3. package/README.md +102 -0
  4. package/dist/dev.js +28564 -0
  5. package/dist/index.d.ts +7859 -0
  6. package/dist/index.js +28546 -0
  7. package/package.json +98 -0
  8. package/src/animation/AnimatedItems.tsx +183 -0
  9. package/src/animation/AnimationController.ts +33 -0
  10. package/src/animation/AnimationControllerImpl.ts +36 -0
  11. package/src/animation/AnimationHandle.ts +307 -0
  12. package/src/animation/CSSTransitionAnimate.tsx +170 -0
  13. package/src/animation/JavascriptAnimate.tsx +119 -0
  14. package/src/animation/easing.ts +221 -0
  15. package/src/animation/matchBy.ts +164 -0
  16. package/src/animation/timeoutController.ts +70 -0
  17. package/src/animation/useAnimationController.tsx +34 -0
  18. package/src/animation/useAnimationStartSnapshot.ts +118 -0
  19. package/src/animation/util.ts +41 -0
  20. package/src/cartesian/Area.tsx +915 -0
  21. package/src/cartesian/AreaRevealShape.tsx +190 -0
  22. package/src/cartesian/Bar.tsx +1369 -0
  23. package/src/cartesian/BarStack.tsx +152 -0
  24. package/src/cartesian/Brush.tsx +951 -0
  25. package/src/cartesian/CartesianAxis.tsx +722 -0
  26. package/src/cartesian/CartesianGrid.tsx +711 -0
  27. package/src/cartesian/ErrorBar.tsx +361 -0
  28. package/src/cartesian/Funnel.tsx +803 -0
  29. package/src/cartesian/GraphicalItemClipPath.tsx +67 -0
  30. package/src/cartesian/Line.tsx +863 -0
  31. package/src/cartesian/LineDrawShape.tsx +89 -0
  32. package/src/cartesian/ReferenceArea.tsx +331 -0
  33. package/src/cartesian/ReferenceDot.tsx +304 -0
  34. package/src/cartesian/ReferenceLine.tsx +474 -0
  35. package/src/cartesian/Scatter.tsx +888 -0
  36. package/src/cartesian/XAxis.tsx +433 -0
  37. package/src/cartesian/YAxis.tsx +443 -0
  38. package/src/cartesian/ZAxis.tsx +155 -0
  39. package/src/cartesian/cartesianPositionToCSSTranslate.tsx +29 -0
  40. package/src/cartesian/cartesianViewBoxToTrapezoid.tsx +21 -0
  41. package/src/cartesian/getCartesianPosition.tsx +267 -0
  42. package/src/cartesian/getEquidistantTicks.ts +144 -0
  43. package/src/cartesian/getTicks.ts +225 -0
  44. package/src/cartesian/isOutsidePosition.ts +15 -0
  45. package/src/cartesian/useAnimatedLineLength.ts +54 -0
  46. package/src/chart/AreaChart.tsx +29 -0
  47. package/src/chart/BarChart.tsx +29 -0
  48. package/src/chart/CartesianChart.tsx +131 -0
  49. package/src/chart/CategoricalChart.tsx +94 -0
  50. package/src/chart/ComposedChart.tsx +29 -0
  51. package/src/chart/FunnelChart.tsx +29 -0
  52. package/src/chart/LineChart.tsx +29 -0
  53. package/src/chart/PieChart.tsx +50 -0
  54. package/src/chart/PolarChart.tsx +164 -0
  55. package/src/chart/RadarChart.tsx +70 -0
  56. package/src/chart/RadialBarChart.tsx +46 -0
  57. package/src/chart/RechartsWrapper.tsx +551 -0
  58. package/src/chart/Sankey.tsx +1534 -0
  59. package/src/chart/ScatterChart.tsx +29 -0
  60. package/src/chart/SunburstChart.tsx +504 -0
  61. package/src/chart/Treemap.tsx +1223 -0
  62. package/src/chart/createInitialRootProps.ts +24 -0
  63. package/src/chart/types.ts +53 -0
  64. package/src/component/ActivePoints.tsx +144 -0
  65. package/src/component/Cell.tsx +37 -0
  66. package/src/component/Cursor.tsx +185 -0
  67. package/src/component/Customized.tsx +50 -0
  68. package/src/component/DefaultLegendContent.tsx +348 -0
  69. package/src/component/DefaultTooltipContent.tsx +224 -0
  70. package/src/component/Dots.tsx +157 -0
  71. package/src/component/Label.tsx +636 -0
  72. package/src/component/LabelList.tsx +375 -0
  73. package/src/component/Legend.tsx +512 -0
  74. package/src/component/ResponsiveContainer.tsx +348 -0
  75. package/src/component/Text.tsx +541 -0
  76. package/src/component/Tooltip.tsx +470 -0
  77. package/src/component/TooltipBoundingBox.tsx +146 -0
  78. package/src/component/responsiveContainerUtils.ts +134 -0
  79. package/src/container/ClipPathProvider.tsx +51 -0
  80. package/src/container/Layer.tsx +38 -0
  81. package/src/container/RootSurface.tsx +120 -0
  82. package/src/container/Surface.tsx +61 -0
  83. package/src/context/CellsContext.tsx +54 -0
  84. package/src/context/ErrorBarContext.tsx +146 -0
  85. package/src/context/GraphicalItemChildrenScope.tsx +18 -0
  86. package/src/context/PanoramaContext.tsx +9 -0
  87. package/src/context/RegisterGraphicalItemId.tsx +30 -0
  88. package/src/context/accessibilityContext.tsx +6 -0
  89. package/src/context/brushUpdateContext.tsx +9 -0
  90. package/src/context/chartDataContext.tsx +97 -0
  91. package/src/context/chartLayoutContext.tsx +201 -0
  92. package/src/context/legendPayloadContext.tsx +20 -0
  93. package/src/context/legendPortalContext.tsx +12 -0
  94. package/src/context/tooltipContext.tsx +89 -0
  95. package/src/context/tooltipPortalContext.tsx +12 -0
  96. package/src/context/useTooltipAxis.ts +22 -0
  97. package/src/hooks.ts +476 -0
  98. package/src/index.ts +280 -0
  99. package/src/polar/Pie.tsx +1360 -0
  100. package/src/polar/PolarAngleAxis.tsx +616 -0
  101. package/src/polar/PolarGrid.tsx +312 -0
  102. package/src/polar/PolarRadiusAxis.tsx +547 -0
  103. package/src/polar/Radar.tsx +734 -0
  104. package/src/polar/RadialBar.tsx +917 -0
  105. package/src/polar/defaultPolarAngleAxisProps.tsx +27 -0
  106. package/src/polar/defaultPolarRadiusAxisProps.tsx +25 -0
  107. package/src/shape/Cross.tsx +89 -0
  108. package/src/shape/Curve.tsx +343 -0
  109. package/src/shape/Dot.tsx +70 -0
  110. package/src/shape/Polygon.tsx +195 -0
  111. package/src/shape/Rectangle.tsx +470 -0
  112. package/src/shape/Sector.tsx +347 -0
  113. package/src/shape/Symbols.tsx +139 -0
  114. package/src/shape/Trapezoid.tsx +280 -0
  115. package/src/state/RechartsStateContext.tsx +12 -0
  116. package/src/state/RechartsStateProvider.tsx +87 -0
  117. package/src/state/RechartsStoreContext.tsx +25 -0
  118. package/src/state/RechartsStoreProvider.tsx +35 -0
  119. package/src/state/ReportChartProps.tsx +40 -0
  120. package/src/state/ReportEventSettings.tsx +30 -0
  121. package/src/state/ReportMainChartProps.tsx +61 -0
  122. package/src/state/ReportPolarOptions.tsx +35 -0
  123. package/src/state/SetGraphicalItem.ts +79 -0
  124. package/src/state/SetLegendPayload.ts +134 -0
  125. package/src/state/SetTooltipEntrySettings.tsx +72 -0
  126. package/src/state/actions.ts +464 -0
  127. package/src/state/brushSlice.ts +13 -0
  128. package/src/state/cartesianAxisSlice.ts +141 -0
  129. package/src/state/chartDataSlice.ts +50 -0
  130. package/src/state/chartState.ts +297 -0
  131. package/src/state/errorBarSlice.ts +29 -0
  132. package/src/state/eventSettingsSlice.ts +8 -0
  133. package/src/state/events.ts +76 -0
  134. package/src/state/externalEventsMiddleware.ts +255 -0
  135. package/src/state/graphicalItemsSlice.ts +74 -0
  136. package/src/state/hooks/useChartSelectors.tsx +45 -0
  137. package/src/state/keyboardEventsMiddleware.ts +228 -0
  138. package/src/state/layoutSlice.ts +21 -0
  139. package/src/state/legendSlice.ts +57 -0
  140. package/src/state/mouseEventsMiddleware.ts +185 -0
  141. package/src/state/optionsSlice.ts +47 -0
  142. package/src/state/polarAxisSlice.ts +10 -0
  143. package/src/state/polarOptionsSlice.ts +12 -0
  144. package/src/state/rawData.ts +26 -0
  145. package/src/state/referenceElementsSlice.ts +40 -0
  146. package/src/state/renderedTicksSlice.ts +15 -0
  147. package/src/state/rootPropsSlice.ts +47 -0
  148. package/src/state/selectors/areaSelectors.ts +240 -0
  149. package/src/state/selectors/arrayEqualityCheck.ts +29 -0
  150. package/src/state/selectors/axisSelectors.ts +2157 -0
  151. package/src/state/selectors/barSelectors.ts +310 -0
  152. package/src/state/selectors/barStackSelectors.ts +77 -0
  153. package/src/state/selectors/brushSelectors.ts +33 -0
  154. package/src/state/selectors/chartSelector.ts +185 -0
  155. package/src/state/selectors/combiners/combineActiveLabel.ts +16 -0
  156. package/src/state/selectors/combiners/combineActiveTooltipIndex.ts +95 -0
  157. package/src/state/selectors/combiners/combineAllBarPositions.ts +122 -0
  158. package/src/state/selectors/combiners/combineAxisRangeWithReverse.ts +16 -0
  159. package/src/state/selectors/combiners/combineBarPosition.ts +23 -0
  160. package/src/state/selectors/combiners/combineBarSizeList.ts +80 -0
  161. package/src/state/selectors/combiners/combineCheckedDomain.ts +48 -0
  162. package/src/state/selectors/combiners/combineConfiguredScale.ts +111 -0
  163. package/src/state/selectors/combiners/combineCoordinateForDefaultIndex.ts +45 -0
  164. package/src/state/selectors/combiners/combineDisplayedStackedData.ts +50 -0
  165. package/src/state/selectors/combiners/combineInverseScaleFunction.ts +16 -0
  166. package/src/state/selectors/combiners/combineRealScaleType.ts +44 -0
  167. package/src/state/selectors/combiners/combineStackedData.ts +27 -0
  168. package/src/state/selectors/combiners/combineTooltipInteractionState.ts +86 -0
  169. package/src/state/selectors/combiners/combineTooltipPayload.ts +205 -0
  170. package/src/state/selectors/combiners/combineTooltipPayloadConfigurations.ts +58 -0
  171. package/src/state/selectors/containerSelectors.ts +12 -0
  172. package/src/state/selectors/dataSelectors.ts +88 -0
  173. package/src/state/selectors/funnelSelectors.ts +75 -0
  174. package/src/state/selectors/graphicalItemSelectors.ts +30 -0
  175. package/src/state/selectors/legendSelectors.ts +29 -0
  176. package/src/state/selectors/lineSelectors.ts +134 -0
  177. package/src/state/selectors/numberDomainEqualityCheck.ts +14 -0
  178. package/src/state/selectors/pickAxisId.ts +5 -0
  179. package/src/state/selectors/pickAxisType.ts +3 -0
  180. package/src/state/selectors/pieSelectors.ts +97 -0
  181. package/src/state/selectors/polarAxisSelectors.ts +201 -0
  182. package/src/state/selectors/polarGridSelectors.ts +28 -0
  183. package/src/state/selectors/polarScaleSelectors.ts +133 -0
  184. package/src/state/selectors/polarSelectors.ts +219 -0
  185. package/src/state/selectors/radarSelectors.ts +191 -0
  186. package/src/state/selectors/radialBarSelectors.ts +435 -0
  187. package/src/state/selectors/rootPropsSelectors.ts +25 -0
  188. package/src/state/selectors/scatterSelectors.ts +96 -0
  189. package/src/state/selectors/selectActivePropsFromChartPointer.ts +26 -0
  190. package/src/state/selectors/selectAllAxes.ts +17 -0
  191. package/src/state/selectors/selectChartOffset.ts +16 -0
  192. package/src/state/selectors/selectChartOffsetInternal.ts +136 -0
  193. package/src/state/selectors/selectLegendArea.ts +20 -0
  194. package/src/state/selectors/selectPlotArea.ts +22 -0
  195. package/src/state/selectors/selectTooltipAxisId.ts +7 -0
  196. package/src/state/selectors/selectTooltipAxisType.ts +32 -0
  197. package/src/state/selectors/selectTooltipEventType.ts +48 -0
  198. package/src/state/selectors/selectTooltipPayloadSearcher.ts +6 -0
  199. package/src/state/selectors/selectTooltipSettings.ts +39 -0
  200. package/src/state/selectors/selectTooltipState.ts +8 -0
  201. package/src/state/selectors/selectors.ts +271 -0
  202. package/src/state/selectors/tooltipSelectors.ts +578 -0
  203. package/src/state/selectors/touchSelectors.ts +31 -0
  204. package/src/state/store.ts +29 -0
  205. package/src/state/storeIdentity.ts +9 -0
  206. package/src/state/teardownWrite.ts +10 -0
  207. package/src/state/tooltipInteraction.ts +23 -0
  208. package/src/state/tooltipSlice.ts +334 -0
  209. package/src/state/touchEventsMiddleware.ts +214 -0
  210. package/src/state/types/AnimationSettings.ts +20 -0
  211. package/src/state/types/AreaSettings.ts +14 -0
  212. package/src/state/types/BarSettings.ts +15 -0
  213. package/src/state/types/LineSettings.ts +9 -0
  214. package/src/state/types/PieSettings.ts +34 -0
  215. package/src/state/types/RadarSettings.ts +5 -0
  216. package/src/state/types/RadialBarSettings.ts +10 -0
  217. package/src/state/types/ScatterSettings.ts +12 -0
  218. package/src/state/types/StackedGraphicalItem.ts +34 -0
  219. package/src/state/useChartState.ts +17 -0
  220. package/src/state/zIndexSlice.ts +39 -0
  221. package/src/synchronisation/syncSelectors.ts +7 -0
  222. package/src/synchronisation/types.ts +44 -0
  223. package/src/synchronisation/useChartSynchronisation.tsx +404 -0
  224. package/src/theme/RechartsTheme.ts +16 -0
  225. package/src/theme/RechartsThemeContext.ts +19 -0
  226. package/src/theme/darkTheme.ts +13 -0
  227. package/src/theme/graphicalItemIdentity.ts +70 -0
  228. package/src/theme/legacyTheme.ts +17 -0
  229. package/src/theme/lightTheme.ts +13 -0
  230. package/src/types.ts +54 -0
  231. package/src/util/ActiveShapeUtils.tsx +162 -0
  232. package/src/util/BarUtils.tsx +62 -0
  233. package/src/util/BarePortal.tsx +50 -0
  234. package/src/util/CamelCaseSVGAttrs.ts +34 -0
  235. package/src/util/CartesianUtils.ts +48 -0
  236. package/src/util/ChartUtils.ts +802 -0
  237. package/src/util/Constants.ts +42 -0
  238. package/src/util/CssPrefixUtils.ts +20 -0
  239. package/src/util/DOMUtils.ts +129 -0
  240. package/src/util/DataUtils.ts +216 -0
  241. package/src/util/Events.ts +16 -0
  242. package/src/util/FunnelUtils.tsx +15 -0
  243. package/src/util/Global.ts +12 -0
  244. package/src/util/IfOverflow.ts +15 -0
  245. package/src/util/LRUCache.ts +41 -0
  246. package/src/util/LogUtils.ts +22 -0
  247. package/src/util/PolarUtils.ts +132 -0
  248. package/src/util/RadialBarUtils.tsx +24 -0
  249. package/src/util/ReactUtils.ts +95 -0
  250. package/src/util/ReduceCSSCalc.ts +187 -0
  251. package/src/util/ScatterUtils.tsx +52 -0
  252. package/src/util/ShapeElementProps.tsx +87 -0
  253. package/src/util/TickUtils.ts +60 -0
  254. package/src/util/XAxisUtils.ts +48 -0
  255. package/src/util/YAxisUtils.ts +48 -0
  256. package/src/util/axisPropsAreEqual.ts +48 -0
  257. package/src/util/createCartesianCharts.tsx +150 -0
  258. package/src/util/createEventProxy.ts +20 -0
  259. package/src/util/createPolarCharts.tsx +112 -0
  260. package/src/util/cursor/getCursorPoints.ts +46 -0
  261. package/src/util/cursor/getCursorRectangle.ts +28 -0
  262. package/src/util/cursor/getRadialCursorPoints.ts +32 -0
  263. package/src/util/excludeEventProps.ts +171 -0
  264. package/src/util/getActiveCoordinate.ts +213 -0
  265. package/src/util/getAxisTypeBasedOnLayout.ts +21 -0
  266. package/src/util/getClassNameFromUnknown.ts +6 -0
  267. package/src/util/getEveryNth.ts +27 -0
  268. package/src/util/getRadiusAndStrokeWidthFromDot.ts +35 -0
  269. package/src/util/getRelativeCoordinate.ts +80 -0
  270. package/src/util/getSliced.ts +13 -0
  271. package/src/util/hoverDedupe.ts +41 -0
  272. package/src/util/isDomainSpecifiedByUser.ts +219 -0
  273. package/src/util/isWellBehavedNumber.ts +7 -0
  274. package/src/util/pathTotalLength.ts +25 -0
  275. package/src/util/payload/getUniqPayload.ts +28 -0
  276. package/src/util/propsAreEqual.ts +121 -0
  277. package/src/util/resolveDefaultProps.ts +161 -0
  278. package/src/util/round.ts +32 -0
  279. package/src/util/scale/CartesianScaleHelper.ts +72 -0
  280. package/src/util/scale/CustomScaleDefinition.ts +81 -0
  281. package/src/util/scale/RechartsScale.ts +130 -0
  282. package/src/util/scale/createCategoricalInverse.ts +72 -0
  283. package/src/util/scale/getNiceTickValues.ts +311 -0
  284. package/src/util/scale/index.ts +2 -0
  285. package/src/util/scale/util/arithmetic.ts +54 -0
  286. package/src/util/solid-1-compat.ts +310 -0
  287. package/src/util/solidJsxCamelAugment.d.ts +84 -0
  288. package/src/util/stacks/getStackSeriesIdentifier.ts +21 -0
  289. package/src/util/stacks/stackTypes.ts +60 -0
  290. package/src/util/structurallyEqual.ts +31 -0
  291. package/src/util/svgPropertiesAndEvents.ts +53 -0
  292. package/src/util/svgPropertiesNoEvents.ts +571 -0
  293. package/src/util/tooltip/translate.ts +171 -0
  294. package/src/util/typedDataKey.ts +48 -0
  295. package/src/util/types.ts +1560 -0
  296. package/src/util/useAnimationId.ts +31 -0
  297. package/src/util/useElementOffset.ts +110 -0
  298. package/src/util/useId.ts +8 -0
  299. package/src/util/usePrefersReducedMotion.ts +48 -0
  300. package/src/util/useReportScale.ts +24 -0
  301. package/src/util/useUniqueId.ts +30 -0
  302. package/src/zIndex/DefaultZIndexes.ts +84 -0
  303. package/src/zIndex/ZIndexLayer.tsx +121 -0
  304. package/src/zIndex/ZIndexPortal.tsx +79 -0
  305. package/src/zIndex/getZIndexFromUnknown.ts +14 -0
  306. package/src/zIndex/zIndexSelectors.ts +48 -0
@@ -0,0 +1,443 @@
1
+ /* eslint-disable import/no-cycle */
2
+ import type { TickItem } from "../util/types"
3
+ import type { JSX } from '@solidjs/web';
4
+ import { createMemo, createSignal, onCleanup, Show, useContext, createEffect, untrack } from "solid-js"
5
+ import { clsx } from "clsx"
6
+ import {
7
+ AxisDomainTypeInput,
8
+ AxisInterval,
9
+ AxisTick,
10
+ RenderableAxisProps,
11
+ PresentationAttributesAdaptChildEvent,
12
+ Size,
13
+ AxisDomain,
14
+ ScaleType,
15
+ EvaluatedAxisDomainType,
16
+ TickProp,
17
+ YAxisTickContentProps,
18
+ } from "../util/types"
19
+ import { CartesianAxis, CartesianAxisRef, defaultCartesianAxisProps } from "./CartesianAxis"
20
+ import type {
21
+ YAxisOrientation,
22
+ YAxisPadding,
23
+ YAxisSettings,
24
+ YAxisWidth,
25
+ } from "../state/cartesianAxisSlice"
26
+ import { useChartStore } from "../state/RechartsStoreContext"
27
+ import { RechartsStateContext } from "../state/RechartsStateContext"
28
+ import {
29
+ implicitYAxis,
30
+ selectTicksOfAxis,
31
+ selectYAxisPosition,
32
+ selectYAxisSettingsNoDefaults,
33
+ selectYAxisSize,
34
+ } from "../state/selectors/axisSelectors"
35
+ import { useAxisViewBox } from "../state/hooks/useChartSelectors"
36
+ import { useIsPanorama } from "../context/PanoramaContext"
37
+ import { isLabelContentAFunction } from "../component/Label"
38
+ import { RequiresDefaultProps, resolveDefaultProps } from "../util/resolveDefaultProps"
39
+ import { CustomScaleDefinition } from "../util/scale/CustomScaleDefinition"
40
+ import { useCartesianChartLayout } from "../context/chartLayoutContext"
41
+ import { getAxisTypeBasedOnLayout } from "../util/getAxisTypeBasedOnLayout"
42
+ import { teardownWrite } from "../state/teardownWrite"
43
+
44
+ interface YAxisProps<DataPointType = unknown, DataValueType = unknown> extends Omit<
45
+ RenderableAxisProps<DataPointType, DataValueType>,
46
+ "axisLine" | "domain" | "scale" | "tick"
47
+ > {
48
+ /**
49
+ * Determines how the axis line is drawn. Options:
50
+ * - `true`: the axis line is drawn with default props;
51
+ * - `false`: the axis line is not visible;
52
+ * - `object`: passed as props to SVG `<line>` element representing the axis line.
53
+ *
54
+ * @example <YAxis axisLine={false} />
55
+ * @example <YAxis axisLine={{ stroke: 'red', strokeWidth: 2 }} />
56
+ * @defaultValue true
57
+ */
58
+ axisLine?: boolean | JSX.LineSVGAttributes<SVGLineElement>
59
+ /**
60
+ * The type of axis.
61
+ *
62
+ * `category`: Treats data as distinct values.
63
+ * Each value is in the same distance from its neighbors, regardless of their actual numeric difference.
64
+ *
65
+ * `number`: Treats data as continuous range.
66
+ * Values that are numerically closer are placed closer together on the axis.
67
+ *
68
+ * `auto`: the type is inferred based on the chart layout.
69
+ *
70
+ * @defaultValue number
71
+ */
72
+ type?: AxisDomainTypeInput
73
+ /**
74
+ * Specify the domain of axis when the axis is a number axis.
75
+ *
76
+ * If undefined, then the domain is calculated based on the data and dataKeys.
77
+ *
78
+ * The length of domain should be 2, and we will validate the values in domain.
79
+ *
80
+ * Each element in the array can be a number, 'auto', 'dataMin', 'dataMax', a string like 'dataMin - 20', 'dataMax + 100',
81
+ * or a function that accepts a single argument and returns a number.
82
+ *
83
+ * If any element of domain is set to be 'auto', comprehensible scale ticks will be calculated, and the final domain of axis is generated by the ticks.
84
+ * If a function, receives '[dataMin, dataMax]', and must return a computed domain as '[min, max]'.
85
+ *
86
+ * @example <YAxis type="number" domain={['dataMin', 'dataMax']} />
87
+ * @example <YAxis type="number" domain={[0, 'dataMax']} />
88
+ * @example <YAxis type="number" domain={['auto', 'auto']} />
89
+ * @example <YAxis type="number" domain={[0, 'dataMax + 1000']} />
90
+ * @example <YAxis type="number" domain={['dataMin - 100', 'dataMax + 100']} />
91
+ * @example <YAxis type="number" domain={[dataMin => (0 - Math.abs(dataMin)), dataMax => (dataMax * 2)]} />
92
+ * @example <YAxis type="number" domain={([dataMin, dataMax]) => { const absMax = Math.max(Math.abs(dataMin), Math.abs(dataMax)); return [-absMax, absMax]; }} />
93
+ * @example <YAxis type="number" domain={[0, 100]} allowDataOverflow />
94
+ */
95
+ domain?: AxisDomain
96
+ /**
97
+ * Scale function determines how data values are mapped to visual values.
98
+ * In other words, decided the mapping between data domain and coordinate range.
99
+ *
100
+ * If undefined, or 'auto', the scale function is created internally according to the type of axis and data.
101
+ *
102
+ * You can define a custom scale, either as a string shortcut to a d3 scale, or as a complete scale definition object.
103
+ *
104
+ * @defaultValue auto
105
+ * @example <YAxis scale="log" />
106
+ * @example
107
+ * import { scaleLog } from 'd3-scale';
108
+ * const scale = scaleLog().base(Math.E);
109
+ * <YAxis scale={scale} />
110
+ */
111
+ scale?:
112
+ | ScaleType
113
+ | CustomScaleDefinition
114
+ | CustomScaleDefinition<string>
115
+ | CustomScaleDefinition<number>
116
+ | CustomScaleDefinition<Date>
117
+ /**
118
+ * Unique ID that represents this YAxis.
119
+ * Required when there are multiple YAxes.
120
+ *
121
+ * @defaultValue 0
122
+ */
123
+ yAxisId?: string | number
124
+ /**
125
+ * Defines how the individual label text is rendered.
126
+ * This controls the settings for individual ticks; on a typical axis, there are multiple ticks, depending on your data.
127
+ *
128
+ * If you want to customize the overall axis label, use the `label` prop instead.
129
+ *
130
+ * Options:
131
+ * - `false`: Do not render any tick labels.
132
+ * - `true`: Render tick labels with default settings.
133
+ * - `object`: An object of props to be merged into the internally calculated tick props.
134
+ * - `ReactElement`: A custom React element to be used as the tick label.
135
+ * - `function`: A function that returns a React element for custom rendering of tick labels.
136
+ *
137
+ * @defaultValue true
138
+ */
139
+ tick?: TickProp<YAxisTickContentProps>
140
+ /**
141
+ * Ticks can be any type when the axis is the type of category
142
+ * Ticks must be numbers when the axis is the type of number
143
+ */
144
+ ticks?: ReadonlyArray<AxisTick>
145
+ /**
146
+ * Width of the axis in pixels.
147
+ * `auto` will attempt to resize the axis based on its content.
148
+ *
149
+ * @defaultValue 60
150
+ */
151
+ width?: YAxisWidth
152
+ /**
153
+ * If set true, flips ticks around the axis line, displaying the labels inside the chart instead of outside.
154
+ * @defaultValue false
155
+ */
156
+ mirror?: boolean
157
+ /**
158
+ * The orientation of axis.
159
+ * @defaultValue left
160
+ */
161
+ orientation?: YAxisOrientation
162
+ /**
163
+ * Axis padding is the distance between the edge of plot area and the first/last tick.
164
+ *
165
+ * @defaultValue {"top":0,"bottom":0}
166
+ */
167
+ padding?: YAxisPadding
168
+ /**
169
+ * The minimum gap between two adjacent tick labels
170
+ *
171
+ * @defaultValue 5
172
+ */
173
+ minTickGap?: number
174
+ /**
175
+ * If set 0, all the ticks will be shown. If set "preserveStart", "preserveEnd" or "preserveStartEnd",
176
+ * the ticks which is to be shown or hidden will be calculated automatically.
177
+ *
178
+ * @defaultValue preserveEnd
179
+ */
180
+ interval?: AxisInterval
181
+ /**
182
+ * The margin between tick line and tick.
183
+ */
184
+ tickMargin?: number
185
+ }
186
+
187
+ /* eslint-disable-next-line typescript-eslint/no-explicit-any -- upstream contract: untyped axes accept any data */
188
+ export type Props<DataPointType = any, DataValueType = any> = Omit<
189
+ PresentationAttributesAdaptChildEvent<TickItem, SVGTextElement>,
190
+ "scale" | "ref"
191
+ > &
192
+ YAxisProps<DataPointType, DataValueType>
193
+
194
+ function SetYAxisSettings(
195
+ props: Omit<YAxisSettings, "type"> & { type: AxisDomainTypeInput },
196
+ ): null {
197
+ const stateCtx = useContext(RechartsStateContext)
198
+ let prevSettings: YAxisSettings | null = null
199
+ const evaluatedType = (): EvaluatedAxisDomainType | undefined => {
200
+ /* eslint-disable-next-line solid/reactivity -- called only from inside createMemo below; reads are tracked through the call chain */
201
+ const { type: typeFromProps, ..._ } = props
202
+ return getAxisTypeBasedOnLayout(useCartesianChartLayout(), "yAxis", typeFromProps)
203
+ }
204
+
205
+ const settings = createMemo((): YAxisSettings | undefined => {
206
+ const et = evaluatedType()
207
+ if (et == null) {
208
+ return undefined
209
+ }
210
+ /* eslint-disable-next-line solid/reactivity -- inside createMemo body; destructure is tracked */
211
+ const { type: _t, ...restProps } = props
212
+ return {
213
+ ...restProps,
214
+ type: et,
215
+ }
216
+ })
217
+
218
+ createEffect(settings, (s) => {
219
+ if (s == null) {
220
+ return
221
+ }
222
+ /* upstream replaceYAxis: a changed id drops the previous entry */
223
+ if (prevSettings != null && String(prevSettings.id) !== String(s.id)) {
224
+ const prevId = String(prevSettings.id)
225
+ stateCtx?.setState("cartesianAxes", "yAxis", (axes) => {
226
+ delete axes[prevId]
227
+ })
228
+ }
229
+ stateCtx?.setState("cartesianAxes", "yAxis", String(s.id), { settings: s })
230
+ prevSettings = s
231
+ })
232
+
233
+ onCleanup(() => {
234
+ teardownWrite(() => {
235
+ if (prevSettings) {
236
+ const strId = String(prevSettings.id)
237
+ /* eslint-disable-next-line solid/reactivity -- cleanup runs outside tracking; intentional */
238
+ stateCtx?.setState("cartesianAxes", "yAxis", (axes) => { delete axes[strId] })
239
+ prevSettings = null
240
+ }
241
+ })
242
+ })
243
+
244
+ return null
245
+ }
246
+
247
+ function YAxisImpl(props: PropsWithDefaults) {
248
+ const [cartesianAxisRef, setCartesianAxisRef] = createSignal<CartesianAxisRef | null>(null)
249
+ let labelRef: SVGTextElement | null = null
250
+
251
+ const ctx2 = useChartStore()
252
+ const stateCtx2 = useContext(RechartsStateContext)
253
+ const viewBox = useAxisViewBox
254
+ const isPanorama = useIsPanorama()
255
+ const axisType = "yAxis"
256
+ const axisSize = createMemo((): Size | undefined =>
257
+ ctx2 ? selectYAxisSize(ctx2.store, props.yAxisId) : undefined,
258
+ )
259
+ const position = createMemo(() =>
260
+ ctx2 ? selectYAxisPosition(ctx2.store, props.yAxisId) : undefined,
261
+ )
262
+ const cartesianTickItems = createMemo(() =>
263
+ ctx2 ? selectTicksOfAxis(ctx2.store, axisType, props.yAxisId, isPanorama) : undefined,
264
+ )
265
+ /*
266
+ * Here we select settings from the store and prefer to use them instead of the actual props
267
+ * so that the chart is consistent. If we used the props directly, some components will use axis settings
268
+ * from state and some from props and because there is a render step between these two, they might be showing different things.
269
+ * https://github.com/recharts/recharts/issues/6257
270
+ */
271
+ const synchronizedSettings = createMemo(() =>
272
+ ctx2 ? selectYAxisSettingsNoDefaults(ctx2.store, props.yAxisId) : undefined,
273
+ )
274
+
275
+ createEffect(
276
+ () => {
277
+ /* Subscribe before the early-return: settings and the axis ref often
278
+ become ready in the same flush. Returning before reading the ref
279
+ misses that update. */
280
+ const axisComponent = cartesianAxisRef()
281
+ cartesianTickItems()
282
+ const currentSize = axisSize()
283
+ const synced = synchronizedSettings()
284
+ /* No dynamic width calculation is done when width !== 'auto'
285
+ * or when a function/react element is used for label */
286
+ if (
287
+ props.width !== "auto" ||
288
+ !currentSize ||
289
+ isLabelContentAFunction(props.label) ||
290
+ synced == null ||
291
+ axisComponent == null
292
+ ) {
293
+ return null
294
+ }
295
+ return { axisComponent, currentSize }
296
+ },
297
+ (input) => {
298
+ if (input == null) {
299
+ return
300
+ }
301
+ const { axisComponent, currentSize } = input
302
+ untrack(() => {
303
+ const updatedYAxisWidth = axisComponent.getCalculatedWidth()
304
+
305
+ /* if the width has changed, update the width (with oscillation guard from legacy actions.updateYAxisWidth) */
306
+ if (currentSize && Math.round(currentSize.width) !== Math.round(updatedYAxisWidth)) {
307
+ const axisEntry = stateCtx2?.state.cartesianAxes.yAxis[String(props.yAxisId)]
308
+ const axis = axisEntry?.settings
309
+ if (axis != null) {
310
+ const history = axis.widthHistory ?? []
311
+ const skip =
312
+ history.length === 3 &&
313
+ history[0] === history[2] &&
314
+ updatedYAxisWidth === history[1] &&
315
+ updatedYAxisWidth !== axis.width &&
316
+ Math.abs(updatedYAxisWidth - (history[0] ?? 0)) <= 1
317
+ if (!skip) {
318
+ const newHistory = [...history, updatedYAxisWidth].slice(-3)
319
+ stateCtx2?.setState("cartesianAxes", "yAxis", String(props.yAxisId), "settings", {
320
+ ...axis,
321
+ width: updatedYAxisWidth,
322
+ widthHistory: newHistory,
323
+ })
324
+ }
325
+ }
326
+ }
327
+ })
328
+ },
329
+ )
330
+
331
+ /* resolved() drops when any dep is nullish; Show rerenders subtree when
332
+ the memo flips from falsy → truthy, matching upstream React semantics. */
333
+ const resolved = createMemo(() => {
334
+ const size = axisSize()
335
+ const pos = position()
336
+ const synced = synchronizedSettings()
337
+ if (size == null || pos == null || synced == null) {
338
+ return null
339
+ }
340
+ const { id: _del1, scale: _del2, ...restSynchronizedSettings } = synced
341
+ return { pos, restSynchronizedSettings, size }
342
+ })
343
+
344
+ return (
345
+ <Show when={resolved()}>
346
+ {(v) => (
347
+ <CartesianAxis
348
+ {...props}
349
+ {...v().restSynchronizedSettings}
350
+ axisRef={setCartesianAxisRef}
351
+ labelRef={labelRef}
352
+ x={v().pos.x}
353
+ y={v().pos.y}
354
+ tickTextProps={props.width === "auto" ? { width: undefined } : { width: props.width }}
355
+ width={v().size.width}
356
+ height={v().size.height}
357
+ class={clsx(`recharts-${axisType} ${axisType}`, props.class)}
358
+ viewBox={viewBox()}
359
+ ticks={cartesianTickItems()}
360
+ axisType={axisType}
361
+ axisId={props.yAxisId}
362
+ />
363
+ )}
364
+ </Show>
365
+ )
366
+ }
367
+
368
+ export const yAxisDefaultProps = {
369
+ allowDataOverflow: implicitYAxis.allowDataOverflow,
370
+ allowDecimals: implicitYAxis.allowDecimals,
371
+ allowDuplicatedCategory: implicitYAxis.allowDuplicatedCategory,
372
+ angle: implicitYAxis.angle,
373
+ axisLine: defaultCartesianAxisProps.axisLine,
374
+ hide: false,
375
+ includeHidden: implicitYAxis.includeHidden,
376
+ interval: implicitYAxis.interval,
377
+ label: false,
378
+ minTickGap: implicitYAxis.minTickGap,
379
+ mirror: implicitYAxis.mirror,
380
+ orientation: implicitYAxis.orientation,
381
+ padding: implicitYAxis.padding,
382
+ reversed: implicitYAxis.reversed,
383
+ scale: implicitYAxis.scale,
384
+ tick: implicitYAxis.tick,
385
+ tickCount: implicitYAxis.tickCount,
386
+ niceTicks: implicitYAxis.niceTicks,
387
+ tickLine: defaultCartesianAxisProps.tickLine,
388
+ tickSize: defaultCartesianAxisProps.tickSize,
389
+ type: implicitYAxis.type,
390
+ width: implicitYAxis.width,
391
+ yAxisId: 0,
392
+ } as const satisfies Partial<Props>
393
+
394
+ type PropsWithDefaults = RequiresDefaultProps<Props, typeof yAxisDefaultProps>
395
+
396
+ /**
397
+ * @consumes CartesianViewBoxContext
398
+ * @provides CartesianLabelContext
399
+ */
400
+ /* eslint-disable-next-line typescript-eslint/no-explicit-any -- upstream contract: untyped axes accept any data */
401
+ export function YAxis<DataPointType = any, DataValueType = any>(
402
+ outsideProps: Props<DataPointType, DataValueType>,
403
+ ) {
404
+ const props: PropsWithDefaults = resolveDefaultProps(outsideProps, yAxisDefaultProps)
405
+ return (
406
+ <>
407
+ <SetYAxisSettings
408
+ interval={props.interval}
409
+ id={props.yAxisId}
410
+ scale={props.scale}
411
+ type={props.type}
412
+ domain={props.domain}
413
+ allowDataOverflow={props.allowDataOverflow}
414
+ dataKey={props.dataKey}
415
+ allowDuplicatedCategory={props.allowDuplicatedCategory}
416
+ allowDecimals={props.allowDecimals}
417
+ tickCount={props.tickCount}
418
+ niceTicks={props.niceTicks}
419
+ padding={props.padding}
420
+ includeHidden={props.includeHidden}
421
+ reversed={props.reversed}
422
+ ticks={props.ticks}
423
+ width={props.width}
424
+ orientation={props.orientation}
425
+ mirror={props.mirror}
426
+ hide={props.hide}
427
+ unit={props.unit}
428
+ name={props.name}
429
+ angle={props.angle}
430
+ minTickGap={props.minTickGap}
431
+ tick={
432
+ typeof props.tick === "function"
433
+ ? (props.tick as (p: unknown) => JSX.Element)
434
+ : props.tick
435
+ }
436
+ tickFormatter={props.tickFormatter}
437
+ />
438
+ <YAxisImpl {...props} />
439
+ </>
440
+ )
441
+ }
442
+
443
+ YAxis.displayName = "YAxis"
@@ -0,0 +1,155 @@
1
+ /* eslint-disable import/no-cycle */
2
+ import { onCleanup, useContext, createEffect } from 'solid-js';
3
+ import { AxisDomain, BaseAxisProps, DataKey, ScaleType } from "../util/types"
4
+ import type { AxisId, ZAxisSettings } from "../state/cartesianAxisSlice"
5
+ import { RechartsStateContext } from "../state/RechartsStateContext"
6
+ import { AxisRange, implicitZAxis } from "../state/selectors/axisSelectors"
7
+ import { resolveDefaultProps } from "../util/resolveDefaultProps"
8
+ import { CustomScaleDefinition } from "../util/scale/CustomScaleDefinition"
9
+ import { teardownWrite } from "../state/teardownWrite"
10
+
11
+ function SetZAxisSettings(props: ZAxisSettings): null {
12
+ const stateCtx = useContext(RechartsStateContext)
13
+ let prevSettings: ZAxisSettings | null = null
14
+
15
+ createEffect(
16
+ () => ({ ...props }),
17
+ (settings) => {
18
+ /* upstream replaceZAxis: a changed id drops the previous entry */
19
+ if (prevSettings != null && String(prevSettings.id) !== String(settings.id)) {
20
+ const prevId = String(prevSettings.id)
21
+ stateCtx?.setState("cartesianAxes", "zAxis", (axes) => {
22
+ delete axes[prevId]
23
+ })
24
+ }
25
+ stateCtx?.setState("cartesianAxes", "zAxis", String(settings.id), { settings })
26
+ prevSettings = settings
27
+ },
28
+ )
29
+
30
+ onCleanup(() => {
31
+ teardownWrite(() => {
32
+ if (prevSettings) {
33
+ const strId = String(prevSettings.id)
34
+ /* eslint-disable-next-line solid/reactivity -- cleanup runs outside tracking; intentional */
35
+ stateCtx?.setState("cartesianAxes", "zAxis", (axes) => { delete axes[strId] })
36
+ prevSettings = null
37
+ }
38
+ })
39
+ })
40
+
41
+ return null
42
+ }
43
+
44
+ export interface Props<DataPointType = unknown, DataValueType = unknown> extends Omit<
45
+ BaseAxisProps<DataPointType, DataValueType>,
46
+ "domain"
47
+ > {
48
+ /**
49
+ * The type of axis.
50
+ *
51
+ * `category`: Treats data as distinct values.
52
+ * Each value is in the same distance from its neighbors, regardless of their actual numeric difference.
53
+ *
54
+ * `number`: Treats data as continuous range.
55
+ * Values that are numerically closer are placed closer together on the axis.
56
+ *
57
+ * @defaultValue number
58
+ */
59
+ type?: "number" | "category"
60
+ /**
61
+ * The unique id of z-axis.
62
+ *
63
+ * @defaultValue 0
64
+ */
65
+ zAxisId?: AxisId
66
+ /**
67
+ * The range of axis.
68
+ * Unlike other axes, the range of z-axis is not informed by chart dimensions.
69
+ *
70
+ * @defaultValue [64,64]
71
+ */
72
+ range?: AxisRange
73
+ /**
74
+ * Specify the domain of axis when the axis is a number axis.
75
+ *
76
+ * If undefined, then the domain is calculated based on the data and dataKeys.
77
+ *
78
+ * The length of domain should be 2, and we will validate the values in domain.
79
+ *
80
+ * Each element in the array can be a number, 'auto', 'dataMin', 'dataMax', a string like 'dataMin - 20', 'dataMax + 100',
81
+ * or a function that accepts a single argument and returns a number.
82
+ *
83
+ * If any element of domain is set to be 'auto', comprehensible scale ticks will be calculated, and the final domain of axis is generated by the ticks.
84
+ * If a function, receives '[dataMin, dataMax]', and must return a computed domain as '[min, max]'.
85
+ *
86
+ * @example <ZAxis type="number" domain={['dataMin', 'dataMax']} />
87
+ * @example <ZAxis type="number" domain={[0, 'dataMax']} />
88
+ * @example <ZAxis type="number" domain={['auto', 'auto']} />
89
+ * @example <ZAxis type="number" domain={[0, 'dataMax + 1000']} />
90
+ * @example <ZAxis type="number" domain={['dataMin - 100', 'dataMax + 100']} />
91
+ * @example <ZAxis type="number" domain={[dataMin => (0 - Math.abs(dataMin)), dataMax => (dataMax * 2)]} />
92
+ * @example <ZAxis type="number" domain={([dataMin, dataMax]) => { const absMax = Math.max(Math.abs(dataMin), Math.abs(dataMax)); return [-absMax, absMax]; }} />
93
+ * @example <ZAxis type="number" domain={[0, 100]} allowDataOverflow />
94
+ */
95
+ domain?: AxisDomain
96
+ /**
97
+ * Scale function determines how data values are mapped to visual values.
98
+ * In other words, decided the mapping between data domain and coordinate range.
99
+ *
100
+ * If undefined, or 'auto', the scale function is created internally according to the type of axis and data.
101
+ *
102
+ * You can define a custom scale, either as a string shortcut to a d3 scale, or as a complete scale definition object.
103
+ *
104
+ * @defaultValue auto
105
+ * @example <ZAxis scale="log" />
106
+ * @example
107
+ * import { scaleLog } from 'd3-scale';
108
+ * const scale = scaleLog().base(Math.E);
109
+ * <ZAxis scale={scale} />
110
+ */
111
+ scale?:
112
+ | ScaleType
113
+ | CustomScaleDefinition
114
+ | CustomScaleDefinition<string>
115
+ | CustomScaleDefinition<number>
116
+ | CustomScaleDefinition<Date>
117
+ }
118
+
119
+ export const zAxisDefaultProps = {
120
+ range: implicitZAxis.range,
121
+ scale: implicitZAxis.scale,
122
+ type: implicitZAxis.type,
123
+ zAxisId: 0,
124
+ } as const satisfies Partial<Props>
125
+
126
+ /**
127
+ * Virtual axis, does not render anything itself. Has no ticks, grid lines, or labels.
128
+ * Useful for dynamically setting Scatter point size, based on data.
129
+ *
130
+ * @consumes CartesianViewBoxContext
131
+ */
132
+ export function ZAxis<DataPointType = unknown, DataValueType = unknown>(
133
+ outsideProps: Props<DataPointType, DataValueType>,
134
+ ) {
135
+ const props = resolveDefaultProps(outsideProps, zAxisDefaultProps)
136
+ return (
137
+ <SetZAxisSettings
138
+ domain={props.domain}
139
+ id={props.zAxisId}
140
+ /* settings are untyped; the generic only constrains what callers pass */
141
+ dataKey={props.dataKey as DataKey<unknown>}
142
+ name={props.name}
143
+ unit={props.unit}
144
+ range={props.range}
145
+ scale={props.scale}
146
+ type={props.type}
147
+ allowDuplicatedCategory={implicitZAxis.allowDuplicatedCategory}
148
+ allowDataOverflow={implicitZAxis.allowDataOverflow}
149
+ reversed={implicitZAxis.reversed}
150
+ includeHidden={implicitZAxis.includeHidden}
151
+ />
152
+ )
153
+ }
154
+
155
+ ZAxis.displayName = "ZAxis"
@@ -0,0 +1,29 @@
1
+ import type { TextAnchor, TextVerticalAnchor } from "../component/Text"
2
+
3
+ /**
4
+ * CalculatedCartesianPosition returns horizontalAnchor and verticalAnchor
5
+ * which work directly with an SVG text element
6
+ * but for use in HTML context we have to translate them into CSS transform(translate)
7
+ * so this is what this function is doing.
8
+ *
9
+ * @param horizontalPosition as returned from {@link getCartesianPosition}
10
+ * @param verticalPosition as returned from {@link getCartesianPosition}
11
+ * @return CSS transform string
12
+ */
13
+ export function cartesianPositionToCSSTranslate(
14
+ horizontalPosition: TextAnchor,
15
+ verticalPosition: TextVerticalAnchor,
16
+ ): string {
17
+ /* 'start' / 'start' is the default HTML behavior, no transform needed */
18
+ if (horizontalPosition === "start" && verticalPosition === "start") {
19
+ return ""
20
+ }
21
+
22
+ const horizontalValues = { end: "-100%", middle: "-50%", start: "0" }
23
+ const verticalValues = { end: "-100%", middle: "-50%", start: "0" }
24
+
25
+ const x = horizontalPosition === "inherit" ? "0" : horizontalValues[horizontalPosition]
26
+ const y = verticalValues[verticalPosition] ?? "0"
27
+
28
+ return `translate(${x}, ${y})`
29
+ }
@@ -0,0 +1,21 @@
1
+ import type { CartesianViewBoxRequired, TrapezoidViewBox } from "../util/types"
2
+
3
+ export function cartesianViewBoxToTrapezoid(box: undefined): undefined
4
+ export function cartesianViewBoxToTrapezoid(
5
+ box: CartesianViewBoxRequired | TrapezoidViewBox,
6
+ ): TrapezoidViewBox
7
+ export function cartesianViewBoxToTrapezoid(
8
+ box: CartesianViewBoxRequired | TrapezoidViewBox | undefined,
9
+ ): TrapezoidViewBox | undefined {
10
+ if (box == null) {
11
+ return undefined
12
+ }
13
+ return {
14
+ height: box.height,
15
+ lowerWidth: "lowerWidth" in box ? box.lowerWidth : box.width,
16
+ upperWidth: "upperWidth" in box ? box.upperWidth : box.width,
17
+ width: box.width,
18
+ x: box.x,
19
+ y: box.y,
20
+ }
21
+ }