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 highlighting mode used.
Gets or sets the resolved scaling value used to affect the pixel density of the control while it is animating. 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 root title to use for breadcrumbs.
Gets or sets the path to use to get the custom value of the items.
Gets or sets the dark text color to use for the nodes.
Gets or sets the (possibly hierarchical) data to assign to the TreeMap.
Gets or sets brushes to use for the fill scale.
Gets or sets the logarithm base to use if the fill scale is logarithmic.
Gets or sets the maximum value to use for the fill scale.
Gets or sets the minimum value to use for the fill scale.
Gets or sets mode to use for the fill scale.
Gets or sets the item to drill to in the treemap.
Gets or sets the background to use for the header.
Gets or sets the dark text color to use for the header.
Gets or sets the font to use for header nodes
Gets or sets the height to use for the header.
Gets or sets the background to use for the header when it is hovered.
Gets or sets the dark text color to use for the header when hovered.
Gets or sets the text color to use for the header.
Gets or sets the bottom margin to use for the header.
Gets or sets the left margin to use for the header.
Gets or sets the right margin to use for the header.
Gets or sets the top margin to use for the header.
Gets or sets the text color to use for the header.
Gets or sets the font to use for header nodes
Gets or sets the data to highlight.
Gets or sets the highlighted value mapping property.
Gets or sets the opacity applied to the node underneath the highlighted value.
Gets or sets the display mode for highlighted values.
Gets or sets the opacity to use for nodes that are not highlighted when HighlightingMode is set to FadeOthers.
Gets or sets the highlighting mode to use.
Gets or sets the number of milliseconds over which the highlighting effect will render.
Gets or sets the path to use to get the id of the items.
Gets or sets the scaling value used to affect the pixel density of the control while it is animating. 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 whether the fill scale is logarithmic.
Gets or sets the bottom margin to use for the labels.
Gets or sets the horizontal alignment to use for the node labels.
Gets or sets the horizontal fit mode to use for the node labels.
Gets or sets the left margin to use for the labels.
Gets or sets the path to use to get the Label of the items.
Gets or sets the right margin to use for the labels.
Gets or sets the top margin to use for the labels.
Gets or sets the vertical alignment to use for the node labels.
Gets or sets the vertical fit mode to use for the node labels.
Gets or sets the orientation to use for the stripped and slice and dice layout types.
Gets or sets the type of layout to use for the nodes.
Gets or sets the minimum size (width or height) to display a node.
Gets or sets the opacity to use for the nodes.
Fired when the pointer enters a node.
Fired when the pointer enters a node.
Fired when the pointer leaved a node.
Fired when the pointer leaved a node.
Fired with the pointer is moving over a node.
Fired with the pointer is moving over a node.
Fired when the pointer is pressed on a node.
Fired when the pointer is pressed on a node.
Fired when the pointer is released on a node.
Fired when the pointer is released on a node.
Fired before a node is rendered for last minute style changes.
Fired before a node is rendered for last minute style changes.
Fired when a node is being styled. Provides an opportunity to customize node styling.
Fired when a node is being styled. Provides an opportunity to customize node styling.
Gets or sets the outline to use for the nodes.
Gets or sets the background to use for the overlay header.
Gets or sets the background to use for the overlay header when it is hovered.
Gets or sets the bottom margin to use for the overlay header.
Gets or sets the left margin to use for the overlay header.
Gets or sets the right margin to use for the overlay header.
Gets or sets the top margin to use for the overlay header.
Gets or sets the path to use to get the Parent of the items.
Gets or sets the bottom margin to use for the parent nodes.
Gets or sets the bottom padding to use for the parent nodes.
Gets or sets the left margin to use for the parent nodes.
Gets or sets the left padding to use for the parent nodes.
Gets or sets the right margin to use for the parent nodes.
Gets or sets the right padding to use for the parent nodes.
Gets or sets the top margin to use for the parent nodes.
Gets or sets the top padding to use for the parent nodes.
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 root title to use for breadcrumbs.
Gets or sets the stroke thickness to use for the node outline.
A collection of manually added style mappings for the treemap.
Gets or sets the text color to use for the nodes.
Gets or sets the font to use for content nodes
Gets or sets the number of milliseconds over which changes to the gauge should be animated.
Gets or sets path to use to get the values from the items.
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.
The style mappings actually present in the treemap. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing ranges from the manual ranges collection on the ranges property.