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 scaling value used by the component 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 sparkline brush.
Gets or sets the position of the normal range on the sparkline.
Gets or sets the display type of the sparkline.
Gets or sets the first marker brush of the sparkline.
Gets or sets the first marker size of the sparkline.
Gets or sets the first marker visibility of the sparkline.
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.
Gets or sets the high marker brush of the sparkline.
Gets or sets the high marker size of the sparkline.
Gets or sets the high marker visibility of the sparkline.
Gets or sets the horizontal axis line brush of the sparkline.
The value or content to display on the horizontal axis. This can be set to a formatted string, such as "{0}", or it can be set to a DataTemplate.
Gets or sets the display state of the horizontal axis.
Gets or sets the label composite format used when creating label values.
Gets or sets the format specifiers to use with the HorizontalLabelFormat string.
String identifier of a column or property name to get labels from on each item in the data source. These labels will be retrieved from the first and last item, and displayed by the horizontal axis.
Gets or sets the last marker brush of the sparkline.
Gets or sets the last marker size of the sparkline.
Gets or sets the last marker visibility of the sparkline.
Gets or sets the line thickness of the sparkline.
Gets or sets the low marker brush of the sparkline.
Gets or sets the low marker size of the sparkline.
Gets or sets the low marker visibility of the sparkline.
Gets or sets the marker brush of the sparkline.
Gets or sets the marker size of the sparkline.
Gets or sets the marker visibility of the sparkline.
Gets or sets the maximum value of the y axis.
Gets or sets the minimum value of the y axis.
Gets or sets the negative brush of the sparkline.
Gets or sets the negative marker brush of the sparkline.
Gets or sets the negative marker size of the sparkline.
Gets or sets the negative marker visibility of the sparkline.
Gets or sets the normal range brush of the sparkline.
Gets or sets the maximum value of the normal range.
Gets or sets the minimum value of the normal range.
Gets or sets the normal range visibility of the sparkline.
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 trendline brush of the sparkline.
Gets or sets the trendline period used by the sparkline.
Gets or sets the thickness of the sparkline's trendline.
Gets or sets the type of trendline used by the sparkline.
Gets or sets the way null values are interpreted.
Gets or sets the string path to the value column.
Gets or sets the vertical axis line brush of the sparkline.
The value or content to display on the vertical axis. This can be set to a formatted string, such as "{0:n}", or it can be set to a DataTemplate.
Gets or sets the display state of the vertical axis.
Gets or sets the label composite format used when creating label values.
Gets or sets the format specifiers to use with the VerticalLabelFormat string.
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
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
If using the new style context, re-declare this in your class to be the
React.ContextType
of yourstatic contextType
. Should be used with type annotation or static contextType.