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 whether or not at least one badge is visible based on BadgesShape and setting of a row's IsVisble in StyleSeriesRow event
Gets the actual pixel scaling ratio 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 BadgeShape for the data legend.
Event raised when calculating summary value for each column in data legend
Event raised when calculating summary value for each column in data legend
Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property
Gets or sets indexes, titles, or names of series to exclude from displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property
Gets or sets whether to show Header row.
Gets or sets the Group text color.
Gets or Sets the style to use for the Group text.
Gets or sets globalization culture applied to header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties
Gets or sets date format for the header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties
Gets or sets the format specifiers to use with the HeaderFormatString string.
Gets or sets the format string for header text displayed in the data legend.
Gets or sets time format for the header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties
Gets or sets whether to show Header row.
Gets or sets the HeaderText for the data legend.
Gets or sets the header text color.
Gets or Sets the style to use for the header text.
Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property
Gets or sets indexes, titles, or names of series to include in displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property
Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series
Gets or sets the units text color.
Gets or Sets the style to use for the units text.
Gets or sets the layout of content in the data legend
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 whether the data legend should update when the series data is mutated.
Event raised when styling the group row
Event raised when styling the group row
Event raised when styling the header row
Event raised when styling the header row
Event raised when styling the label, value, and unit columns in series rows
Event raised when styling the label, value, and unit columns in series rows
Event raised when styling title and badge in series rows
Event raised when styling title and badge in series rows
Event raised when styling the label, value, and unit columns in summary row
Event raised when styling the label, value, and unit columns in summary row
Event raised when styling title in the summary row
Event raised when styling title in the summary row
Gets or sets the units text for the data legend.
Gets or sets the units text color.
Gets or Sets the style to use for the units text.
Gets or sets the SummaryTitleText for the data legend.
Gets or sets the summary text color.
Gets or Sets the style to use for the summary text.
Gets or sets the SummaryType for the data legend.
Gets or sets the units text for the data legend.
Gets or sets the units text color.
Gets or Sets the style to use for the units text.
Gets or sets the units text color.
Gets or Sets the style to use for the units text.
Gets or sets the target for the data legend.
Gets or sets horizontal position (between 0.0 and 1.0) in viewport of the target component
Gets or sets vertical position (between 0.0 and 1.0) in viewport of the target component
Gets or sets the display text color.
Gets or Sets the style to use for the display text.
Gets or sets the UnitsMode for the data legend.
Gets or sets the units text for the data legend.
Gets or sets the units text color.
Gets or Sets the style to use for the units text.
Gets or sets mode for abbreviating large numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
Gets or sets the currency code used for displaying currency symbol next to values, e.g. USD for $, EUR for € This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
Gets or sets maximum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
Gets or sets minimum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)
Gets or sets the format specifiers to use with the ValueFormatString string.
Gets or sets the format string for values displayed in the data legend.
Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
Gets or sets whether to show series rows.
Gets or sets the units text color.
Gets or Sets the style to use for the units text.
Gets or sets whether to use series colors when displaying values in the legend
Gets or sets text displayed when data column is missing a value, e.g. "no data"
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.
Represents data legend that displays information about each series including values and summaries.