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.
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>
Readonly
propsStatic
Optional
contextIf set, this.context
will be set at runtime to the current value of the given Context.
Usage:
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}</>;
}
}
Gets or sets the palette of brushes to use for coloring the slices.
Gets or sets the property name that contains the children items collection.
Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.
Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.
Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend.
Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend.
Gets or sets whether all surface interactions with the plot area should be disabled.
Gets or sets the pixel amount by which the labels are offset from the edge of the slices.
Gets or sets the label format string to use for the label.
Gets or sets the format specifiers to use with the LabelFormat string.
Gets or sets the color for labels rendered inside of the pie chart.
Gets or sets the property name that contains the labels.
Gets or sets the color for labels rendered outside of the pie chart.
Gets or sets the position of chart labels.
Gets or sets the fill brush.
Gets or sets the margin between a label and its leader line. The default is 6 pixels.
Gets or sets the opacity.
Gets or sets the stroke brush.
Gets or sets the stroke thickness.
Gets or sets what type of leader lines will be used for the outside end labels.
Gets or sets whether the leader lines are visible.
Gets or sets the label format string to use for the label.
Gets or sets the format specifiers to use with the LegendLabelFormat string.
Gets or sets the property name that contains the legend labels.
Gets or sets the label format string to use for the label.
Gets or sets the format specifiers to use with the LegendOthersLabelFormat string.
Gets or sets the fill brush.
Gets or sets the opacity.
Gets or sets the stroke brush.
Gets or sets the stroke thickness.
Gets or sets the label of the Others slice.
Gets or sets the threshold value that determines if slices are grouped into the Others slice.
Gets or sets whether to use numeric or percent-based threshold value.
Gets or sets the label format string to use for the label.
Gets or sets the format specifiers to use with the OthersLabelFormat string.
Gets or sets the palette of brushes to use for outlines on the slices.
Event raised when a property (including "effective" and non-dependency property) value changes.
Event raised when a property (including "effective" and non-dependency property) value changes.
Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.
Gets or sets the fill brush.
Gets or sets the opacity.
Gets or sets the stroke brush.
Gets or sets the stroke thickness.
Gets or sets whether default tooltip will be shown.
Gets or sets the starting angle of the chart. The default zero value is equivalent to 3 o'clock.
Gets or Sets the property name that contains the values.
Optional
UNSAFE_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 getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use componentDidMount or the constructor instead
Optional
UNSAFE_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 getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use static getDerivedStateFromProps instead
Optional
UNSAFE_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 getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use getSnapshotBeforeUpdate instead
Optional
componentOptional
componentCalled immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Optional
componentCalled immediately before mounting occurs, and before Component#render
.
Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use componentDidMount or the constructor instead; will stop working in React 17
Optional
componentCalled 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 getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use static getDerivedStateFromProps instead; will stop working in React 17
Optional
componentOptional
componentCalled 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 getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
Optional
getRuns before React applies the result of render
to the document, and
returns an object to be given to componentDidUpdate. Useful for saving
things such as scroll position before render
causes changes to it.
Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
Static
_create
Represents a IgxDoughnutChartComponent hierarchical series.