Represents the base class from which all IgxDataChartComponent polar line series are derived.

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 actualAreaFillOpacity(): number
  • Gets the actual opacity applied to the area fill visual.

    let actualFillOpacity: number = series.actualAreaFillOpacity;
    

    Returns number

  • set actualAreaFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualBrush(): string
  • Gets the effective brush for the current series object.

    let actualBrush: string = series.actualBrush;
    

    Returns string

  • set actualBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualCloseLabel(): string
  • Gets the text that is displayed for the Close label in the tooltip.

    Returns string

  • get actualHighLabel(): string
  • Gets the text that is displayed for the High label in the tooltip.

    Returns string

  • get actualHighlightedValuesFadeOpacity(): number
  • Gets actual HighlightedValues fade opacity

    Returns number

  • set actualHighlightedValuesFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualHighlightingFadeOpacity(): number
  • Gets actual highlighting fade opacity

    Returns number

  • set actualHighlightingFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualHighlightingMode(): SeriesHighlightingMode
  • Gets actual highlighting mode

    Returns SeriesHighlightingMode

  • set actualHighlightingMode(v): void
  • Parameters

    Returns void

  • get actualHitTestMode(): SeriesHitTestMode
  • Resolved method of hit testing to use when pointing to items in the chart.

    let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;
    

    Returns SeriesHitTestMode

  • set actualHitTestMode(v): void
  • Parameters

    Returns void

  • get actualItemSearchMode(): ScatterItemSearchMode
  • Returns ScatterItemSearchMode

  • set actualItemSearchMode(v): void
  • Parameters

    Returns void

  • get actualLayers(): IgrSeriesLayerCollection
  • Gets the actual extra layers for the series.

    Returns IgrSeriesLayerCollection

  • set actualLayers(v): void
  • Parameters

    Returns void

  • get actualLegendItemBadgeBrush(): string
  • Gets the effective legend badge fill for the current series.

    Returns string

  • set actualLegendItemBadgeBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualLegendItemBadgeOutline(): string
  • Gets the effective legend badge outline for the current series.

    Returns string

  • set actualLegendItemBadgeOutline(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns IgDataTemplate

  • set actualLegendItemBadgeTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get actualLowLabel(): string
  • Gets the text that is displayed for the Low label in the tooltip.

    Returns string

  • get actualMarkerBrush(): string
  • Gets the effective marker brush for the current series object.

    ActualMarkerBrush property gets the effective marker brush for the current series object. For example, you can use it like this:

     let effectiveMarkerBrush: string = this.series.actualMarkerBrush;

    Returns string

  • set actualMarkerBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualMarkerFillOpacity(): number
  • Gets the actual opacity applied to the fill of the markers.

    Returns number

  • set actualMarkerFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualMarkerOutline(): string
  • Gets the effective marker outline for the current series object.

    `ActualMarkerOutline` property gets the effective marker outline for the current series object. You can use it like this:
    
     let effectiveMarkerOutline: string = this.series.actualMarkerOutline;

    Returns string

  • set actualMarkerOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get actualMarkerTemplate(): IgDataTemplate
  • Gets the effective marker template for the current series object.

    ActualMarkerTemplate property gets the effective marker template for the current series object. You can use it like this:

    Returns IgDataTemplate

  • set actualMarkerTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get actualOpenLabel(): string
  • Gets the text that is displayed for the Open label in the tooltip.

    Returns string

  • get actualOutline(): string
  • Gets the effective outline for the current series object.

    let actualOutline: string = series.ActualOutline;
    

    Returns string

  • set actualOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get actualRadiusLabel(): string
  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

  • get actualResolution(): number
  • Returns number

  • set actualResolution(v): void
  • Parameters

    • v: number

    Returns void

  • get actualThickness(): number
  • Gets the effective Thickness for the current series object.

    Returns number

  • set actualThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get actualTrendLineBrush(): string
  • Gets the effective TrendLineBrush for this series.

    Returns string

  • set actualTrendLineBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualValueLabel(): string
  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

  • get actualVolumeLabel(): string
  • Gets the text that is displayed for the Volume label in the tooltip.

    Returns string

  • get angleAxis(): IgrNumericAngleAxis
  • Gets the effective angle axis for the current series object.

    Returns IgrNumericAngleAxis

  • set angleAxis(v): void
  • Parameters

    Returns void

  • get angleAxisName(): string
  • Gets or sets the name to use to resolve angleAxis from markup.

    Returns string

  • set angleAxisName(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set angleMemberAsLegendLabel(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set angleMemberAsLegendUnit(v): void
  • Parameters

    • v: string

    Returns void

  • get angleMemberPath(): string
  • Gets or sets the path to use to find the angle values for the series.

    Returns string

  • set angleMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get areaFillOpacity(): number
  • Gets or sets the opacity applied to the area fill visual. This property only applies to series that have area visual.

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

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    actualAreaFillOpacity= {1} />
    </IgrDataChart>

    Returns number

  • set areaFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get assigningPolarMarkerStyle(): ((s, e) => void)
  • Event raised when Assigning Polar Marker Style

    Returns ((s, e) => void)

  • set assigningPolarMarkerStyle(ev): void
  • Parameters

    Returns void

  • get assigningPolarStyle(): ((s, e) => void)
  • Event raised when Assigning Category Style

    Returns ((s, e) => void)

  • set assigningPolarStyle(ev): void
  • Parameters

    Returns void

  • get brush(): string
  • Gets or sets the brush to use for the series.

    The Brush along with the Outline and Negative Brush can be used to affect the visuals of the Series.

    this.series.brush = "red";
    
     <IgrDataChart
    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 string

  • set brush(v): void
  • Parameters

    • v: string

    Returns void

  • get clipSeriesToBounds(): boolean
  • Gets or sets whether to clip the series to the bounds. Setting this to true can effect performance.

    Returns boolean

  • set clipSeriesToBounds(v): void
  • Parameters

    • v: boolean

    Returns void

  • get coercionMethods(): any
  • Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

    <-- position: content member-->

    cMethods: any = {
    ValueCoercion: function(value:number): number {return value+2;}
    }
     <IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

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

    <IgrScatterPolygonSeries
    name="series1"
    shapeMemberPath="Points"
    title="House Floor Plan"
    brush="Gray"
    outline="Black"
    coercionMethods = {this.ValueCoercion} />
    </IgrDataChart>

    Returns any

  • set coercionMethods(v): void
  • Parameters

    • v: any

    Returns void

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

    Returns number[]

  • set dashArray(v): void
  • Parameters

    • v: number[]

    Returns void

  • get dataLegendKey(): string
  • Gets unique key used to identify the series in data legend

    Returns string

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Parameters

    • value: any

    Returns void

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

    Returns IgDataTemplate

  • set discreteLegendItemTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get expectFunctions(): boolean
  • Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

    expectFunctions is used to decide whether the series should expect that its data source members need to be called as functions to get their values.

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

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="MyFunction"
    expectFunctions={true} />
    </IgrDataChart>
    this.series.expectFunctions=true;
    

    Returns boolean

  • set expectFunctions(v): void
  • Parameters

    • v: boolean

    Returns void

  • get finalValue(): number
  • The final value of this series.

    Returns number

  • set finalValue(v): void
  • Parameters

    • v: number

    Returns void

  • get hasMarkers(): boolean
  • Returns whether the current series supports visual markers.

    HasMarkers property is overriden, it returns whether the current series supports visual markers. You can use it like this:

     let gotMarkers: boolean = this.series.hasMarkers;
    

    Returns boolean

  • get hasOnlyMarkers(): boolean
  • Gets whether the series has only marker as visuals

    Returns boolean

  • get hasValueAxis(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

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

    Returns string

  • set highlightedAngleMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightedDataSource(): any
  • Returns any

  • set highlightedDataSource(value): void
  • Parameters

    • value: any

    Returns void

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

    Returns string

  • set highlightedRadiusMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightedTitleSuffix(): string
  • Gets or sets the HighlightedTitleSuffix property.

    Returns string

  • set highlightedTitleSuffix(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode
  • Gets or sets whether and how to display highlighted values for the series. 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 highlightedValuesFadeOpacity(): number
  • Gets or sets the target opacity to fade to for fade style HighlightedValues.

    Returns number

  • set highlightedValuesFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set highlightingFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get hitTestMode(): SeriesHitTestMode
  • Method of hit testing to use when pointing to items in this series.

    The HitTestMode can be set to either:

    • Auto: automatically decide the appropriate hit test mode for the series.
    • ColorEncoded: use a color encoded off screen buffer for hit testing. Should always be O(1) time for determining a hit series. This increases frame render time and memory usage, however. Consider using this if hit testing time is degrading performance.
    • Computational: use a computational based approach to determine whether the series has been hit. This uses loose bounding boxes, in some cases, and can range in time complexity between O(1) and O(log n) to find a hit. This decreases frame render time compared to color encoded
    this.series.hitTestMode = SeriesHitTestMode.Computational;
    

    Returns SeriesHitTestMode

  • set hitTestMode(v): void
  • Parameters

    Returns void

  • get isActualLegendFinancial(): boolean
  • Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

    Returns boolean

  • set isActualLegendFinancial(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isAnnotationCalloutLayer(): boolean
  • Gets whether the series is an callout annotation layer.

    Returns boolean

  • get isAnnotationCrosshairLayer(): boolean
  • Gets whether the series is an crosshair annotation layer.

    Returns boolean

  • get isAnnotationFinalValue(): boolean
  • Gets whether the series is final value annotation layer.

    Returns boolean

  • get isAnnotationHoverLayer(): boolean
  • Gets whether the series is an annotation layer displayed only when hovering over the chart. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer

    Returns boolean

  • get isAnnotationLayer(): boolean
  • Gets whether the series is an annotation layer.

    let isAnnotationLayer: boolean = this.series.isAnnotationLayer;
    

    Returns boolean

  • get isAnnotationValueLayer(): boolean
  • Gets whether the series is a value annotation layer.

    Returns boolean

  • get isArea(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get isAreaOrLine(): boolean
  • Gets whether the current series shows an area or line shape.

    let isAreaorLine: boolean = this.series.isAreaorLine;
    

    Returns boolean

  • get isBar(): boolean
  • Gets whether the current series shows a horizontal column shape.

    Returns boolean

  • get isCategory(): boolean
  • Gets whether the current series is a category type series.

    let isCategory: boolean = this.series.isCategory;
    

    Returns boolean

  • get isColumn(): boolean
  • Gets whether the current series shows a column shape.

    Returns boolean

  • get isComponentHighlightingModeIgnored(): boolean
  • Gets or sets whether the component level highlight mode is ignored.

    Returns boolean

  • set isComponentHighlightingModeIgnored(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isCustomPolarMarkerStyleAllowed(): boolean
  • Gets or sets whether this Polar series should allow custom style overrides of its individual marker visuals.

    Returns boolean

  • set isCustomPolarMarkerStyleAllowed(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isCustomPolarStyleAllowed(): boolean
  • Gets or sets whether this Polar series should allow custom style overrides of its individual visuals.

    Returns boolean

  • set isCustomPolarStyleAllowed(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isDefaultCrosshairBehaviorDisabled(): boolean
  • Gets whether the default crosshair behavior should be disabled if this series is present.

    IsDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

    let isDefaultCrosshairBehaviorDisabled: boolean = this.series.isDefaultCrosshairBehaviorDisabled;
    

    Returns boolean

  • get isDefaultToolTipSelected(): boolean
  • Gets if the default tooltip has been selected for display.

    To use the default tooltip set ShowDefaultTooltip to true.

    let isDefaultToolTipSelected: boolean = this.series.isDefaultToolTipSelected;
    

    Returns boolean

  • set isDefaultToolTipSelected(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isDefaultTooltipBehaviorDisabled(): boolean
  • Gets whether the default tooltip behavior should be disabled if this series is present.

     let isDefaultTooltipBehaviorDisabled: boolean = this.series.isDefaultTooltipBehaviorDisabled;
    

    Returns boolean

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

    IsDropShadowEnabled is used to decide whether drop shadow should be enabled for this series.

    this.series.isDropShadowEnabled = true;
    
    <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isDropShadowEnabled="true" />
    </IgrDataChart>

    Returns boolean

  • set isDropShadowEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isFinancial(): boolean
  • Gets whether the current series is a financial type series.

    let isFinancial: boolean = this.series.isFinancial;
    

    Returns boolean

  • get isFinancialIndicator(): boolean
  • Gets whether the series is financial indicator

    Returns boolean

  • get isFinancialOverlay(): boolean
  • Gets whether the series is financial overlay

    Returns boolean

  • get isFinancialSeries(): boolean
  • Gets whether the series has financial OHLC/candlestick visuals

    Returns boolean

  • get isFinancialWaterfall(): boolean
  • Gets whether the series is financial waterfall

    Returns boolean

  • get isFragment(): boolean
  • Gets whether the current series is a stack fragment.

    let isFragment: boolean = this.series.isFragment;
    

    Returns boolean

  • get isGeographic(): boolean
  • Gets whether the current series is a geographic series.

    let isGeographic: boolean = this.series.isGeographic;
    

    Returns boolean

  • get isHighlightingEnabled(): boolean
  • Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

    this.series.isHighlightingEnabled = true;
    
    <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isHighlightingEnabled="true" />
    </IgrDataChart>

    Returns boolean

  • set isHighlightingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isIndexed(): boolean
  • Gets if the series uses an index, which can be used to auto-assign it a color.

    let isIndexed: boolean = this.series.isIndexed;
    

    Returns boolean

  • get isLineContour(): boolean
  • Gets whether the current series shows a line contour shape.

    Returns boolean

  • get isLineOnly(): boolean
  • Gets whether the current series shows only line shapes.

    Returns boolean

  • get isMarkerlessDisplayPreferred(): boolean
  • Overridden by derived series classes to indicate when markerless display is preferred or not.

    Returns boolean

  • get isNegativeColorSupported(): boolean
  • Overridden by derived series classes to indicate when negative colors are supported or not.

    Returns boolean

  • get isPie(): boolean
  • Gets whether the current series shows a pie shape.

    Returns boolean

  • get isPixel(): boolean
  • Gets whether the current series shows pixels.

    Returns boolean

  • get isPolar(): boolean
  • Checks if this series is a polar series

    Returns boolean

  • get isPolygon(): boolean
  • Gets whether the current series shows a polygon shape.

    Returns boolean

  • get isPolyline(): boolean
  • Gets whether the current series shows a polyline shape.

    Returns boolean

  • get isRadial(): boolean
  • Gets whether the current series is a radial type series.

    let isRadial: boolean = this.series.isRadial;
    

    Returns boolean

  • get isRange(): boolean
  • Gets whether the current series is a range type series.

    let isRange: boolean = this.series.isRange;
    

    Returns boolean

  • get isScatter(): boolean
  • Gets whether the current series is a scatter type series.

    let isScatter: boolean = this.series.isScatter;
    

    Returns boolean

  • get isShape(): boolean
  • Gets whether the current series is a shape type series.

    Returns boolean

  • get isShapeControl(): boolean
  • Gets whether the current series shows interactive shape controls.

    Returns boolean

  • get isSpline(): boolean
  • Gets whether the current series shows a spline shape.

    Returns boolean

  • get isStacked(): boolean
  • Gets whether the current series is a stacked type series.

    let isStacked: boolean = this.series.isStacked;
    

    Returns boolean

  • get isStep(): boolean
  • Gets whether the current series shows step shapes.

    Returns boolean

  • get isSummarizationSupported(): boolean
  • Returns boolean

  • get isTile(): boolean
  • Gets whether the current series shows a tile imagery.

    Returns boolean

  • get isUsableInLegend(): boolean
  • Gets if the series should appear in any legends.

    let isUsableInLegend: boolean = this.series.isUsableInLegend;
    

    Returns boolean

  • get isValueAxisInverted(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get isValueOverlay(): boolean
  • Gets whether the series is a value overlay.

    Returns boolean

  • get isVertical(): boolean
  • Gets whether the current series is oriented vertically.

    let isVertical: boolean = this.series.isVertical;
    

    Returns boolean

  • get isWaterfall(): boolean
  • Gets whether the current series shows a waterfall column shape.

    Returns boolean

  • get itemSearchMode(): ScatterItemSearchMode
  • Gets or sets the mode the series will use to find the closest point to the cursor.

    Returns ScatterItemSearchMode

  • set itemSearchMode(v): void
  • Parameters

    Returns void

  • get itemSearchThreshold(): number
  • Gets or sets the threshold to use when searching for items using ItemSearchMode.

    Returns number

  • set itemSearchThreshold(v): void
  • Parameters

    • v: number

    Returns void

  • get layers(): IgrSeriesLayerCollection
  • Gets the current extra layers for the series.

    Returns IgrSeriesLayerCollection

  • set layers(v): void
  • Parameters

    Returns void

  • get legend(): any
  • Gets or sets the legend used for the current series.

    Returns any

  • set legend(v): void
  • Parameters

    • v: any

    Returns void

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

    Returns LegendItemBadgeMode

  • set legendItemBadgeMode(v): void
  • Parameters

    • v: LegendItemBadgeMode

    Returns void

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

    Returns LegendItemBadgeShape

  • set legendItemBadgeShape(v): void
  • Parameters

    • v: LegendItemBadgeShape

    Returns void

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

    Returns IgDataTemplate

  • set legendItemBadgeTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

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

    Returns IgDataTemplate

  • set legendItemTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

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

    The LegendItemVisibilty can be used to exclude only certain Series from the Legend.

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

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    legendItemVisibility= "collapsed" />
    </IgrDataChart>

    Returns Visibility

  • set legendItemVisibility(v): void
  • Parameters

    • v: Visibility

    Returns void

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

    Returns PenLineCap

  • set lineCap(v): void
  • Parameters

    • v: PenLineCap

    Returns void

  • get lineJoin(): PenLineJoin
  • Gets or sets the brush that specifies current series object's line join style.

    Returns PenLineJoin

  • set lineJoin(v): void
  • Parameters

    • v: PenLineJoin

    Returns void

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

    MarkerBrush property gets or sets the brush that specifies how the current series object's marker interiors are painted. You can use it like this:

    this.series.markerBrush = "red";
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

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

    Returns string

  • set markerBrush(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns MarkerFillMode

  • set markerFillMode(v): void
  • Parameters

    Returns void

  • get markerFillOpacity(): number
  • Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

    Returns number

  • set markerFillOpacity(v): void
  • Parameters

    • v: number

    Returns void

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

    MarkerOutline property gets or sets the brush that specifies how the current series object's marker outlines are painted. You can use it like this:

    this.series.markerOutline = "red";
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

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

    Returns string

  • set markerOutline(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns MarkerOutlineMode

  • set markerOutlineMode(v): void
  • Parameters

    Returns void

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

    MarkerTemplate property gets or sets the MarkerTemplate for the current series object. For example, you can use it like this:

    Returns IgDataTemplate

  • set markerTemplate(v): void
  • Parameters

    • v: IgDataTemplate

    Returns void

  • get markerThickness(): number
  • Gets or sets thickness of the marker outline

    Returns number

  • set markerThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get markerType(): MarkerType
  • Gets or sets the marker type for the current series object. This property is ignored when the MarkerTemplate property is set

    MarkerType property gets or sets the marker type for the current series object. For example, you can set it like this:

    this.series.markerType = "circle";
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

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

    Returns MarkerType

  • set markerType(v): void
  • Parameters

    Returns void

  • get maximumMarkers(): number
  • Gets or sets the maximum number of markers displayed by the current series. If more than the specified number of markers are visible, the polar series will automatically choose a representative set.

    Returns number

  • set maximumMarkers(v): void
  • Parameters

    • v: number

    Returns void

  • get mouseOverEnabled(): boolean
  • Gets or sets the whether the chart reacts to mouse move events.

    Returns boolean

  • set mouseOverEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get opacity(): number
  • Returns number

  • set opacity(v): void
  • Parameters

    • v: number

    Returns void

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

    The Outline along with the Brush and NegativeBrush can be used to affect the visuals of the Series.

    this.series.brush = "red";
    
     <IgrDataChart
    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 string

  • set outline(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns SeriesOutlineMode

  • set outlineMode(v): void
  • Parameters

    Returns void

  • get percentChange(): number
  • The percent change from the beginning to the end of this series.

    Returns number

  • set percentChange(v): void
  • Parameters

    • v: number

    Returns void

  • get radiusAxis(): IgrNumericRadiusAxis
  • Gets the effective radius axis for the current series object.

    Returns IgrNumericRadiusAxis

  • set radiusAxis(v): void
  • Parameters

    Returns void

  • get radiusAxisName(): string
  • Gets or sets the name to use to resolve radiusAxis from markup.

    Returns string

  • set radiusAxisName(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set radiusMemberAsLegendLabel(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set radiusMemberAsLegendUnit(v): void
  • Parameters

    • v: string

    Returns void

  • get radiusMemberPath(): string
  • Gets or sets the path to use to get the radius values for the series.

    Returns string

  • set radiusMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get renderRequested(): ((s, e) => void)
  • This event is raised every time a render has been requested from a series.

     const series1 = new IgrAreaSeries({ name: "series1" });
    series1.valueMemberPath = "USA";
    series1.title = "USA";
    series1.xAxisName = "xAxis";
    series1.yAxisName = "yAxis";
    series1.renderRequested= this.onRenderRequested;

    public onRenderRequested =( s:IgrSeries, e: RenderRequestedEventArgs) => {
    }
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    shadowBlur="7"
    shadowColor="blue"
    renderRequested= {this.onRenderRequested}/>
    </IgrDataChart>

    Returns ((s, e) => void)

      • (s, e): void
      • This event is raised every time a render has been requested from a series.

         const series1 = new IgrAreaSeries({ name: "series1" });
        series1.valueMemberPath = "USA";
        series1.title = "USA";
        series1.xAxisName = "xAxis";
        series1.yAxisName = "yAxis";
        series1.renderRequested= this.onRenderRequested;

        public onRenderRequested =( s:IgrSeries, e: RenderRequestedEventArgs) => {
        }
         <IgrDataChart
        dataSource={this.state.dataSource} >

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

        <IgrAreaSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value"
        shadowBlur="7"
        shadowColor="blue"
        renderRequested= {this.onRenderRequested}/>
        </IgrDataChart>

        Parameters

        Returns void

  • set renderRequested(ev): void
  • Parameters

    Returns void

  • get resolution(): number
  • Gets or sets the current series object's rendering resolution.

    Setting the Resolution on a Series to a higher value can help with performance, but it will lower the graphical fidelity of the line. As such, it can be increased up until the fidelity is unacceptable.

    this.series.resolution = 1.5;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    resolution= {1.5} />
    </IgrDataChart>

    Returns number

  • set resolution(v): void
  • Parameters

    • v: number

    Returns void

  • get safeActualBrush(): string
  • Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

    Returns string

  • set safeActualBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get seriesInternal(): any
  • Returns any

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

    ShadowBlur can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowBlur = 7;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    shadowBlur={7}
    shadowColor="blue" />
    </IgrDataChart>

    Returns number

  • set shadowBlur(v): void
  • Parameters

    • v: number

    Returns void

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

    ShadowColor can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowColor = "blue";
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    shadowBlur="7"
    shadowColor="blue" />
    </IgrDataChart>

    Returns string

  • set shadowColor(v): void
  • Parameters

    • v: string

    Returns void

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

    ShadowOffsetX can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowOffsetX = 10;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    shadowOffsetX= {10}
    shadowOffsetY={10] />
    </IgrDataChart>

    Returns number

  • set shadowOffsetX(v): void
  • Parameters

    • v: number

    Returns void

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

    ShadowOffsetY can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowOffsetY = 10;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    shadowOffsetX= {10}
    shadowOffsetY= {10} />
    </IgrDataChart>

    Returns number

  • set shadowOffsetY(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns boolean

  • set shouldAnimateOnDataSourceSwap(v): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldHideAutoCallouts(): boolean
  • Gets or sets whether this series should suppress it's auto callouts

    Returns boolean

  • set shouldHideAutoCallouts(v): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldShiftOpacityForSafeActualBrush(): boolean
  • Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

    Returns boolean

  • set shouldShiftOpacityForSafeActualBrush(v): void
  • Parameters

    • v: boolean

    Returns void

  • get showDefaultTooltip(): boolean
  • Gets or sets whether default tooltip will be shown.

    The default tooltips display all the information relevant to the particular series item (series title, data values, axis values etc.) and are styled to match the series' style. When using default tooltips, you should also set the series Title.

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

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    showDefaultTooltip ="true"
    title="InStock Items" />
    </IgrDataChart>
    this.series.showDefaultTooltip ="true";
    

    Returns boolean

  • set showDefaultTooltip(v): void
  • Parameters

    • v: boolean

    Returns void

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

    Depending on the Series type, this can be the main brush used, or just the outline. For example, when using a LineSeries it will affect the thickness of the lines drawn, whereas when using a ColumnSeries it will affect the outer border thickness of the columns.

    this.series.thickness=5;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    thickness= {5} />
    </IgrDataChart>

    Returns number

  • set thickness(v): void
  • Parameters

    • v: number

    Returns void

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

    The Series Title may be used in tooltips and legends.

    this.series.title = "InStock Items";
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    title="InStock Items" />
    </IgrDataChart>

    Returns any

  • set title(v): void
  • Parameters

    • v: any

    Returns void

  • get tooltipContainerTemplate(): FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>
  • Returns FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

  • set tooltipContainerTemplate(value): void
  • Parameters

    • value: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

    Returns void

  • get tooltipTemplate(): FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>
  • Returns FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

  • set tooltipTemplate(value): void
  • Parameters

    • value: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

    Returns void

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

    The TransitionDuration can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

    this.series.transitionDuration = 500;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isTransitionInEnabled=true
    transitionInSpeedType="indexScaled"
    transitionDuration= {500}
    transitionInDuration = {500} />
    </IgrDataChart>

    Returns number

  • set transitionDuration(v): void
  • Parameters

    • v: number

    Returns void

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

    The TransitioninDuration and TransitionEasingFunction can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

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

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isDropShadowEnabled=true
    markerType="circle"
    transitionEasingFunction ="cubicEase"
    isTransitionInEnabled= {true} />
    </IgrDataChart>
    this.series.transitionEasingFunction =  EasingFunctions.cubicEase;
    

    Returns ((time) => number)

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

        The TransitioninDuration and TransitionEasingFunction can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

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

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

        <IgrAreaSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value"
        isDropShadowEnabled=true
        markerType="circle"
        transitionEasingFunction ="cubicEase"
        isTransitionInEnabled= {true} />
        </IgrDataChart>
        this.series.transitionEasingFunction =  EasingFunctions.cubicEase;
        

        Parameters

        • time: number

        Returns number

  • set transitionEasingFunction(v): void
  • Parameters

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

          • time: number

          Returns number

    Returns void

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

    The TransitionInDuration can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

    this.series.transitionDuration = 500;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isTransitionInEnabled= {true}
    transitionInSpeedType="indexScaled"
    transitionDuration={500}
    transitionInDuration= {500} />
    </IgrDataChart>

    Returns number

  • set transitionInDuration(v): void
  • Parameters

    • v: number

    Returns void

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

    The TransitionInEasingFunction can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

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

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isDropShadowEnabled=true
    markerType="circle"
    transitionInEasingFunction ="cubicEase"
    isTransitionInEnabled= {true} />
    </IgrDataChart>
    this.series.transitionInEasingFunction =  EasingFunctions.cubicEase;
    

    Returns ((time) => number)

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

        The TransitionInEasingFunction can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

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

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

        <IgrAreaSeries
        name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value"
        isDropShadowEnabled=true
        markerType="circle"
        transitionInEasingFunction ="cubicEase"
        isTransitionInEnabled= {true} />
        </IgrDataChart>
        this.series.transitionInEasingFunction =  EasingFunctions.cubicEase;
        

        Parameters

        • time: number

        Returns number

  • set transitionInEasingFunction(v): void
  • Parameters

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

          • time: number

          Returns number

    Returns void

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

    The TransitionInSpeedType can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

    this.series.transitionInSpeedType = TransitionInSpeedType.IndexScaled;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isTransitionInEnabled=true
    transitionInSpeedType="indexScaled"
    transitionDuration=500
    transitionInDuration=500 />
    </IgrDataChart>

    Returns TransitionInSpeedType

  • set transitionInSpeedType(v): void
  • Parameters

    Returns void

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

    Returns number

  • set transitionOutDuration(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns ((time) => number)

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

        Parameters

        • time: number

        Returns number

  • set transitionOutEasingFunction(v): void
  • Parameters

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

          • time: number

          Returns number

    Returns void

  • get transitionOutSpeedType(): TransitionOutSpeedType
  • Gets or sets the duration of the current series's transition out morph.

    Returns TransitionOutSpeedType

  • set transitionOutSpeedType(v): void
  • Parameters

    Returns void

  • get trendLineBrush(): string
  • Gets or sets the brush that specifies how the current series object's trend line is drawn.

    Returns string

  • set trendLineBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get trendLineDashArray(): number[]
  • Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current series object.

    Returns number[]

  • set trendLineDashArray(v): void
  • Parameters

    • v: number[]

    Returns void

  • get trendLinePeriod(): number
  • Gets or sets the moving average period for the current series object.

    Returns number

  • set trendLinePeriod(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns number

  • set trendLineThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get trendLineType(): TrendLineType
  • Gets or sets the trend type for the current series object.

    Returns TrendLineType

  • set trendLineType(v): void
  • Parameters

    • v: TrendLineType

    Returns void

  • get trendLineZIndex(): number
  • Sets or Gets the Trendline Z index.

    Returns number

  • set trendLineZIndex(v): void
  • Parameters

    • v: number

    Returns void

  • get useCartesianInterpolation(): boolean
  • Gets or sets whether Cartesian Interpolation should be used rather than Archimedian spiral based interpolation.

    Returns boolean

  • set useCartesianInterpolation(v): void
  • Parameters

    • v: boolean

    Returns void

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

    this.series.useSingleShadow = true;
    
     <IgrDataChart
    dataSource={this.state.dataSource} >

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

    <IgrAreaSeries
    name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    isDropShadowEnabled=true
    markerType="circle"
    useSingleShadow= {true} />
    </IgrDataChart>

    Returns boolean

  • set useSingleShadow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get visibility(): Visibility
  • Returns Visibility

  • set visibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get visibleRangeMarginBottom(): number
  • Gets or sets the bottom margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMarginLeft(): number
  • Gets or sets the left margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMarginRight(): number
  • Gets or sets the right margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginRight(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMarginTop(): number
  • Gets or sets the top margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginTop(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMode(): SeriesVisibleRangeMode
  • Gets or sets the visible range mode to use.

    Returns SeriesVisibleRangeMode

  • set visibleRangeMode(v): void
  • Parameters

    Returns void

Methods

  • Determine if object can be used as AngleAxis

    Parameters

    • axis: any
      • The object to check

    Returns boolean

  • Determine if object can be used as RadiusAxis

    Parameters

    • axis: any
      • The object to check

    Returns boolean

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

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

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

    Parameters

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

    Returns void

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

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

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

    Parameters

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

    Returns IgPoint

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

    Returns IgRect

  • Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

    Parameters

    • world: IgPoint
      • The world position for which to return the index.
      let index: number = this.series.getExactItemIndex({x:.5,y:.5});
      

    Returns number

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

    Parameters

    • world: IgPoint
      • The world coordinates to use.

    Returns any

  • Gets the index of the item that resides at the provided world coordinates.

    Parameters

    • world: IgPoint
      • The world coordinates of the requested item.

    Returns number

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

    let span: number = this.series.getItemSpan();
    

    Returns number

  • Parameters

    • item: any
    • memberPathName: string

    Returns any

  • Parameters

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

  • Parameters

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

    Returns number

  • Parameters

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

    Returns IgPoint

  • Parameters

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

    Returns number

  • Parameters

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

    Returns IgPoint

  • Parameters

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

    Returns number

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

    Parameters

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

    Returns IgRect

  • Parameters

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

    Returns number

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

    Parameters

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

    Returns IgRect

  • Parameters

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

    Returns IgPoint

  • Parameters

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

    Returns IgPoint

  • Gets the data values of each axis associated with the specified value type. For example, if you specify mode as Maximum then it will return the maximum numerical value for each axis. For non-numerical axes it will return NaN.

    Parameters

    Returns number[]

  • 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 any internal tooltips presented by the series, if any.

    Returns void

  • Hides any internal tooltips presented by the series, if any.

    Returns void

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

    Parameters

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

      MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.

      this.crosshair.moveCursorPoint({x:.5,y:.5});
      

    Returns void

  • Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series

    Returns void

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

    Returns void

  • Plays the assigned transition out animation, if any.

    Returns void

  • Plays the assigned transition out animation, if any.

    Returns void

  • Plays the assigned transition out animation, if any.

    Returns void

  • Parameters

    • data: any[]

    Returns void

  • Parameters

    • data: any[]

    Returns void

  • Removes all alternate views of this series.

    Returns void

  • Removes an alternate view of this series.

    Parameters

    • viewIdentifier: string
      • The string identifier for the view to remove.

    Returns void

  • Call to null out the axes of the series;

    Returns void

  • Returns any

  • Renders the series.

    Parameters

    • animate: boolean
      • True if the change should be animated.
      this.series.renderSeries(true);
      

    Returns void

  • Replays the assigned transition in animation, if any.

    this.series.replayTransitionIn();
    

    Returns void

  • Gets the brush for tooltip labels.

    Returns string

  • Scrolls the requested item into view, if possible.

    Parameters

    • item: any
      • The item to scroll into view.

    Returns boolean

  • Parameters

    • negativeBrush: string
    • negativeOutline: string

    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

  • Simulates a pointer hover over the series surface.

    Parameters

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

      When tooltips are enabled, SimulateHover can be used to automatically display the tooltip over a particular series item.

      this.series.simulateHover({x:250,y:250});
      

    Returns void

  • Called when this series' Style is updated.

    Returns void

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

    Parameters

    • seriesPoint: IgPoint
      • The pixel location within the plot area of the series.
      this.series.toWorldPosition({x:500,y:500});
      

    Returns IgPoint