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 the actual palette of brushes to use for coloring the slices.
Gets the actual color for labels rendered inside of the pie chart.
Gets the actual color for labels rendered outside of the pie chart.
Gets the actual palette of brushes to use for outlines on the slices.
Resolved pixel scaling ratio. Unless explicitly overridden by the PieChartBase.PixelScalingRatio property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value.
Gets or sets whether the slices can be exploded.
Gets or sets whether the slices can be selected.
Gets or sets the palette of brushes to use for coloring the slices.
Determines how much the exploded slice is offset from the center. Value between 0 and 1.
Gets or sets the collection of exploded slice indices.
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 the amount of space between the center and the start of the arc. This property should be set between 0 and 1. If InnerExtent is set to a value greater than 1, it will be interpreted as a percentage, effectively divided by 100.
Gets or sets whether the pie chart will handle drag interaction and make them avaiilable in its events.
Gets or sets whether all surface interactions with the plot area should be disabled.
Raised when the slice's label is clicked.
Raised when the slice's label is clicked.
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 margin between a label and the end of its leader line. The default is 6 pixels.
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.
Determines display mode for zero values in the legend. For example, handling zero values as valid slices and providing them with proper appearance settings.
Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the chart object itself.
Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the chart object itself.
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.
Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.
Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.
Gets or sets the currently selected data item. If a different data item is provided the pie chart will select the slice associated with the new item.
Raised when the SelectedItem property has changed.
Raised when the SelectedItem property has changed.
Raised when the SelectedItem property is changing. This event is cancelable.
Raised when the SelectedItem property is changing. This event is cancelable.
Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the slices associated with those items.
Raised when the SelectedItems collection has changed.
Raised when the SelectedItems collection has changed.
Raised when the SelectedItems collection is changing. This event is cancelable.
Raised when the SelectedItems collection is changing. This event is cancelable.
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 which mode to use for selecting slices.
Gets or sets whether the pie chart should display mock data when data isn't present.
Gets or sets whether the pie chart should use a skeleton style for mock data.
Raised when the slice is clicked.
Raised when the slice is clicked.
Raised when a slice is entered by the pointer.
Raised when a slice is entered by the pointer.
Raised when a pointer moves over a slice.
Raised when a pointer moves over a slice.
Raised when a slice is left by the pointer;
Raised when a slice is left by the pointer;
Gets or sets the starting angle of the chart. The default zero value is equivalent to 3 o'clock.
Gets or sets the rotational direction of the chart.
Manually overrides the style to use for the labels.
Gets or sets the ToolTip for the chart.
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
Use to force the pie chart to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the pie chart needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the pie chart.
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 the base class for the pie chart.