Represents a non-visual child of StackedSeriesBase.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrStackedFragmentSeries

Constructors

Properties

Accessors

Methods

Constructors

Properties

context: any

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>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If 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}</>;
}
}

Accessors

  • get actualAreaFillOpacity(): number
  • Gets the series ActualAreaFillOpacity. This property only applies for area-like series.

    Returns number

  • set actualAreaFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualBrush(): string
  • Gets the actual brush used by the series.

    Returns string

  • set actualBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualHighlightingFadeOpacity(): number
  • Gets the actual target opacity to fade to for fade style highlighting.

    Returns number

  • set actualHighlightingFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualIsDropShadowEnabled(): boolean
  • Gets whether drop shadow is actually enabled for this series.

    Returns boolean

  • set actualIsDropShadowEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualIsSplineShapePartOfRange(): boolean
  • Gets whether the spline part is considered to be part of the range

    Returns boolean

  • set actualIsSplineShapePartOfRange(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualIsTransitionInEnabled(): boolean
  • Gets the the resolved value of whether transition in is enabled.

    Returns boolean

  • set actualIsTransitionInEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualLegendItemBadgeMode(): LegendItemBadgeMode
  • Gets the actual LegendItemBadgeMode of the series.

    Returns LegendItemBadgeMode

  • set actualLegendItemBadgeMode(v): void
  • Parameters

    • v: LegendItemBadgeMode

    Returns void

  • get actualLegendItemBadgeShape(): LegendItemBadgeShape
  • Gets the actual LegendItemBadgeShape of the series.

    Returns LegendItemBadgeShape

  • set actualLegendItemBadgeShape(v): void
  • Parameters

    • v: LegendItemBadgeShape

    Returns void

  • get actualLegendItemBadgeTemplate(): IgDataTemplate
  • Gets the actual legend item badge template used by the series.

    Returns IgDataTemplate

  • set actualLegendItemBadgeTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get actualLegendItemTemplate(): IgDataTemplate
  • Gets the actual legend item template used by the series.

    Returns IgDataTemplate

  • set actualLegendItemTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get actualLegendItemVisibility(): Visibility
  • Gets the actual visibility of the legend items in the series.

    Returns Visibility

  • set actualLegendItemVisibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get actualLineCap(): PenLineCap
  • Gets the actual end cap used by the series.

    Returns PenLineCap

  • set actualLineCap(v): void
  • Parameters

    • v: PenLineCap

    Returns void

  • get actualMarkerBrush(): string
  • Gets the actual marker brush of the series.

    Returns string

  • set actualMarkerBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualMarkerFillMode(): MarkerFillMode
  • Gets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection.

    Returns MarkerFillMode

  • set actualMarkerFillMode(v): void
  • Parameters

    Returns void

  • get actualMarkerFillOpacity(): number
  • Gets the actual opacity to use for hte marker fills.

    Returns number

  • set actualMarkerFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualMarkerOutline(): string
  • Gets the actual marker outline of the series.

    Returns string

  • set actualMarkerOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get actualMarkerOutlineMode(): MarkerOutlineMode
  • Gets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.

    Returns MarkerOutlineMode

  • set actualMarkerOutlineMode(v): void
  • Parameters

    Returns void

  • get actualMarkerTemplate(): IgDataTemplate
  • Gets the actual marker template used by the series.

    Returns IgDataTemplate

  • set actualMarkerTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get actualMarkerThickness(): number
  • Gets actual marker thickness of this stacked fragment.

    Returns number

  • set actualMarkerThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get actualMarkerType(): MarkerType
  • Gets the actual marker type set used in the series.

    Returns MarkerType

  • set actualMarkerType(v): void
  • Parameters

    Returns void

  • get actualOpacity(): number
  • Gets the series opacity.

    Returns number

  • set actualOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualOutline(): string
  • Gets the series outline.

    Returns string

  • set actualOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get actualOutlineMode(): SeriesOutlineMode
  • Gets the actual outline mode to use for the fragment.

    Returns SeriesOutlineMode

  • set actualOutlineMode(v): void
  • Parameters

    Returns void

  • get actualRadiusX(): number
  • Gets the actual corner radius of the series

    Returns number

  • set actualRadiusX(v): void
  • Parameters

    • v: number

    Returns void

  • get actualRadiusY(): number
  • Gets the actual corner radius of the series

    Returns number

  • set actualRadiusY(v): void
  • Parameters

    • v: number

    Returns void

  • get actualShadowBlur(): number
  • Gets the actual shadow blur used by the series.

    Returns number

  • set actualShadowBlur(v): void
  • Parameters

    • v: number

    Returns void

  • get actualShadowColor(): string
  • Gets actual the drop shadow color used by the series.

    Returns string

  • set actualShadowColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualShadowOffsetX(): number
  • Gets the actual drop shadow x-offset applied to the series.

    Returns number

  • set actualShadowOffsetX(v): void
  • Parameters

    • v: number

    Returns void

  • get actualShadowOffsetY(): number
  • Gets the actual drop shadow y-offset applied to the series.

    Returns number

  • set actualShadowOffsetY(v): void
  • Parameters

    • v: number

    Returns void

  • get actualThickness(): number
  • Gets or sets the thickness of this stacked fragment.

    Returns number

  • set actualThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get actualTransitionDuration(): number
  • Gets the series transition duration.

    Returns number

  • set actualTransitionDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get actualTransitionEasingFunction(): ((time) => number)
  • Gets the series transition easing function.

    Returns ((time) => number)

      • (time): number
      • Gets the series transition easing function.

        Parameters

        • time: number

        Returns number

  • set actualTransitionEasingFunction(v): void
  • Parameters

    • v: ((time) => number)
        • (time): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get actualTransitionInDuration(): number
  • Gets the resolved transition in duration

    Returns number

  • set actualTransitionInDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get actualTransitionInEasingFunction(): ((time) => number)
  • Gets the series transition easing function.

    Returns ((time) => number)

      • (time): number
      • Gets the series transition easing function.

        Parameters

        • time: number

        Returns number

  • set actualTransitionInEasingFunction(v): void
  • Parameters

    • v: ((time) => number)
        • (time): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get actualTransitionInMode(): CategoryTransitionInMode
  • Gets the series transition easing function.

    Returns CategoryTransitionInMode

  • set actualTransitionInMode(v): void
  • Parameters

    Returns void

  • get actualTransitionInSpeedType(): TransitionInSpeedType
  • Gets the series transition easing function.

    Returns TransitionInSpeedType

  • set actualTransitionInSpeedType(v): void
  • Parameters

    Returns void

  • get actualUseSingleShadow(): boolean
  • Gets whether drop shadow is actually applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries.

    Returns boolean

  • set actualUseSingleShadow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualValueMemberAsLegendLabel(): string
  • Gets the label displayed before series value in the Data Legend.

    Returns string

  • set actualValueMemberAsLegendLabel(v): void
  • Parameters

    • v: string

    Returns void

  • get actualValueMemberAsLegendUnit(): string
  • Gets the unit displayed after series value in the Data Legend.

    Returns string

  • set actualValueMemberAsLegendUnit(v): void
  • Parameters

    • v: string

    Returns void

  • get actualVisibility(): Visibility
  • Gets the actual visibility of the stacked fragment.

    Returns Visibility

  • set actualVisibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get areaFillOpacity(): number
  • Gets or sets the AreaFillOpacity of the stacked fragment. This property only applies for area-like series.

    Returns number

  • set areaFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get brush(): string
  • Gets or sets the brush of the stacked fragment.

    Returns string

  • set brush(v): void
  • Parameters

    • v: string

    Returns void

  • get dashArray(): number[]
  • Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object.

    Returns number[]

  • set dashArray(v): void
  • Parameters

    • v: number[]

    Returns void

  • get dataSource(): any[]
  • Gets or sets the ItemsSource property for the current series object. Normally you will want to provide data to the parent series instead. But if you have data as individual columns, it can be assigned here. The data must be aligned and have the same number of items for each fragment.

    Returns any[]

  • set dataSource(v): void
  • Parameters

    • v: any[]

    Returns void

  • get highlightedDataSource(): any[]
  • Gets or sets the HighlightedItemsSource property for the current series object.

    Returns any[]

  • set highlightedDataSource(v): void
  • Parameters

    • v: any[]

    Returns void

  • get highlightingFadeOpacity(): number
  • Gets or sets the target opacity to fade to for fade style highlighting.

    Returns number

  • set highlightingFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get isDropShadowEnabled(): boolean
  • Gets or sets whether drop shadow should be enabled for this series.

    Returns boolean

  • set isDropShadowEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isSplineShapePartOfRange(): boolean
  • Gets or sets whether to include the spline shape in the axis range requested of the axis.

    Returns boolean

  • set isSplineShapePartOfRange(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isTransitionInEnabled(): boolean
  • Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series.

    Returns boolean

  • set isTransitionInEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get legendItemBadgeMode(): LegendItemBadgeMode
  • Gets or sets the mode of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on the series

    Returns LegendItemBadgeMode

  • set legendItemBadgeMode(v): void
  • Parameters

    • v: LegendItemBadgeMode

    Returns void

  • get legendItemBadgeShape(): LegendItemBadgeShape
  • Gets or sets the type of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on the series

    Returns LegendItemBadgeShape

  • set legendItemBadgeShape(v): void
  • Parameters

    • v: LegendItemBadgeShape

    Returns void

  • get legendItemBadgeTemplate(): IgDataTemplate
  • Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set legendItemBadgeTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get legendItemTemplate(): IgDataTemplate
  • Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set legendItemTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get legendItemVisibility(): Visibility
  • Gets or sets the legend item visibility for the current series object.

    Returns Visibility

  • set legendItemVisibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get lineCap(): PenLineCap
  • The style of the end points of any lines or polylines representing this series. Not every series type has a line at which it would be appropriate to display an end cap, so this property does not affect every series type. LineSeries, for example, is affected by EndCap, but ColumnSeries is not.

    Returns PenLineCap

  • set lineCap(v): void
  • Parameters

    • v: PenLineCap

    Returns void

  • get markerBrush(): string
  • Gets or sets the brush that specifies how the current series object's marker interiors are painted.

    Returns string

  • set markerBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get markerFillMode(): MarkerFillMode
  • Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection.

    Returns MarkerFillMode

  • set markerFillMode(v): void
  • Parameters

    Returns void

  • get markerFillOpacity(): number
  • Gets or sets the opacity to use for the marker fills.

    Returns number

  • set markerFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get markerOutline(): string
  • Gets or sets the brush that specifies how the current series object's marker outlines are painted.

    Returns string

  • set markerOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get markerOutlineMode(): MarkerOutlineMode
  • Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.

    Returns MarkerOutlineMode

  • set markerOutlineMode(v): void
  • Parameters

    Returns void

  • get markerTemplate(): IgDataTemplate
  • Gets or sets the MarkerTemplate for the current series object.

    Returns IgDataTemplate

  • set markerTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get markerThickness(): number
  • Gets or sets the width of the current series object's marker thickness.

    Returns number

  • set markerThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get markerType(): MarkerType
  • Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored.

    Returns MarkerType

  • set markerType(v): void
  • Parameters

    Returns void

  • get name(): string
  • Gets or sets the Name of the stacked fragment.

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get opacity(): number
  • Gets or sets the Opacity of the stacked fragment.

    Returns number

  • set opacity(v): void
  • Parameters

    • v: number

    Returns void

  • get outline(): string
  • Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

    Returns string

  • set outline(v): void
  • Parameters

    • v: string

    Returns void

  • get outlineMode(): SeriesOutlineMode
  • Gets or sets the outline mode to use for the fragment.

    Returns SeriesOutlineMode

  • set outlineMode(v): void
  • Parameters

    Returns void

  • get parentOrLocalBrush(): string
  • Gets the resolved brush used between the local series and the parent series.

    Returns string

  • set parentOrLocalBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get propertyUpdated(): ((s, e) => void)
  • Event raised when a property (including "effective" and non-dependency property) value changes.

    Returns ((s, e) => void)

  • set propertyUpdated(ev): void
  • Parameters

    Returns void

  • get radiusX(): number
  • Gets or sets the x-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series.

    Returns number

  • set radiusX(v): void
  • Parameters

    • v: number

    Returns void

  • get radiusY(): number
  • Gets or sets the y-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series.

    Returns number

  • set radiusY(v): void
  • Parameters

    • v: number

    Returns void

  • get shadowBlur(): number
  • Gets or sets the shadow blur. This property is ignored when StackedFragmentSeries.UseSingleShadow is set to true.

    Returns number

  • set shadowBlur(v): void
  • Parameters

    • v: number

    Returns void

  • get shadowColor(): string
  • Gets or sets the drop shadow color.

    Returns string

  • set shadowColor(v): void
  • Parameters

    • v: string

    Returns void

  • get shadowOffsetX(): number
  • Gets or sets the drop shadow x-offset.

    Returns number

  • set shadowOffsetX(v): void
  • Parameters

    • v: number

    Returns void

  • get shadowOffsetY(): number
  • Gets or sets the drop shadow y-offset.

    Returns number

  • set shadowOffsetY(v): void
  • Parameters

    • v: number

    Returns void

  • get thickness(): number
  • Gets or sets the width of the current series object's line thickness.

    Returns number

  • set thickness(v): void
  • Parameters

    • v: number

    Returns void

  • get title(): any
  • Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

    Returns any

  • set title(v): void
  • Parameters

    • v: any

    Returns void

  • get transitionDuration(): number
  • Gets or sets the duration of the current series's morph.

    Returns number

  • set transitionDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get transitionEasingFunction(): ((time) => number)
  • Gets or sets the EasingFunction used to morph the current series.

    Returns ((time) => number)

      • (time): number
      • Gets or sets the EasingFunction used to morph the current series.

        Parameters

        • time: number

        Returns number

  • set transitionEasingFunction(v): void
  • Parameters

    • v: ((time) => number)
        • (time): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get transitionInDuration(): number
  • Gets or sets the duration of the current series's transition in morph.

    Returns number

  • set transitionInDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get transitionInEasingFunction(): ((time) => number)
  • Gets or sets the EasingFunction used to morph the current series during the initial transition.

    Returns ((time) => number)

      • (time): number
      • Gets or sets the EasingFunction used to morph the current series during the initial transition.

        Parameters

        • time: number

        Returns number

  • set transitionInEasingFunction(v): void
  • Parameters

    • v: ((time) => number)
        • (time): number
        • Parameters

          • time: number

          Returns number

    Returns void

  • get transitionInMode(): CategoryTransitionInMode
  • Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series.

    Returns CategoryTransitionInMode

  • set transitionInMode(v): void
  • Parameters

    Returns void

  • get transitionInSpeedType(): TransitionInSpeedType
  • Gets or sets the duration of the current series's transition in morph.

    Returns TransitionInSpeedType

  • set transitionInSpeedType(v): void
  • Parameters

    Returns void

  • get useSingleShadow(): boolean
  • Gets or sets whether drop shadow is applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries. When this property is set to true, no StackedFragmentSeries.ShadowBlur is applied.

    Returns boolean

  • set useSingleShadow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get valueMemberAsLegendLabel(): string
  • Gets or sets the label displayed before series value in the Data Legend.

    Returns string

  • set valueMemberAsLegendLabel(v): void
  • Parameters

    • v: string

    Returns void

  • get valueMemberAsLegendUnit(): string
  • Gets or sets the unit displayed after series value in the Data Legend.

    Returns string

  • set valueMemberAsLegendUnit(v): void
  • Parameters

    • v: string

    Returns void

  • get valueMemberPath(): string
  • Gets or sets the value mapping property for the current series object.

    Returns string

  • set valueMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get visibility(): Visibility
  • Gets or sets the Visibility of the stacked fragment.

    Returns Visibility

  • set visibility(v): void
  • Parameters

    • v: Visibility

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Converts a point from world coordinates to coordinates within the viewport of the series.

    Parameters

    • world: IgPoint
      • The world position from which to convert.

    Returns IgPoint

  • Gets the effective viewport, adjusted to account for margins and other factors.

    Returns IgRect

  • Gets the item that is the best match for the specified world coordinates.

    Parameters

    • world: IgPoint
      • The world coordinates to use.

    Returns any

  • Gets the item index associated with the specified world position

    Parameters

    • world: IgPoint

    Returns number

  • For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

    Returns number

  • Parameters

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

    Parameters

    • world: IgPoint
      • The world coordinate for which to get a value bounding box for

    Returns IgRect

  • Parameters

    • mouse: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.

    Parameters

    • world: IgPoint
      • The world coordinates for which to get a value marker bounding box for

    Returns IgRect

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Parameters

    • mouse: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Runs 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.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Moves the cursor point to the provided world position. Some series may react to the current cursor position.

    Parameters

    • point: IgPoint
      • The cursor point, in world coordinates.

    Returns void

  • Notifies the series that a visual property has changed, requiring a visual update.

    Returns void

  • Returns any

  • Returns void

  • Requests that the provided item should be brought into view if possible.

    Parameters

    • item: any
      • The item to attempt to bring into view.

    Returns boolean

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Simulates a pointer hover over the series surface.

    Parameters

    • point: IgPoint
      • The pointer position relative to the series viewport over which to hover.

    Returns void

  • Converts a point from coordinates within the series plot area to a world position within axis space.

    Parameters

    • seriesPoint: IgPoint
      • The pixel location within the plot area of the series.

    Returns IgPoint