Class IgrSeriesViewer<P, SS>

Represents a control for viewing series objects.

Type parameters

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • props: P

    Returns IgrSeriesViewer

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<P> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<__type>

Static Optional contextType

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

https://reactjs.org/docs/context.html#classcontexttype

Accessors

actualContentHitTestMode

  • Resolved method of hit testing used when the pointer is over elements in the chart.

    let actualContentHitTestMode: ChartHitTestMode  =this.chart.actualContentHitTestMode;

    Returns ChartHitTestMode

  • Resolved method of hit testing used when the pointer is over elements in the chart.

    let actualContentHitTestMode: ChartHitTestMode  =this.chart.actualContentHitTestMode;

    Parameters

    Returns void

actualInteractionPixelScalingRatio

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

    let actualInteractionPixelScalingRatio: number = this.chart.actualInteractionPixelScalingRatio;

    Returns number

  • Resolved method of pixel scaling to use during end user interaction with the chart.

    let actualInteractionPixelScalingRatio: number = this.chart.actualInteractionPixelScalingRatio;

    Parameters

    • v: number

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • 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

  • 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;

    Parameters

    • v: number

    Returns void

actualWindowPositionHorizontal

  • get actualWindowPositionHorizontal(): number
  • set actualWindowPositionHorizontal(v: number): void
  • 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

  • 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;

    Parameters

    • v: number

    Returns void

actualWindowPositionVertical

  • get actualWindowPositionVertical(): number
  • set actualWindowPositionVertical(v: number): void
  • 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

  • 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;
    ``

    Parameters

    • v: number

    Returns void

actualWindowRect

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

    Returns IgRect

  • Gets the actual value of the window rectangle, which represents the current zoom level.

    Parameters

    • v: IgRect

    Returns void

actualWindowRectChanged

  • get actualWindowRectChanged(): function
  • set actualWindowRectChanged(ev: function): void
  • Raised when the actual window rectangle of the SeriesViewer changes.

    Returns function

  • Raised when the actual window rectangle of the SeriesViewer changes.

    Parameters

    Returns void

animateSeriesWhenAxisRangeChanges

  • get animateSeriesWhenAxisRangeChanges(): boolean
  • set animateSeriesWhenAxisRangeChanges(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

autoMarginHeight

  • get autoMarginHeight(): number
  • set autoMarginHeight(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

autoMarginWidth

  • get autoMarginWidth(): number
  • set autoMarginWidth(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

bottomMargin

  • get bottomMargin(): number
  • set bottomMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

chartTitle

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

    The chartTitle 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

  • Text to display above the plot area.

    The chartTitle 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>

    Parameters

    • v: string

    Returns void

contentHitTestMode

  • Determines the method of hit testing used when mousing over elements in the chart.

    this.chart.contentHitTestMode = ChartHitTestMode.Computational;

    Returns ChartHitTestMode

  • Determines the method of hit testing used when mousing over elements in the chart.

    this.chart.contentHitTestMode = ChartHitTestMode.Computational;

    Parameters

    Returns void

contentViewport

  • 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

crosshairPoint

  • get crosshairPoint(): IgPoint
  • set crosshairPoint(v: IgPoint): void
  • 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

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

    Parameters

    • v: IgPoint

    Returns void

crosshairVisibility

  • get crosshairVisibility(): Visibility
  • set crosshairVisibility(v: Visibility): void
  • 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

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

    Parameters

    • v: Visibility

    Returns void

defaultInteraction

  • get defaultInteraction(): InteractionState
  • set defaultInteraction(v: InteractionState): void
  • 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

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

    Parameters

    • v: InteractionState

    Returns void

dragModifier

  • get dragModifier(): ModifierKeys
  • set dragModifier(v: ModifierKeys): void
  • 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

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

    Parameters

    • v: ModifierKeys

    Returns void

effectiveViewport

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

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

    Returns IgRect

  • Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted.

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

    Parameters

    • v: IgRect

    Returns void

gridAreaRectChanged

  • get gridAreaRectChanged(): function
  • set gridAreaRectChanged(ev: function): 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 function

  • 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

highlightingTransitionDuration

  • get highlightingTransitionDuration(): number
  • set highlightingTransitionDuration(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

interactionPixelScalingRatio

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

    Returns number

  • Method of pixel scaling to use during end user interaction with the chart.

    Parameters

    • v: number

    Returns void

isAntiAliasingEnabledDuringInteraction

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

    Returns boolean

  • Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

    Parameters

    • v: boolean

    Returns void

isMap

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

    Returns boolean

isPagePanningAllowed

  • get isPagePanningAllowed(): boolean
  • set isPagePanningAllowed(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

isSurfaceInteractionDisabled

  • get isSurfaceInteractionDisabled(): boolean
  • set isSurfaceInteractionDisabled(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

leftMargin

  • get leftMargin(): number
  • set leftMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

panModifier

  • get panModifier(): ModifierKeys
  • set panModifier(v: ModifierKeys): void
  • 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

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

    Parameters

    • v: ModifierKeys

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number
  • set pixelScalingRatio(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

plotAreaBackground

  • get plotAreaBackground(): string
  • set plotAreaBackground(v: string): void
  • 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

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

    Parameters

    • v: string

    Returns void

preferHigherResolutionTiles

  • get preferHigherResolutionTiles(): boolean
  • set preferHigherResolutionTiles(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

previewRect

  • get previewRect(): IgRect
  • set previewRect(v: IgRect): void
  • 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

  • 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};

    Parameters

    • v: IgRect

    Returns void

refreshCompleted

  • get refreshCompleted(): function
  • set refreshCompleted(ev: function): void

rightButtonDefaultInteraction

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

    Returns InteractionState

  • Gets or sets the RightButtonDefaultInteraction property. The default interaction state defines the SeriesViewer's response to right button mouse events.

    Parameters

    • v: InteractionState

    Returns void

rightMargin

  • get rightMargin(): number
  • set rightMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

seriesCursorMouseMove

  • get seriesCursorMouseMove(): function
  • set seriesCursorMouseMove(ev: function): void

seriesMouseEnter

  • get seriesMouseEnter(): function
  • set seriesMouseEnter(ev: function): 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 function

  • 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

seriesMouseLeave

  • get seriesMouseLeave(): function
  • set seriesMouseLeave(ev: function): 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 function

  • 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

seriesMouseLeftButtonDown

  • get seriesMouseLeftButtonDown(): function
  • set seriesMouseLeftButtonDown(ev: function): 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 function

  • 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

seriesMouseLeftButtonUp

  • get seriesMouseLeftButtonUp(): function
  • set seriesMouseLeftButtonUp(ev: function): 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 function

  • 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

seriesMouseMove

  • get seriesMouseMove(): function
  • set seriesMouseMove(ev: function): 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 function

  • 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

sizeChanged

  • get sizeChanged(): function
  • set sizeChanged(ev: function): 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 function

  • 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

subtitle

  • get subtitle(): string
  • set subtitle(v: string): void
  • 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

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

    Parameters

    • v: string

    Returns void

subtitleBottomMargin

  • get subtitleBottomMargin(): number
  • set subtitleBottomMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

subtitleHorizontalAlignment

  • get subtitleHorizontalAlignment(): HorizontalAlignment
  • set subtitleHorizontalAlignment(v: HorizontalAlignment): void
  • 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

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

    Parameters

    • v: HorizontalAlignment

    Returns void

subtitleLeftMargin

  • get subtitleLeftMargin(): number
  • set subtitleLeftMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

subtitleRightMargin

  • get subtitleRightMargin(): number
  • set subtitleRightMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

subtitleTextColor

  • get subtitleTextColor(): string
  • set subtitleTextColor(v: string): void
  • 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

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

    Parameters

    • v: string

    Returns void

subtitleTextStyle

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

    Returns string

  • Font settings for the subtitle.

    Parameters

    • v: string

    Returns void

subtitleTopMargin

  • get subtitleTopMargin(): number
  • set subtitleTopMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

titleBottomMargin

  • get titleBottomMargin(): number
  • set titleBottomMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

titleHorizontalAlignment

  • get titleHorizontalAlignment(): HorizontalAlignment
  • set titleHorizontalAlignment(v: HorizontalAlignment): void
  • 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

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

    Parameters

    • v: HorizontalAlignment

    Returns void

titleLeftMargin

  • get titleLeftMargin(): number
  • set titleLeftMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

titleRightMargin

  • get titleRightMargin(): number
  • set titleRightMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

titleTextColor

  • get titleTextColor(): string
  • set titleTextColor(v: string): void
  • 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

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

    Parameters

    • v: string

    Returns void

titleTextStyle

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

    Returns string

  • Font settings for the title.

    Parameters

    • v: string

    Returns void

titleTopMargin

  • get titleTopMargin(): number
  • set titleTopMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

topMargin

  • get topMargin(): number
  • set topMargin(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

useTiledZooming

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

    Returns boolean

  • Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content.

    Parameters

    • v: boolean

    Returns void

viewportRect

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

    Returns IgRect

windowPositionHorizontal

  • get windowPositionHorizontal(): number
  • set windowPositionHorizontal(v: number): void
  • 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

  • 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;

    Parameters

    • v: number

    Returns void

windowPositionVertical

  • get windowPositionVertical(): number
  • set windowPositionVertical(v: number): void
  • 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

  • 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;

    Parameters

    • v: number

    Returns void

windowRect

  • get windowRect(): IgRect
  • set windowRect(v: IgRect): void
  • 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

  • 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};

    Parameters

    • v: IgRect

    Returns void

windowRectChanged

  • get windowRectChanged(): function
  • set windowRectChanged(ev: function): 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 function

  • 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

windowRectMinWidth

  • get windowRectMinWidth(): number
  • set windowRectMinWidth(v: number): void
  • 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.

    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

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

    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>

    Parameters

    • v: number

    Returns void

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

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

    Parameters

    Returns void

zoomTileCacheSize

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

    Returns number

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

    Parameters

    • v: number

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<__type>, nextContext: any): void

attachSeries

  • Attaches the given series to the chart.

    Parameters

    • s: IgrSeries
      • The series to attach to the chart.

    Returns void

clearTileZoomCache

  • clearTileZoomCache(): 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

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<P>, prevState: Readonly<__type>, snapshot?: SS): 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<__type>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): 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

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<__type>, nextContext: any): void

destroy

  • destroy(): void
  • Release any resources held by the control.

    Returns void

endTiledZoomingIfRunning

  • endTiledZoomingIfRunning(): void
  • Manually ends a tiled zoom if one is running.

    Returns void

flush

  • flush(): void
  • 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

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

getActualWindowScaleHorizontal

  • getActualWindowScaleHorizontal(): number
  • Gets actual window scale for horizontal dimension of the control

    let actualWindowScaleHorizontal: number = chart.getActualWindowScaleHorizontal();

    Returns number

getActualWindowScaleVertical

  • getActualWindowScaleVertical(): number
  • Gets actual window scale for vertical dimension of the control

    let actualWindowScaleVertical: number = chart.getActualWindowScaleVertical();

    Returns number

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<__type>): SS | null
  • 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<__type>

    Returns SS | null

hideToolTip

  • hideToolTip(): void
  • Hides the active main tooltip, if displayed.

    this.chart.hideToolTip();

    Returns void

notifyClearItems

  • notifyClearItems(source_: any): 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

notifyContainerResized

  • notifyContainerResized(): void
  • Notification from the containing object that the container has been resized.

    Returns void

notifyInsertItem

  • notifyInsertItem(source_: any, index: number, newItem: any): void
  • Parameters

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

    Returns void

notifyRemoveItem

  • notifyRemoveItem(source_: any, index: number, oldItem: any): void
  • Parameters

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

    Returns void

notifySetItem

  • notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void
  • Parameters

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

    Returns void

render

  • render(): any
  • Returns any

resetZoom

  • resetZoom(): void
  • Resets the zoom level to default.

    Returns void

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof __type

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean
  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

startTiledZoomingIfNecessary

  • startTiledZoomingIfNecessary(): void
  • Manually starts a tiled zoom if one isn't already running.

    Returns void

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgrSeriesViewer