Renders the radius axis in a polar chart. The PolarRadiusAxis component displays the radial axis, showing scale values from the center outward.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/recharts/recharts/llms.txt
Use this file to discover all available pages before exploring further.
Usage
Props
Data
The key of data displayed on this axis.Can be a string, number, function, or array path.
The name of the data displayed on this axis.
Axis configuration
The id of this radius axis.Used to reference this axis from other components.
The type of axis.
category: Treats data as distinct values. Each value is equidistant from its neighbors.number: Treats data as continuous range. Closer values are placed closer together.auto: Type is inferred based on the chart layout.
The domain of the axis when type is ‘number’.Examples:
['dataMin', 'dataMax']: Auto-calculated from data[0, 'dataMax']: Fixed minimum, auto maximum['auto', 'auto']: Calculated with nice ticks[0, 100]: Fixed range[(dataMin) => dataMin - 10, (dataMax) => dataMax + 10]: Function-based
The scale function for mapping data values to coordinates.Can be ‘auto’, a d3 scale type string, or a custom scale definition.
Position
The angle of the entire axis: the line, ticks, and labels.Measured in degrees from the positive x-axis.
The orientation of tick labels.
left: Labels on the left side of the axis lineright: Labels on the right side of the axis linemiddle: Labels centered on the axis line
Ticks
Controls how individual tick labels are rendered.Options:
false: No tick labelstrue: Default tick labelsobject: Props merged with calculated tick propsReactElement: Custom tick elementfunction: Render function for custom ticks
Custom array of tick values.If specified, overrides automatic tick generation.
The number of ticks to display.Not used when type is ‘category’.
Function to format tick values.Signature:
(value: any, index: number) => stringControls how Recharts calculates “nice” tick values.Options: ‘none’, ‘auto’, ‘adaptive’, ‘snap125’
Axis line
Controls the axis line element.Options:
false: No axis linetrue: Default axis line with default propsobject: Props for the SVG line element
Appearance
The stroke color of the axis line and labels.
The stroke width of the axis line.
Behavior
Whether to allow decimal values in ticks.
Whether to allow duplicated categories when type is ‘category’.
If true, allows data to extend beyond the specified domain.
If true, reverses the direction of the axis.
If true, includes hidden graphical items when calculating the domain.
Label
The label for the axis.Can be a string, number, React element, or render function.
Display
The z-index of the axis.Higher values render on top of lower values.
Interaction
Event handler for click events on axis ticks.Signature:
(data: any, index: number, e: React.MouseEvent) => voidEvent handler for mouse enter events on ticks.
Event handler for mouse leave events on ticks.
Other
CSS class name for the axis element.