@sqlrooms/recharts / PolarRadiusAxis

Class: PolarRadiusAxis

Extends

• PureComponent<PolarRadiusAxisProps>

Constructors

new PolarRadiusAxis()

new PolarRadiusAxis(props): PolarRadiusAxis

Parameters

Parameter	Type
props	PolarRadiusAxisProps

Returns

PolarRadiusAxis

Inherited from

PureComponent<Props>.constructor

new PolarRadiusAxis()

new PolarRadiusAxis(props, context): PolarRadiusAxis

Parameters

Parameter	Type
props	PolarRadiusAxisProps
context	any

Returns

PolarRadiusAxis

Deprecated

See

React Docs

Inherited from

PureComponent<Props>.constructor

Properties

Property	Modifier	Type	Description	Inherited from
contextType?	static	Context<any>	If set, this.context will be set at runtime to the current value of the given Context. Example type MyContext = number const Ctx = React.createContext<MyContext>(0) class Foo extends React.Component { static contextType = Ctx context!: React.ContextType<typeof Ctx> render () { return <>My context's value: {this.context}</>; } } See https://react.dev/reference/react/Component#static-contexttype	PureComponent.contextType
context	public	unknown	If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType. Example static contextType = MyContext // For TS pre-3.7: context!: React.ContextType<typeof MyContext> // For TS 3.7 and above: declare context: React.ContextType<typeof MyContext> See React Docs	PureComponent.context
props	readonly	Readonly<PolarRadiusAxisProps>	-	PureComponent.props
state	public	Readonly<{}>	-	PureComponent.state
refs	public	object	Deprecated See Legacy React Docs	PureComponent.refs
displayName	static	string	-	-
axisType	static	string	-	-
defaultProps	static	object	-	-
defaultProps.type	public	string	-	-
defaultProps.radiusAxisId	public	number	-	-
defaultProps.cx	public	number	-	-
defaultProps.cy	public	number	-	-
defaultProps.angle	public	number	-	-
defaultProps.orientation	public	string	-	-
defaultProps.stroke	public	string	-	-
defaultProps.axisLine	public	boolean	-	-
defaultProps.tick	public	boolean	-	-
defaultProps.tickCount	public	number	-	-
defaultProps.allowDataOverflow	public	boolean	-	-
defaultProps.scale	public	string	-	-
defaultProps.allowDuplicatedCategory	public	boolean	-	-

Methods

setState()

setState<K>(state, callback?): void

Type Parameters

Type Parameter
K extends never

Parameters

Parameter	Type
state	null | {} | (prevState, props) => null | {} | Pick<{}, K> | Pick<{}, K>
callback?	() => void

Returns

void

Inherited from

PureComponent.setState

---

forceUpdate()

forceUpdate(callback?): void

Parameters

Parameter	Type
callback?	() => void

Returns

void

Inherited from

PureComponent.forceUpdate

---

componentDidMount()?

optional componentDidMount(): void

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns

void

Inherited from

PureComponent.componentDidMount

---

shouldComponentUpdate()?

optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component.render, componentWillUpdate and componentDidUpdate will not be called.

Parameters

Parameter	Type
nextProps	Readonly<PolarRadiusAxisProps>
nextState	Readonly<{}>
nextContext	any

Returns

boolean

Inherited from

PureComponent.shouldComponentUpdate

---

componentWillUnmount()?

optional componentWillUnmount(): void

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns

void

Inherited from

PureComponent.componentWillUnmount

---

componentDidCatch()?

optional componentDidCatch(error, errorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters

Parameter	Type
error	Error
errorInfo	ErrorInfo

Returns

void

Inherited from

PureComponent.componentDidCatch

---

getSnapshotBeforeUpdate()?

optional getSnapshotBeforeUpdate(prevProps, prevState): any

Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.

Note: the presence of this method prevents any of the deprecated lifecycle events from running.

Parameters

Parameter	Type
prevProps	Readonly<PolarRadiusAxisProps>
prevState	Readonly<{}>

Returns

any

Inherited from

PureComponent.getSnapshotBeforeUpdate

---

componentDidUpdate()?

optional componentDidUpdate(prevProps, prevState, snapshot?): void

Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

Parameters

Parameter	Type
prevProps	Readonly<PolarRadiusAxisProps>
prevState	Readonly<{}>
snapshot?	any

Returns

void

Inherited from

PureComponent.componentDidUpdate

---

componentWillMount()?

optional componentWillMount(): void

Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns

void

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead; will stop working in React 17

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Inherited from

PureComponent.componentWillMount

---

UNSAFE_componentWillMount()?

optional UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns

void

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Inherited from

PureComponent.UNSAFE_componentWillMount

---

componentWillReceiveProps()?

optional componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component.setState generally does not trigger this method.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

Parameter	Type
nextProps	Readonly<PolarRadiusAxisProps>
nextContext	any

Returns

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead; will stop working in React 17

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Inherited from

PureComponent.componentWillReceiveProps

---

UNSAFE_componentWillReceiveProps()?

optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component.setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

Parameter	Type
nextProps	Readonly<PolarRadiusAxisProps>
nextContext	any

Returns

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Inherited from

PureComponent.UNSAFE_componentWillReceiveProps

---

componentWillUpdate()?

optional componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component.setState here.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

Parameter	Type
nextProps	Readonly<PolarRadiusAxisProps>
nextState	Readonly<{}>
nextContext	any

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Inherited from

PureComponent.componentWillUpdate

---

UNSAFE_componentWillUpdate()?

optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component.setState here.

This method will not stop working in React 17.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

Parameter	Type
nextProps	Readonly<PolarRadiusAxisProps>
nextState	Readonly<{}>
nextContext	any

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Inherited from

PureComponent.UNSAFE_componentWillUpdate

---

getTickValueCoord()

getTickValueCoord(coordinate): Coordinate

Calculate the coordinate of tick

Parameters

Parameter	Type	Description
coordinate	TickItem	The radius of tick

Returns

Coordinate

(x, y)

---

getTickTextAnchor()

getTickTextAnchor(): string

Returns

string

---

getViewBox()

getViewBox(): object

Returns

object

Name	Type
cx	number
cy	number
startAngle	number
endAngle	number
innerRadius	number
outerRadius	number

---

renderAxisLine()

renderAxisLine(): Element

Returns

Element

---

renderTickItem()

static renderTickItem(option, props, value): Element

Parameters

Parameter	Type
option	undefined | boolean | SVGProps<SVGTextElement> | ReactElement<SVGElement, string | JSXElementConstructor<any>> | (props) => ReactElement<SVGElement>
props	any
value	string | number

Returns

Element

---

renderTicks()

renderTicks(): Element

Returns

Element

---

render()

render(): Element

Returns

Element

Overrides

PureComponent.render