Represents a control for viewing series objects.

Type Parameters

Hierarchy

Hierarchy

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 actualContentHitTestMode(): ChartHitTestMode
  • Resolved method of hit testing used when the pointer is over elements in the chart.

    let actualContentHitTestMode: ChartHitTestMode  =this.chart.actualContentHitTestMode;
    

    Returns ChartHitTestMode

  • set actualContentHitTestMode(v): void
  • Parameters

    Returns void

  • get actualInteractionPixelScalingRatio(): number
  • Resolved method of pixel scaling to use during end user interaction with the chart.

    let actualInteractionPixelScalingRatio: number = this.chart.actualInteractionPixelScalingRatio;
    

    Returns number

  • set actualInteractionPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get actualPixelScalingRatio(): number
  • Gets the resolved pixel scaling ratio.

    A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry

    let actualPixelScalingRatio: number = this.chart.actualPixelScalingRatio;
    

    Returns number

  • set actualPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get actualWindowPositionHorizontal(): number
  • A number between 0 and 1 determining the position of the horizontal scroll. This property is effectively a shortcut to the Left of the ActualWindowRect property.

    let actualWindowPositionHorizontal: number = this.chart.actualWindowPositionHorizontal;
    

    Returns number

  • set actualWindowPositionHorizontal(v): void
  • Parameters

    • v: number

    Returns void

  • get actualWindowPositionVertical(): number
  • A number between 0 and 1 determining the position of the vertical scroll. This property is effectively a shortcut to the Top of the ActualWindowRect property.

    let actualWindowPositionVertical: number = this.chart.actualWindowPositionVertical;
    ``

    Returns number

  • set actualWindowPositionVertical(v): void
  • Parameters

    • v: number

    Returns void

  • get actualWindowRect(): IgRect
  • Gets the actual value of the window rectangle, which represents the current zoom level.

    Returns IgRect

  • set actualWindowRect(v): void
  • Parameters

    • v: IgRect

    Returns void

  • get actualWindowRectChanged(): ((s, e) => void)
  • Raised when the actual window rectangle of the SeriesViewer changes.

    Returns ((s, e) => void)

  • set actualWindowRectChanged(ev): void
  • Parameters

    Returns void

  • get actualWindowRectMinHeight(): number
  • Gets the actual minimum height that the window rect is allowed to reach before being clamped.

    Returns number

  • set actualWindowRectMinHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get actualWindowRectMinWidth(): number
  • Gets the actual minimum width that the window rect is allowed to reach before being clamped.

    Returns number

  • set actualWindowRectMinWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get animateSeriesWhenAxisRangeChanges(): boolean
  • Gets or sets whether the series animations should be allowed when a range change has been detected on an axis.

    AnimateSeriesWhenAxisRangeChanges is a Boolean property to override the default behavior in which series do not animate if an axis range changes.

    this.chart.animateSeriesWhenAxisRangeChanges = true;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    animateSeriesWhenAxisRangeChanges={true}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrColumnSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns boolean

  • set animateSeriesWhenAxisRangeChanges(v): void
  • Parameters

    • v: boolean

    Returns void

  • get autoMarginHeight(): number
  • Sets or gets the automatic height to add when automatically adding margins to the chart.

     this.chart.autoMarginHeight = 50;
    
     <IgrDataChart
    autoMarginHeight={50}
    dataSource={this.state.dataSource} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns number

  • set autoMarginHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get autoMarginWidth(): number
  • Sets or gets the automatic width to add when automatically adding margins to the chart.

    The autoMarginWidth propertry is used find the automatic width to add when automatically adding margins to the chart.

    this.chart.autoMarginWidth = 50;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    autoMarginWidth={50} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrColumnSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns number

  • set autoMarginWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get bottomMargin(): number
  • Sets or gets the bottom margin to use around the chart content.

    The bottomMargin property is used to gets/set the bottom margin around the chart content in the canvas.

    this.chart.bottomMargin = 50;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    bottomMargin={50} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrColumnSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns number

  • set bottomMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get brushes(): string[]
  • Gets or sets the palette of brushes used for fill of plotted series. These brushes are automatically assigned to series based on the index of series.

    Returns string[]

  • set brushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get chartTitle(): string
  • Text to display above the plot area.

    The Title property is used to set the title to display for the component.

    this.chart.title="Items Sold";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    title="Items Sold" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns string

  • set chartTitle(v): void
  • Parameters

    • v: string

    Returns void

  • get contentHitTestMode(): ChartHitTestMode
  • Determines the method of hit testing used when mousing over elements in the chart.

    this.chart.contentHitTestMode = ChartHitTestMode.Computational;
    

    Returns ChartHitTestMode

  • set contentHitTestMode(v): void
  • Parameters

    Returns void

  • get contentViewport(): IgRect
  • Represents the subset area within the viewport into which content should be mapped. This is the projection of the current EffectiveViewport into the viewport at current zoom level.

    Returns IgRect

  • get crosshairPoint(): IgPoint
  • Gets or sets the cross hair point (in world coordinates) Either or both of the crosshair point's X and Y may be set to double.NaN, in which case the relevant crosshair line is hidden.

    The CrosshairPoint property is used to gets/sets the cross hair point (in world coordinates).

    this.chart.crosshairPoint = {x:.8,y:.2};
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    crosshairVisibility="visible"
    crosshairPoint={x:.8,y:.2} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns IgPoint

  • set crosshairPoint(v): void
  • Parameters

    • v: IgPoint

    Returns void

  • get crosshairVisibility(): Visibility
  • Gets or sets the current SeriesViewer's crosshair visibility override.

    The CrosshairVisibility property is used to gets or sets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart.

    this.chart.crosshairVisibility = Visibility.Visible;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    crosshairVisibility="visible"
    crosshairPoint={x:.8,y:.2} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns Visibility

  • set crosshairVisibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get defaultInteraction(): InteractionState
  • Gets or sets the DefaultInteraction property. The default interaction state defines the SeriesViewer's response to mouse events.

    The default interaction state defines the chart's response to mouse events.

    this.chart.defaultInteraction = InteractionState.DragPan;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    defaultInteraction="dragPan" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns InteractionState

  • set defaultInteraction(v): void
  • Parameters

    • v: InteractionState

    Returns void

  • get dragModifier(): ModifierKeys
  • Gets or sets the current SeriesViewer's DragModifier property.

    DragModifier is useful to enable zooming when zooming is not the default interaction.

    this.chart.dragModifier = ModifierKeys.Alt;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    isHorizontalZoomEnabled=true
    defaultInteraction="dragPan"
    dragModifier="alt" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns ModifierKeys

  • set dragModifier(v): void
  • Parameters

    • v: ModifierKeys

    Returns void

  • get effectiveViewport(): IgRect
  • Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted.

    ``ts let viewport: IgxRect = this.chart.effectiveViewport;

    
    

    Returns IgRect

  • set effectiveViewport(v): void
  • Parameters

    • v: IgRect

    Returns void

  • get gridAreaRectChanged(): ((s, e) => void)
  • Occurs just after the current SeriesViewer's grid area rectangle is changed. The grid area may change as the result of the SeriesViewer being resized, or of an axis being added or changing size, possibly in another SeriesViewer.

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs just after the current SeriesViewer's grid area rectangle is changed. The grid area may change as the result of the SeriesViewer being resized, or of an axis being added or changing size, possibly in another SeriesViewer.

        Parameters

        Returns void

  • set gridAreaRectChanged(ev): void
  • Parameters

    Returns void

  • get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode
  • Gets or sets whether and how to display highlighted values for the series by default. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

    Returns SeriesHighlightedValuesDisplayMode

  • set highlightedValuesDisplayMode(v): void
  • Parameters

    Returns void

  • get highlightingBehavior(): SeriesHighlightingBehavior
  • Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHightlightingEnabled.

    Returns SeriesHighlightingBehavior

  • set highlightingBehavior(v): void
  • Parameters

    Returns void

  • get highlightingMode(): SeriesHighlightingMode
  • Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHightlightingEnabled.

    Returns SeriesHighlightingMode

  • set highlightingMode(v): void
  • Parameters

    Returns void

  • get highlightingTransitionDuration(): number
  • Gets or sets the duration the highlighting/de-highlighting effects.

    The HighlightingTransitionDuration property is used to set the time for highlighting transition in milliseconds .

    chart.HighlightingTransitionDuration=500;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    HighlightingTransitionDuration={500} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns number

  • set highlightingTransitionDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalCrosshairBrush(): string
  • Gets or sets the current SeriesViewer's crosshair horizontal brush override.

    Returns string

  • set horizontalCrosshairBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get horizontalViewScrollbarCornerRadius(): number
  • Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarCornerRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalViewScrollbarFill(): string
  • Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled.

    Returns string

  • set horizontalViewScrollbarFill(v): void
  • Parameters

    • v: string

    Returns void

  • get horizontalViewScrollbarHeight(): number
  • Gets or sets the height to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalViewScrollbarInset(): number
  • Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarInset(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalViewScrollbarMaxOpacity(): number
  • Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarMaxOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalViewScrollbarMode(): SeriesViewerScrollbarMode
  • Gets or sets the horizontal scrollbar mode to use for the series viewer.

    Returns SeriesViewerScrollbarMode

  • set horizontalViewScrollbarMode(v): void
  • Parameters

    Returns void

  • get horizontalViewScrollbarOutline(): string
  • Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled.

    Returns string

  • set horizontalViewScrollbarOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get horizontalViewScrollbarShouldAddAutoTrackInsets(): boolean
  • Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled.

    Returns boolean

  • set horizontalViewScrollbarShouldAddAutoTrackInsets(v): void
  • Parameters

    • v: boolean

    Returns void

  • get horizontalViewScrollbarStrokeThickness(): number
  • Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalViewScrollbarTrackEndInset(): number
  • Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarTrackEndInset(v): void
  • Parameters

    • v: number

    Returns void

  • get horizontalViewScrollbarTrackStartInset(): number
  • Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled.

    Returns number

  • set horizontalViewScrollbarTrackStartInset(v): void
  • Parameters

    • v: number

    Returns void

  • get imageCaptured(): ((s, e) => void)
  • Event raised when an image of the component is saved

    Returns ((s, e) => void)

  • set imageCaptured(ev): void
  • Parameters

    Returns void

  • get interactionPixelScalingRatio(): number
  • Method of pixel scaling to use during end user interaction with the chart.

    Returns number

  • set interactionPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get isAntiAliasingEnabledDuringInteraction(): boolean
  • Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

    Returns boolean

  • set isAntiAliasingEnabledDuringInteraction(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isDetached(): boolean
  • Returns boolean

  • get isMap(): boolean
  • Indicates if this SeriesViewer is a map.

    Returns boolean

  • get isPagePanningAllowed(): boolean
  • Gets or sets the whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction.

    Returns boolean

  • set isPagePanningAllowed(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isSurfaceInteractionDisabled(): boolean
  • Gets or sets whether all surface interactions with the plot area should be disabled.

    The IsSurfaceInteractionDisabled property is used to enable/disable interactions with the plot surface.

    chart.isSurfaceInteractionDisabled=true;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    isSurfaceInteractionDisabled={true} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    brush="Gray"
    outline="Black" />
    </IgrDataChart>

    Returns boolean

  • set isSurfaceInteractionDisabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isWindowSyncedToVisibleRange(): boolean
  • Gets or sets whether to sync the vertical aspect of the window with the contained series content. This is only supported for a subset of the available series.

    Returns boolean

  • set isWindowSyncedToVisibleRange(v): void
  • Parameters

    • v: boolean

    Returns void

  • get leftMargin(): number
  • Sets or gets the left margin to use around the chart content.

    The LeftMargin property is used to set the left margin.

     this.chart.leftMargin = 20;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    leftMargin={20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    />
    </IgrDataChart>

    Returns number

  • set leftMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get legendHighlightingMode(): LegendHighlightingMode
  • Gets or sets the highlighting mode to use for the legend linked to the component, when supported.

    Returns LegendHighlightingMode

  • set legendHighlightingMode(v): void
  • Parameters

    Returns void

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

    Returns LegendItemBadgeMode

  • set legendItemBadgeMode(v): void
  • Parameters

    • v: LegendItemBadgeMode

    Returns void

  • get legendItemBadgeShape(): LegendItemBadgeShape
  • Gets or sets type of legend badges representing all series displayed in a legend linked to this component This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on a series

    Returns LegendItemBadgeShape

  • set legendItemBadgeShape(v): void
  • Parameters

    • v: LegendItemBadgeShape

    Returns void

  • get markerAutomaticBehavior(): MarkerAutomaticBehavior
  • Gets or sets the marker mode used for assigning a marker type to series when the marker type is automatic.

    Returns MarkerAutomaticBehavior

  • set markerAutomaticBehavior(v): void
  • Parameters

    Returns void

  • get markerBrushes(): string[]
  • Gets or sets the palette of brushes used for fill of marker series. These brushes are automatically assigned to markers based on the index of series.

    Returns string[]

  • set markerBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get markerOutlines(): string[]
  • Gets or sets the palette of brushes used for outlines of plotted markers. These outlines are automatically assigned to markers based on the index of series.

    Returns string[]

  • set markerOutlines(v): void
  • Parameters

    • v: string[]

    Returns void

  • get outlines(): string[]
  • Gets or sets the palette of brushes used for outlines of plotted series. These outlines are automatically assigned to series based on the index of series.

    Returns string[]

  • set outlines(v): void
  • Parameters

    • v: string[]

    Returns void

  • get panModifier(): ModifierKeys
  • Gets or sets the current SeriesViewer's PanModifier property.

    PanModifier is useful to enable panning when panning is not the default interaction.

    this.chart.panModifier = ModifierKeys.Alt;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    isHorizontalZoomEnabled=true
    defaultInteraction="dragZoom"
    panModifier="alt" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns ModifierKeys

  • set panModifier(v): void
  • Parameters

    • v: ModifierKeys

    Returns void

  • get pixelScalingRatio(): number
  • 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.

    Returns number

  • set pixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get plotAreaBackground(): string
  • Gets or sets the brush used as the background for the current SeriesViewer object's plot area.

    PlotAreaBackground property set the background brush to the current Chart object's plot area.

    this.chart.plotAreaBackground="#F0F8FF";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    plotAreaBackground="#F0F8FF" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns string

  • set plotAreaBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get plotAreaClicked(): ((s, e) => void)
  • Occurs when the left mouse button is clicked while the mouse pointer is over the plot area.

    Returns ((s, e) => void)

  • set plotAreaClicked(ev): void
  • Parameters

    Returns void

  • get plotAreaMouseLeftButtonDown(): ((s, e) => void)
  • Occurs when the left mouse button is pressed while the mouse pointer is over the plot area.

    Returns ((s, e) => void)

  • set plotAreaMouseLeftButtonDown(ev): void
  • Parameters

    Returns void

  • get plotAreaMouseLeftButtonUp(): ((s, e) => void)
  • Occurs when the left mouse button is pressed while the mouse pointer is over the plot area.

    Returns ((s, e) => void)

  • set plotAreaMouseLeftButtonUp(ev): void
  • Parameters

    Returns void

  • get preferHigherResolutionTiles(): boolean
  • Gets or sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality.

    Returns boolean

  • set preferHigherResolutionTiles(v): void
  • Parameters

    • v: boolean

    Returns void

  • get previewRect(): IgRect
  • Gets or sets the preview rectangle. The preview rectangle may be set to Rect.Empty, in which case the visible preview strokePath is hidden.

    PreviewRect can be used to highlight an area of importance.

    this.chart.previewRect = {left:0,top:0,height:.5,width:.5};
    

    Returns IgRect

  • set previewRect(v): void
  • Parameters

    • v: IgRect

    Returns void

  • get rightButtonDefaultInteraction(): InteractionState
  • Gets or sets the RightButtonDefaultInteraction property. The default interaction state defines the SeriesViewer's response to right button mouse events.

    Returns InteractionState

  • set rightButtonDefaultInteraction(v): void
  • Parameters

    • v: InteractionState

    Returns void

  • get rightMargin(): number
  • Sets or gets the right margin to use around the chart content.

    The RightMargin property is used to set the left margin around the chart content in the canvas.

    this.chart.rightMargin=20;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    leftMargin= {20}
    rightMargin={20}
    topMargin={30}
    bottomMargin={20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set rightMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get scrollbarsAnimationDuration(): number
  • Gets or sets the duration of the scrollbar effects.

    Returns number

  • set scrollbarsAnimationDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get seriesCursorMouseMove(): ((s, e) => void)
  • Occurs when the cursors are moved over a series in this SeriesViewer.

    Returns ((s, e) => void)

  • set seriesCursorMouseMove(ev): void
  • Parameters

    Returns void

  • get seriesMouseEnter(): ((s, e) => void)
  • Occurs when the mouse pointer enters a Series.

    The SeriesMouseEnter event occurs when the left mouse pointer enters an element of this chart.

    <-- position: content member-->

    public onSeriesMouseEnter(event: {sender: any, args: ChartMouseEventArgs})
    {
    var item = event.args.item;
    }
     <IgrDataChart
    dataSource={this.state.dataSource}
    seriesMouseEnter={this.onSeriesMouseEnter}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the mouse pointer enters a Series.

        The SeriesMouseEnter event occurs when the left mouse pointer enters an element of this chart.

        <-- position: content member-->

        public onSeriesMouseEnter(event: {sender: any, args: ChartMouseEventArgs})
        {
        var item = event.args.item;
        }
         <IgrDataChart
        dataSource={this.state.dataSource}
        seriesMouseEnter={this.onSeriesMouseEnter}>

        <IgrNumericXAxis name="xAxis" />
        <IgrNumericYAxis name="yAxis" />

        <IgrLineSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
        </IgrDataChart>

        Parameters

        Returns void

  • set seriesMouseEnter(ev): void
  • Parameters

    Returns void

  • get seriesMouseLeave(): ((s, e) => void)
  • Occurs when the mouse pointer leaves a Series.

    The SeriesMouseLeave event occurs when the left mouse pointer leaves an element of this chart.

    public onSeriesMouseLeave(event: {sender: any, args: ChartMouseEventArgs})
    {
    var item = event.args.item;
    }
     <IgrDataChart
    dataSource={this.state.dataSource}
    seriesMouseLeave ={this.onSeriesMouseLeave}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the mouse pointer leaves a Series.

        The SeriesMouseLeave event occurs when the left mouse pointer leaves an element of this chart.

        public onSeriesMouseLeave(event: {sender: any, args: ChartMouseEventArgs})
        {
        var item = event.args.item;
        }
         <IgrDataChart
        dataSource={this.state.dataSource}
        seriesMouseLeave ={this.onSeriesMouseLeave}>

        <IgrNumericXAxis name="xAxis" />
        <IgrNumericYAxis name="yAxis" />

        <IgrLineSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
        </IgrDataChart>

        Parameters

        Returns void

  • set seriesMouseLeave(ev): void
  • Parameters

    Returns void

  • get seriesMouseLeftButtonDown(): ((s, e) => void)
  • Occurs when the left mouse button is pressed while the mouse pointer is over a Series.

    The SeriesMouseLeftButtonDown event occurs when the left mouse button is pressed while the mouse pointer is over an element of this chart.

    <-- position: content member-->

    public onSeriesMouseLeftButtonDown(event: {sender: any, args: DataChartMouseButtonEventArgs})
    {
    var item = event.args.item;
    }
     <IgrDataChart
    dataSource={this.state.dataSource}
    seriesMouseLeftButtonDown= {this.onSeriesMouseLeftButtonDown}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the left mouse button is pressed while the mouse pointer is over a Series.

        The SeriesMouseLeftButtonDown event occurs when the left mouse button is pressed while the mouse pointer is over an element of this chart.

        <-- position: content member-->

        public onSeriesMouseLeftButtonDown(event: {sender: any, args: DataChartMouseButtonEventArgs})
        {
        var item = event.args.item;
        }
         <IgrDataChart
        dataSource={this.state.dataSource}
        seriesMouseLeftButtonDown= {this.onSeriesMouseLeftButtonDown}>

        <IgrNumericXAxis name="xAxis" />
        <IgrNumericYAxis name="yAxis" />

        <IgrLineSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
        </IgrDataChart>

        Parameters

        Returns void

  • set seriesMouseLeftButtonDown(ev): void
  • Parameters

    Returns void

  • get seriesMouseLeftButtonUp(): ((s, e) => void)
  • Occurs when the left mouse button is released while the mouse pointer is over a Series.

    The SeriesMouseLeftButtonUp event occurs when the left mouse button is released while the mouse pointer is over an element of this chart.

    <-- position: content member-->

    <-- position: content member-->

    public onSeriesMouseLeftButtonUp(event: {sender: any, args: DataChartMouseButtonEventArgs})
    {
    var item = event.args.item;
    }
     <IgrDataChart
    dataSource={this.state.dataSource}
    seriesMouseLeftButtonUp ={this.onSeriesMouseLeftButtonUp}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>
    public onSeriesMouseLeftButtonUp =(event: any, args: DataChartMouseButtonEventArgs )
    {

    }

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the left mouse button is released while the mouse pointer is over a Series.

        The SeriesMouseLeftButtonUp event occurs when the left mouse button is released while the mouse pointer is over an element of this chart.

        <-- position: content member-->

        <-- position: content member-->

        public onSeriesMouseLeftButtonUp(event: {sender: any, args: DataChartMouseButtonEventArgs})
        {
        var item = event.args.item;
        }
         <IgrDataChart
        dataSource={this.state.dataSource}
        seriesMouseLeftButtonUp ={this.onSeriesMouseLeftButtonUp}>

        <IgrNumericXAxis name="xAxis" />
        <IgrNumericYAxis name="yAxis" />

        <IgrLineSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
        </IgrDataChart>
        public onSeriesMouseLeftButtonUp =(event: any, args: DataChartMouseButtonEventArgs )
        {

        }

        Parameters

        Returns void

  • set seriesMouseLeftButtonUp(ev): void
  • Parameters

    Returns void

  • get seriesMouseMove(): ((s, e) => void)
  • Occurs when the mouse pointer moves while over a Series.

    The SeriesMouseMove event occurs when the left mouse pointer moves while over an element of this chart.

    <-- position: content member-->

    <-- position: content member-->

    public onSeriesMouseMove(event: {sender: any, args: ChartMouseEventArgs})
    {
    var item = event.args.item;
    }
     <IgrDataChart
    dataSource={this.state.dataSource}
    seriesMouseMove={this.onSeriesMouseMove} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>
    public onSeriesMouseMove =( event: any, args: ChartMouseEventArgs) => {
    }

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs when the mouse pointer moves while over a Series.

        The SeriesMouseMove event occurs when the left mouse pointer moves while over an element of this chart.

        <-- position: content member-->

        <-- position: content member-->

        public onSeriesMouseMove(event: {sender: any, args: ChartMouseEventArgs})
        {
        var item = event.args.item;
        }
         <IgrDataChart
        dataSource={this.state.dataSource}
        seriesMouseMove={this.onSeriesMouseMove} >

        <IgrNumericXAxis name="xAxis" />
        <IgrNumericYAxis name="yAxis" />

        <IgrLineSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
        </IgrDataChart>
        public onSeriesMouseMove =( event: any, args: ChartMouseEventArgs) => {
        }

        Parameters

        Returns void

  • set seriesMouseMove(ev): void
  • Parameters

    Returns void

  • get shouldPanOnMaximumZoom(): boolean
  • Gets or sets a whether the chart should pan its content when zooing in passed max zoom level.

    Returns boolean

  • set shouldPanOnMaximumZoom(v): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldSimulateHoverMoveCrosshairPoint(): boolean
  • Gets or sets whether calling SimulateHover should shift the crosshair point.

    Returns boolean

  • set shouldSimulateHoverMoveCrosshairPoint(v): void
  • Parameters

    • v: boolean

    Returns void

  • get sizeChanged(): ((s, e) => void)
  • Occurs after the size of the series viewer changes.

    <-- position: content member-->

    <-- position: content member-->

     <IgrDataChart
    dataSource={this.state.dataSource}
    sizeChanged={this.onSizeChanged=} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>
    public onSizeChanged =(event: any, args: RectChangedEventArgs}){

    }

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs after the size of the series viewer changes.

        <-- position: content member-->

        <-- position: content member-->

         <IgrDataChart
        dataSource={this.state.dataSource}
        sizeChanged={this.onSizeChanged=} >

        <IgrNumericXAxis name="xAxis" />
        <IgrNumericYAxis name="yAxis" />

        <IgrLineSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
        </IgrDataChart>
        public onSizeChanged =(event: any, args: RectChangedEventArgs}){

        }

        Parameters

        Returns void

  • set sizeChanged(ev): void
  • Parameters

    Returns void

  • get subtitle(): string
  • Gets or sets the Subtitle property. The Title property defines the Subtitle of the chart

    The Subtitle property is used to display subtitle for the component.

    this.chart.subtitle="Date of Sale: 1/1/2018";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    subtitle="Date of Sale: 1/1/2018" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns string

  • set subtitle(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleBottomMargin(): number
  • Margin applied below the subtitle.

    The subtitleBottomMargin property is used to set the bottom margin for the subtitle.

    this.chart.subtitleBottomMargin = 20;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    subtitleBottomMargin={20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set subtitleBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get subtitleHorizontalAlignment(): HorizontalAlignment
  • Gets or sets the SubtitleHorizontalAlignment property.

    The subtitleBottomMargin property is used to set the horizontal alignment for the subtitle.

    this.chart.subtitleHorizontalAlignment="left";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    subtitleHorizontalAlignment="left" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns HorizontalAlignment

  • set subtitleHorizontalAlignment(v): void
  • Parameters

    • v: HorizontalAlignment

    Returns void

  • get subtitleLeftMargin(): number
  • Margin applied to the left of the subtitle.

    The subtitleLeftMarging property is used to set the left margin for the subtitle.

    this.chart.subtitleLeftMarging=10;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    subtitleLeftMarging= {10}
    subtitleTopMargin={10}
    subtitleRightMargin={10}
    subtitleBottomMargin={20}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set subtitleLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get subtitleRightMargin(): number
  • Margin applied to the right of the subtitle.

    The subTitleRightMargin property is used to set the right margin for the subtitle.

    this.chart.subtitleLeftMarging=10;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    subtitleLeftMarging= {10}
    subtitleTopMargin= {10}
    subtitleRightMargin={10}
    subtitleBottomMargin={20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set subtitleRightMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get subtitleTextColor(): string
  • Gets or sets the Color used for the Subtitle Text.

    The subtitleTextColor property is used to set the color for the subtitle.

    this.chart.subtitleTextColor="blue";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    title="Date of Sale: 1/1/2018"
    subtitleTextColor="blue">

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns string

  • set subtitleTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleTextStyle(): string
  • Font settings for the subtitle.

    Returns string

  • set subtitleTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleTopMargin(): number
  • Margin applied above the subtitle.

    The subtitleTopMargin property is used to set the top margin for the subtitle.

    this.chart.subtitleTopMargin =10;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    subtitleLeftMarging= {10}
    subtitleTopMargin={10}
    subtitleRightMargin={10}
    subtitleBottomMargin={20}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set subtitleTopMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get titleBottomMargin(): number
  • Margin applied below the title.

    The titleBottomMargin property is used to set the bottom margin for the title.

    this.chart.titleBottomMargin=20;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    title="Items Sold"
    titleLeftMarging= {10}
    titleTopMargin= {10 }
    titleRightMargin= {10}
    titleBottomMargin= {20}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set titleBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get titleHorizontalAlignment(): HorizontalAlignment
  • Gets or sets the TitleHorizontalAlignment property.

    The subtitleHorizontalAlignment property is used to set horizontal alignment for the subtitle.

    this.chart.titleHorizontalAlignment="left";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    titleHorizontalAlignment="left"
    subtitleHorizontalAlignment="left" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns HorizontalAlignment

  • set titleHorizontalAlignment(v): void
  • Parameters

    • v: HorizontalAlignment

    Returns void

  • get titleLeftMargin(): number
  • Margin applied to the left of the title.

    The titleLeftMarging property is used to set the left margin for the title.

    this.chart.titleLeftMarging=10;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    title="Items Sold"
    titleLeftMarging={10}
    titleTopMargin={10}
    titleRightMargin={10}
    titleBottomMargin= {20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set titleLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get titleRightMargin(): number
  • Margin applied to the right of the title.

    The titleRightMargin property is used to set the right margin for the title.

    this.chart.titleRightMargin=10;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    titleLeftMarging= {10}
    titleTopMargin= {10 }
    titleRightMargin= {10}
    titleBottomMargin= {20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set titleRightMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get titleTextColor(): string
  • Gets or sets the Color used for the Title Text.

    The titleTextColor property is used to set the title brush.

    this.chart.titleTextColor="blue" ;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    titleTextColor="blue" >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns string

  • set titleTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get titleTextStyle(): string
  • Font settings for the title.

    Returns string

  • set titleTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get titleTopMargin(): number
  • Margin applied above the title.

    The titleTopMargin property is used to set the top margin for the title.

    this.chart.titleTopMargin=10;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    titleLeftMarging= {10}
    titleTopMargin= {10 }
    titleRightMargin= {10}
    titleBottomMargin= {20}>

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set titleTopMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get topMargin(): number
  • Sets or gets the top margin to use around the chart content.

    The topMargin property is used to set the top margin.

    this.chart.topMargin=30;
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    leftMargin= {20}
    rightMargin={20}
    topMargin={30}
    bottomMargin= {20} >

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set topMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get useTiledZooming(): boolean
  • Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content.

    Returns boolean

  • set useTiledZooming(v): void
  • Parameters

    • v: boolean

    Returns void

  • get verticalCrosshairBrush(): string
  • Gets or sets the current SeriesViewer's crosshair vertical brush override.

    Returns string

  • set verticalCrosshairBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get verticalViewScrollbarCornerRadius(): number
  • Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarCornerRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get verticalViewScrollbarFill(): string
  • Gets or sets the fill to use for the vertical scrollbar in the component, when enabled.

    Returns string

  • set verticalViewScrollbarFill(v): void
  • Parameters

    • v: string

    Returns void

  • get verticalViewScrollbarInset(): number
  • Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarInset(v): void
  • Parameters

    • v: number

    Returns void

  • get verticalViewScrollbarMaxOpacity(): number
  • Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarMaxOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get verticalViewScrollbarMode(): SeriesViewerScrollbarMode
  • Gets or sets the vertical scrollbar mode to use for the series viewer.

    Returns SeriesViewerScrollbarMode

  • set verticalViewScrollbarMode(v): void
  • Parameters

    Returns void

  • get verticalViewScrollbarOutline(): string
  • Gets or sets the outline to use for the vertical scrollbar in the component, when enabled.

    Returns string

  • set verticalViewScrollbarOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get verticalViewScrollbarShouldAddAutoTrackInsets(): boolean
  • Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled.

    Returns boolean

  • set verticalViewScrollbarShouldAddAutoTrackInsets(v): void
  • Parameters

    • v: boolean

    Returns void

  • get verticalViewScrollbarStrokeThickness(): number
  • Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get verticalViewScrollbarTrackEndInset(): number
  • Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarTrackEndInset(v): void
  • Parameters

    • v: number

    Returns void

  • get verticalViewScrollbarTrackStartInset(): number
  • Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarTrackStartInset(v): void
  • Parameters

    • v: number

    Returns void

  • get verticalViewScrollbarWidth(): number
  • Gets or sets the width to use for the vertical scrollbar in the component, when enabled.

    Returns number

  • set verticalViewScrollbarWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get viewportRect(): IgRect
  • Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area.

    Returns IgRect

  • get windowPositionHorizontal(): number
  • A number between 0 and 1 determining the position of the horizontal scroll. This property is effectively a shortcut to the X position of the WindowRect property.

    this.chart.windowPositionHorizontal = .2;
    

    Returns number

  • set windowPositionHorizontal(v): void
  • Parameters

    • v: number

    Returns void

  • get windowPositionVertical(): number
  • A number between 0 and 1 determining the position of the vertical scroll. This property is effectively a shortcut to the Y position of the WindowRect property.

    this.chart.windowPositionVertical = .2;
    

    Returns number

  • set windowPositionVertical(v): void
  • Parameters

    • v: number

    Returns void

  • get windowRect(): IgRect
  • A rectangle representing the portion of the SeriesViewer currently in view. A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in.

    You can set the WindowRect to zoom in on an area of interest in the chart.

    this.chart.windowRect = {left:0, top:1, width: .5, height: .5};
    

    Returns IgRect

  • set windowRect(v): void
  • Parameters

    • v: IgRect

    Returns void

  • get windowRectChanged(): ((s, e) => void)
  • Occurs just after the current SeriesViewer's window rectangle is changed.

    <-- position: content member-->

    <-- position: content member-->

    <IgrDataChart
    width="100%"
    height="100%"
    dataSource={this.data}
    windowRectChanged={this.onWindowRectChanged} >
    <IgrCategoryXAxis name="xAxis" label="Year"/>
    <IgrNumericYAxis name="yAxis" minimumValue={0} />
    <IgrLineSeries name="series3" title="Russia"
    valueMemberPath="Russia"
    xAxisName="xAxis"
    yAxisName="yAxis"
    markerType={this.state.markersType} />
    </IgrDataChart>
    public onWindowRectChanged =( s:any, e: RectChangedEventArgs) => {

    }

    Returns ((s, e) => void)

      • (s, e): void
      • Occurs just after the current SeriesViewer's window rectangle is changed.

        <-- position: content member-->

        <-- position: content member-->

        <IgrDataChart
        width="100%"
        height="100%"
        dataSource={this.data}
        windowRectChanged={this.onWindowRectChanged} >
        <IgrCategoryXAxis name="xAxis" label="Year"/>
        <IgrNumericYAxis name="yAxis" minimumValue={0} />
        <IgrLineSeries name="series3" title="Russia"
        valueMemberPath="Russia"
        xAxisName="xAxis"
        yAxisName="yAxis"
        markerType={this.state.markersType} />
        </IgrDataChart>
        public onWindowRectChanged =( s:any, e: RectChangedEventArgs) => {

        }

        Parameters

        Returns void

  • set windowRectChanged(ev): void
  • Parameters

    Returns void

  • get windowRectMinHeight(): number
  • Sets or gets the minimum height that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. This property accepts values between 0.0 (max zooming) and 1.0 (no zooming)

    Returns number

  • set windowRectMinHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get windowRectMinWidth(): number
  • Sets or gets the minimum width that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. This property accepts values between 0.0 (max zooming) and 1.0 (no zooming)

    The WindowRectMinWidth property is used to set or get the minimum width that the window rect is allowed to reach before being clamped.

    this.chart.WindowRectMinWidth=".2";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    WindowRectMinWidth=".2">

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns number

  • set windowRectMinWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get windowResponse(): WindowResponse
  • The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

    The WindowResponse property is used to set the response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

    this.chart.windowResponse="deferred";
    
     <IgrDataChart
    dataSource={this.state.dataSource}
    windowResponse="deferred">

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis" />

    <IgrLineSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
    </IgrDataChart>

    Returns WindowResponse

  • set windowResponse(v): void
  • Parameters

    Returns void

  • get windowSizeMinHeight(): number
  • Sets or gets minimum pixel height that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. This property is overridden by the WindowRectMinHeight property

    Returns number

  • set windowSizeMinHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get windowSizeMinWidth(): number
  • Sets or gets minimum pixel width that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. This property is overridden by the WindowRectMinWidth property

    Returns number

  • set windowSizeMinWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get zoomCoercionMode(): ZoomCoercionMode
  • Gets or sets zoom is contrained to within the axes. Setting this to false is a preview feature at the present time.

    Returns ZoomCoercionMode

  • set zoomCoercionMode(v): void
  • Parameters

    Returns void

  • get zoomTileCacheSize(): number
  • Gets or sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode.

    Returns number

  • set zoomTileCacheSize(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Parameters

    • listener: ICommandAvailabilityListener

    Returns void

  • Parameters

    • listener: ICommandStateChangedListener

    Returns void

  • Attaches the given series to the chart.

    Parameters

    Returns void

  • Returns void

  • Parameters

    • settings: IgrCaptureImageSettings

    Returns void

  • Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom.

    Returns void

  • 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

  • Release any resources held by the control.

    Returns void

  • Manually ends a tiled zoom if one is running.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Use to force the SeriesViewer to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the SeriesViewer needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the SeriesViewer.

    this.chart.flush();
    

    Returns void

  • Parameters

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

    Returns void

  • Gets actual window scale for horizontal dimension of the control

    let actualWindowScaleHorizontal: number = chart.getActualWindowScaleHorizontal();
    

    Returns number

  • Gets actual window scale for vertical dimension of the control

    let actualWindowScaleVertical: number = chart.getActualWindowScaleVertical();
    

    Returns number

  • Returns IgRect

  • Returns ToolActionInfo[]

  • 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

  • Hides the active main tooltip, if displayed.

    this.chart.hideToolTip();
    

    Returns void

  • Used to manually notify the SeriesViewer that the data source has reset or cleared its items. Invoking this method is only necessary if that datasource is not observable.

    Parameters

    • source_: any
      • The data source which was cleared or reset.
      this.chart.notifyClearItems(this.data);
      

    Returns void

  • Notification from the containing object that the container has been resized.

    Returns void

  • Parameters

    • source_: any
    • index: number
    • newItem: any

    Returns void

  • Parameters

    • source_: any
    • index: number
    • oldItem: any

    Returns void

  • Parameters

    • source_: any
    • index: number
    • oldItem: any
    • newItem: any

    Returns void

  • Parameters

    • listener: ICommandAvailabilityListener

    Returns void

  • Parameters

    • listener: ICommandStateChangedListener

    Returns void

  • Returns any

  • Parameters

    • width: number
    • height: number

    Returns any

  • Resets the zoom level to default.

    Returns void

  • 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

  • Parameters

    • point: IgPoint

    Returns void

  • Manually starts a tiled zoom if one isn't already running.

    Returns void

  • Performs zoom in action on the chart by specified percentage of current window rect

    Parameters

    • percentage: number

    Returns void

  • Performs zoom out action on the chart by specified percentage of current window rect

    Parameters

    • percentage: number

    Returns void