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 whether and how to display the highlighted value.
Gets the actual opacity of the primary needle while highlighting
Gets or sets whether to allow slices to be selected.
Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take.
Gets or sets the palette of brushes to use for coloring the slices.
Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.
Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.
Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.
Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.
Gets or sets how the heights of the funnel slices should be configured.
Gets or sets whether and how to display the highlighted value.
Gets or sets the opacity while highlighting
Gets or sets the highlighted value member path for the funnel chart.
Gets or sets the InnerLabel mapping property for the current series object.
Gets or sets whether the inner labels are visible.
Gets or sets if the funnel should be rendered inverted.
Gets or sets the legend used for the current chart.
Gets or sets the LegendItemBadgeTemplate to use for the legend items.
Gets or sets which side of the chart the outer labels should appear.
Gets or sets the OuterLabel mapping property for the current series object.
Gets or sets the brush used for the outer labels.
Gets or sets the text style for outer labels
Gets or sets whether the outer labels are visible.
Gets or sets the thickness of outline around slices.
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 fill brush.
Gets or sets the opacity.
Gets or sets the stroke brush.
Gets or sets the stroke thickness.
Event which is raised when a slice is clicked. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to igFunnelChart. Use ui.index to obtain index of clicked slice. Use ui.item to obtain reference to clicked slice item. Use ui.selected to check if slice became selected.
Event which is raised when a slice is clicked. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to igFunnelChart. Use ui.index to obtain index of clicked slice. Use ui.item to obtain reference to clicked slice item. Use ui.selected to check if slice became selected.
Raised when a funnel slice is entered.
Raised when a funnel slice is entered.
Raised when a funnel slice is hovered.
Raised when a funnel slice is hovered.
Raised when a funnel slice is left.
Raised when a funnel slice is left.
Gets or sets the brush used for the inner labels.
Gets or sets the text style for inner labels
Gets or sets how long the animations should take to run.
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 to use a Bezier curve to define the funnel.
Gets or sets whether to use the outer labels to identify the legend items.
Gets or sets whether to use the unselected style on unselected slices.
Gets or sets the value member path for the funnel chart.
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
Use to force the funnel chart to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the funnel chart needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the funnel 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
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.