PolarRadiusAxis

Properties

• angleNumber

  The angle of radial direction line to display axis text.

  DEFAULT: 0

• type'number' | 'category'

  The type of axis.

  DEFAULT: 'category'

• allowDuplicatedCategoryBoolean

  Allow the axis has duplicated categorys or not when the type of axis is "category".

  DEFAULT: true

• cxNumber

  The x-coordinate of center.

• cyNumber

  The y-coordinate of center.

• domainArray | Function

  Specify the domain of radius in a polar chart. And the length should be 2. And each element in the array can be a number, 'auto', 'dataMin' or 'dataMax'. 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. If a function, receives '[dataMin, dataMax]', and must return a computed domain as '[min, max]'.

  DEFAULT: [0, 'auto']

  FORMAT:

  <PolarRadiusAxis domain={['dataMin', 'dataMax']} />
  <PolarRadiusAxis domain={[0, 'dataMax']} />
  <PolarRadiusAxis domain={['auto', 'auto']} />
  <PolarRadiusAxis domain={([dataMin, dataMax]) => { const absMax = Math.max(Math.abs(dataMin), Math.abs(dataMax)); return [-absMax, absMax]; }} />

• reversedBooleanoptional

  If set to true, the ticks of this axis are reversed.

  DEFAULT: false

• labelString | Number | ReactElement | Functionoptional

  If set a string or a number, default label will be drawn, and the option is content. If set a React element, the option is the custom react element of drawing label. If set a function, the function will be called to render customized label.

• orientation"left" | "right" | "middle"

  The orientation of axis text.

  DEFAULT: right

• axisLineBool | Object

  If false set, axis line will not be drawn. If true set, axis line will be drawn which have the props calculated internally. If object set, axis line will be drawn which have the props merged by the internal calculated props and the option.

  DEFAULT: true

• tickBool | Object | Element | Function

  If false set, ticks will not be drawn. If true set, ticks will be drawn which have the props calculated internally. If object set, ticks will be drawn which have the props merged by the internal calculated props and the option. If ReactElement set, the option can be the custom tick element. If set a function, the function will be called to render customized ticks.

  DEFAULT: true

• tickFormatterFunction

  The function to formatting tick.

• tickCountNumber

  The count of axis ticks. Not used if 'type' is 'category'.

  DEFAULT: 5

• scale'auto' | 'linear' | 'pow' | 'sqrt' | 'log' | 'identity' | 'time' | 'band' | 'point' | 'ordinal' | 'quantile' | 'quantize' | 'utc' | 'sequential' | 'threshold' | Function

  If 'auto' set, the scale funtion is linear scale.

  DEFAULT: auto

  FORMAT:

  <PolarRadiusAxis scale="log" />
  
  import { scaleLog } from 'd3-scale';
  const scale = scaleLog().base(Math.E);
  
  ...
  <PolarRadiusAxis scale={scale} />
  ...
  

• onClickFunctionoptional

  The customized event handler of click on the ticks of this axis

• onMouseDownFunctionoptional

  The customized event handler of mousedown on the the ticks of this axis

• onMouseUpFunctionoptional

  The customized event handler of mouseup on the ticks of this axis

• onMouseMoveFunctionoptional

  The customized event handler of mousemove on the ticks of this axis

• onMouseOverFunctionoptional

  The customized event handler of mouseover on the ticks of this axis

• onMouseOutFunctionoptional

  The customized event handler of mouseout on the ticks of this axis

• onMouseEnterFunctionoptional

  The customized event handler of mouseenter on the ticks of this axis

• onMouseLeaveFunctionoptional

  The customized event handler of mouseleave on the ticks of this axis