Represents a chart with an ordinal X-axis and a numeric Y-axis.

Ignite UI for React Category Chart - Documentation

The Ignite UI Category Chart is a lightweight, highly performant chart. It can be easily configured to display category data using an extremely simple and intuitive API. All you need to do is provide your data to the chart and it will take care of everything else.

Example:

``

Constructors

Section titled "Constructors"

IgrCategoryChart 

new IgrCategoryChart(props: IIgrCategoryChartProps): IgrCategoryChart

Returns IgrCategoryChart

Accessors

Section titled "Accessors"

actualBrushes

Section titled "actualBrushes"

Inherited from: IgrXYChart

Gets the actual palette of brushes to use for coloring the chart series.

 
get actualBrushes(): string[]

Returns string[] 

set actualBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

actualOutlines

Section titled "actualOutlines"

Inherited from: IgrXYChart

Gets the actual palette of brushes to use for outlines on the chart series.

 
get actualOutlines(): string[]

Returns string[] 

set actualOutlines(v: string[]): void

Parameters

  • v: string[]

Returns void

actualXAxisLabelTextColor

Section titled "actualXAxisLabelTextColor"

Inherited from: IgrXYChart

Gets the actual color of labels on the X-axis

 
get actualXAxisLabelTextColor(): string

Returns string 

set actualXAxisLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

actualYAxisLabelTextColor

Section titled "actualYAxisLabelTextColor"

Inherited from: IgrXYChart

Gets the actual color of labels on the Y-axis

 
get actualYAxisLabelTextColor(): string

Returns string 

set actualYAxisLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

alignsGridLinesToPixels

Section titled "alignsGridLinesToPixels"

Inherited from: IgrXYChart

Gets or sets a value indicating whether grid and tick lines are aligned to device pixels.

Use AlignsGridLinesToPixels propert to indicat whether grid and tick lines are aligned to device pixels.

``

 
get alignsGridLinesToPixels(): boolean

Returns boolean 

set alignsGridLinesToPixels(v: boolean): void

Parameters

  • v: boolean

Returns void

animateSeriesWhenAxisRangeChanges

Section titled "animateSeriesWhenAxisRangeChanges"

Inherited from: IgrXYChart

Gets or sets whether the series animations should be allowed when a range change has been detected on an axis.

 
get animateSeriesWhenAxisRangeChanges(): boolean

Returns boolean 

set animateSeriesWhenAxisRangeChanges(v: boolean): void

Parameters

  • v: boolean

Returns void

areaFillOpacity

Section titled "areaFillOpacity"

Inherited from: IgrXYChart

Gets or sets the fill opacity for all series that have area visuals in this chart. For example, Area, SplineArea, Column chart types

 
get areaFillOpacity(): number

Returns number 

set areaFillOpacity(v: number): void

Parameters

  • v: number

Returns void

autoCalloutsVisible

Section titled "autoCalloutsVisible"

Inherited from: IgrXYChart

Gets or sets if the auto value callouts should be displayed.

 
get autoCalloutsVisible(): boolean

Returns boolean 

set autoCalloutsVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

autoExpandMarginExtraPadding

Section titled "autoExpandMarginExtraPadding"

Gets or sets the extra amount the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

 
get autoExpandMarginExtraPadding(): number

Returns number 

set autoExpandMarginExtraPadding(v: number): void

Parameters

  • v: number

Returns void

autoExpandMarginMaximumValue

Section titled "autoExpandMarginMaximumValue"

Gets or sets the maximum amount the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

 
get autoExpandMarginMaximumValue(): number

Returns number 

set autoExpandMarginMaximumValue(v: number): void

Parameters

  • v: number

Returns void

autoMarginAndAngleUpdateMode

Section titled "autoMarginAndAngleUpdateMode"

Gets or sets a whether the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

 
get autoMarginAndAngleUpdateMode(): AutoMarginsAndAngleUpdateMode

Returns AutoMarginsAndAngleUpdateMode 

set autoMarginAndAngleUpdateMode(v: AutoMarginsAndAngleUpdateMode): void

Parameters

Returns void

bottomMargin

Section titled "bottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin around the chart content.

Use the bottomMargin property for the bottom margin around the chart content.

``

``

 
get bottomMargin(): number

Returns number 

set bottomMargin(v: number): void

Parameters

  • v: number

Returns void

brushes

Section titled "brushes"

Inherited from: IgrXYChart

Gets or sets the palette of brushes to use for coloring the chart series. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

Use the Brushes property to set the brushes.

``

 
get brushes(): string[]

Returns string[] 

set brushes(v: string[]): void

Parameters

  • v: string[]

Returns void

calloutCollisionMode

Section titled "calloutCollisionMode"

Inherited from: IgrXYChart

Gets or sets if event annotations should be displayed.

 
get calloutCollisionMode(): CalloutCollisionMode

Returns CalloutCollisionMode 

set calloutCollisionMode(v: CalloutCollisionMode): void

Parameters

  • v: CalloutCollisionMode

Returns void

calloutLabelUpdating

Section titled "calloutLabelUpdating"

Inherited from: IgrXYChart

Occurs when the style of a callout is updated.

 
get calloutLabelUpdating(): object

Returns object 

set calloutLabelUpdating(ev: object): void

Parameters

  • ev: object

Returns void

calloutRenderStyleUpdating

Section titled "calloutRenderStyleUpdating"

Inherited from: IgrXYChart

Occurs when the style of a callout is updated.

 
get calloutRenderStyleUpdating(): object

Returns object 

set calloutRenderStyleUpdating(ev: object): void

Parameters

  • ev: object

Returns void

calloutsAllowedPositions

Section titled "calloutsAllowedPositions"

Inherited from: IgrXYChart

Gets or sets the allowed positions that the callout layer is allowed to use.

 
get calloutsAllowedPositions(): IgrCalloutPlacementPositionsCollection

Returns IgrCalloutPlacementPositionsCollection 

set calloutsAllowedPositions(v: IgrCalloutPlacementPositionsCollection): void

Parameters

Returns void

calloutsAutoLabelPrecision

Section titled "calloutsAutoLabelPrecision"

Inherited from: IgrXYChart

Gets or sets the amount of precision to apply to the auto callout labels.

 
get calloutsAutoLabelPrecision(): number

Returns number 

set calloutsAutoLabelPrecision(v: number): void

Parameters

  • v: number

Returns void

calloutsBackground

Section titled "calloutsBackground"

Inherited from: IgrXYChart

Gets or sets color of the callout background.

 
get calloutsBackground(): string

Returns string 

set calloutsBackground(v: string): void

Parameters

  • v: string

Returns void

calloutsContentMemberPath

Section titled "calloutsContentMemberPath"

Inherited from: IgrXYChart

Gets or sets the member path of the content data for the callouts.

 
get calloutsContentMemberPath(): string

Returns string 

set calloutsContentMemberPath(v: string): void

Parameters

  • v: string

Returns void

calloutsDarkTextColor

Section titled "calloutsDarkTextColor"

Inherited from: IgrXYChart

Gets or sets the text color on light callout background.

 
get calloutsDarkTextColor(): string

Returns string 

set calloutsDarkTextColor(v: string): void

Parameters

  • v: string

Returns void

calloutsDataSource

Section titled "calloutsDataSource"

Inherited from: IgrXYChart 

get calloutsDataSource(): any[]

Returns any[] 

set calloutsDataSource(value: any[]): void

Parameters

  • value: any[]

Returns void

calloutsLabelMemberPath

Section titled "calloutsLabelMemberPath"

Inherited from: IgrXYChart

Gets or sets the member path of the label data for the callouts.

 
get calloutsLabelMemberPath(): string

Returns string 

set calloutsLabelMemberPath(v: string): void

Parameters

  • v: string

Returns void

calloutsLeaderBrush

Section titled "calloutsLeaderBrush"

Inherited from: IgrXYChart

Gets or sets color of callout's leader lines.

 
get calloutsLeaderBrush(): string

Returns string 

set calloutsLeaderBrush(v: string): void

Parameters

  • v: string

Returns void

calloutsLightTextColor

Section titled "calloutsLightTextColor"

Inherited from: IgrXYChart

Gets or sets the text color on dark callout background.

 
get calloutsLightTextColor(): string

Returns string 

set calloutsLightTextColor(v: string): void

Parameters

  • v: string

Returns void

calloutsOutline

Section titled "calloutsOutline"

Inherited from: IgrXYChart

Gets or sets color of the callout outlines.

 
get calloutsOutline(): string

Returns string 

set calloutsOutline(v: string): void

Parameters

  • v: string

Returns void

calloutsStrokeThickness

Section titled "calloutsStrokeThickness"

Inherited from: IgrXYChart

Gets or sets if the thickness that should be used for the callout outlines.

 
get calloutsStrokeThickness(): number

Returns number 

set calloutsStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

calloutsTextColor

Section titled "calloutsTextColor"

Inherited from: IgrXYChart

Gets or sets text color of callout.

 
get calloutsTextColor(): string

Returns string 

set calloutsTextColor(v: string): void

Parameters

  • v: string

Returns void

calloutsTextStyle

Section titled "calloutsTextStyle"

Inherited from: IgrXYChart

Gets or sets the font for callout text.

 
get calloutsTextStyle(): string

Returns string 

set calloutsTextStyle(v: string): void

Parameters

  • v: string

Returns void

calloutStyleUpdating

Section titled "calloutStyleUpdating"

Inherited from: IgrXYChart

Occurs when the style of a callout is updated.

 
get calloutStyleUpdating(): object

Returns object 

set calloutStyleUpdating(ev: object): void

Parameters

  • ev: object

Returns void

calloutStyleUpdatingEventEnabled

Section titled "calloutStyleUpdatingEventEnabled"

Inherited from: IgrXYChart

Gets or sets if event annotations should be displayed.

 
get calloutStyleUpdatingEventEnabled(): boolean

Returns boolean 

set calloutStyleUpdatingEventEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

calloutsUseAutoContrastingLabelColors

Section titled "calloutsUseAutoContrastingLabelColors"

Inherited from: IgrXYChart

Gets or sets whether to the label color is automatically decided between a light and dark option for contrast.

 
get calloutsUseAutoContrastingLabelColors(): boolean

Returns boolean 

set calloutsUseAutoContrastingLabelColors(v: boolean): void

Parameters

  • v: boolean

Returns void

calloutsUseItemColorForFill

Section titled "calloutsUseItemColorForFill"

Inherited from: IgrXYChart

Gets or sets if the series item color should be used for the callout fills.

 
get calloutsUseItemColorForFill(): boolean

Returns boolean 

set calloutsUseItemColorForFill(v: boolean): void

Parameters

  • v: boolean

Returns void

calloutsUseItemColorForOutline

Section titled "calloutsUseItemColorForOutline"

Inherited from: IgrXYChart

Gets or sets if the series item color should be used for the callout outlines.

 
get calloutsUseItemColorForOutline(): boolean

Returns boolean 

set calloutsUseItemColorForOutline(v: boolean): void

Parameters

  • v: boolean

Returns void

calloutsVisible

Section titled "calloutsVisible"

Inherited from: IgrXYChart

Gets or sets if callouts should be displayed.

 
get calloutsVisible(): boolean

Returns boolean 

set calloutsVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

calloutsXMemberPath

Section titled "calloutsXMemberPath"

Inherited from: IgrXYChart

Gets or sets the member path of the X data for the callouts.

 
get calloutsXMemberPath(): string

Returns string 

set calloutsXMemberPath(v: string): void

Parameters

  • v: string

Returns void

calloutsYMemberPath

Section titled "calloutsYMemberPath"

Inherited from: IgrXYChart

Gets or sets the member path of the Y data for the callouts.

 
get calloutsYMemberPath(): string

Returns string 

set calloutsYMemberPath(v: string): void

Parameters

  • v: string

Returns void

chartTitle

Section titled "chartTitle"

Inherited from: IgrXYChart

Gets or sets text to display above the plot area.

Use the Title property to display the text above the plot area.

``

``

 
get chartTitle(): string

Returns string 

set chartTitle(v: string): void

Parameters

  • v: string

Returns void

chartType

Section titled "chartType"

Gets or sets the type of chart series to generate from the data.

The ChartType property determines the type of data series to display.

``

 
get chartType(): CategoryChartType

Returns CategoryChartType 

set chartType(v: CategoryChartType): void

Parameters

Returns void

computedPlotAreaMarginMode

Section titled "computedPlotAreaMarginMode"

Inherited from: IgrXYChart

Gets or sets mode to use for automatically calculating the plot area margin.

 
get computedPlotAreaMarginMode(): ComputedPlotAreaMarginMode

Returns ComputedPlotAreaMarginMode 

set computedPlotAreaMarginMode(v: ComputedPlotAreaMarginMode): void

Parameters

Returns void

crosshairsAnnotationEnabled

Section titled "crosshairsAnnotationEnabled"

Inherited from: IgrXYChart

Gets or sets whether annotations are shown along the axis for crosshair values

 
get crosshairsAnnotationEnabled(): boolean

Returns boolean 

set crosshairsAnnotationEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

crosshairsAnnotationXAxisBackground

Section titled "crosshairsAnnotationXAxisBackground"

Inherited from: IgrXYChart

Gets or sets the background of crosshair annotation on x-axis.

 
get crosshairsAnnotationXAxisBackground(): string

Returns string 

set crosshairsAnnotationXAxisBackground(v: string): void

Parameters

  • v: string

Returns void

crosshairsAnnotationXAxisPrecision

Section titled "crosshairsAnnotationXAxisPrecision"

Inherited from: IgrXYChart

Gets or sets precision on interpolated values of crosshairs on x-axis.

 
get crosshairsAnnotationXAxisPrecision(): number

Returns number 

set crosshairsAnnotationXAxisPrecision(v: number): void

Parameters

  • v: number

Returns void

crosshairsAnnotationXAxisTextColor

Section titled "crosshairsAnnotationXAxisTextColor"

Inherited from: IgrXYChart

Gets or sets the text color of crosshair annotation on x-axis.

 
get crosshairsAnnotationXAxisTextColor(): string

Returns string 

set crosshairsAnnotationXAxisTextColor(v: string): void

Parameters

  • v: string

Returns void

crosshairsAnnotationYAxisBackground

Section titled "crosshairsAnnotationYAxisBackground"

Inherited from: IgrXYChart

Gets or sets the background of crosshair annotation on y-axis.

 
get crosshairsAnnotationYAxisBackground(): string

Returns string 

set crosshairsAnnotationYAxisBackground(v: string): void

Parameters

  • v: string

Returns void

crosshairsAnnotationYAxisPrecision

Section titled "crosshairsAnnotationYAxisPrecision"

Inherited from: IgrXYChart

Gets or sets precision on interpolated values of crosshairs on y-axis.

 
get crosshairsAnnotationYAxisPrecision(): number

Returns number 

set crosshairsAnnotationYAxisPrecision(v: number): void

Parameters

  • v: number

Returns void

crosshairsAnnotationYAxisTextColor

Section titled "crosshairsAnnotationYAxisTextColor"

Inherited from: IgrXYChart

Gets or sets the text color of crosshair annotation on y-axis.

 
get crosshairsAnnotationYAxisTextColor(): string

Returns string 

set crosshairsAnnotationYAxisTextColor(v: string): void

Parameters

  • v: string

Returns void

crosshairsDisplayMode

Section titled "crosshairsDisplayMode"

Inherited from: IgrXYChart

Gets or sets the crosshairs to be displayed.

 
get crosshairsDisplayMode(): CrosshairsDisplayMode

Returns CrosshairsDisplayMode 

set crosshairsDisplayMode(v: CrosshairsDisplayMode): void

Parameters

Returns void

crosshairsLineHorizontalStroke

Section titled "crosshairsLineHorizontalStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to horizontal crosshairs line.

 
get crosshairsLineHorizontalStroke(): string

Returns string 

set crosshairsLineHorizontalStroke(v: string): void

Parameters

  • v: string

Returns void

crosshairsLineThickness

Section titled "crosshairsLineThickness"

Inherited from: IgrXYChart

Gets or sets thickness of crosshairs lines.

 
get crosshairsLineThickness(): number

Returns number 

set crosshairsLineThickness(v: number): void

Parameters

  • v: number

Returns void

crosshairsLineVerticalStroke

Section titled "crosshairsLineVerticalStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to vertical crosshairs line.

 
get crosshairsLineVerticalStroke(): string

Returns string 

set crosshairsLineVerticalStroke(v: string): void

Parameters

  • v: string

Returns void

crosshairsSkipInvalidData

Section titled "crosshairsSkipInvalidData"

Inherited from: IgrXYChart

Gets or sets whether axis annotation are skipped for invalid data in a given position.

 
get crosshairsSkipInvalidData(): boolean

Returns boolean 

set crosshairsSkipInvalidData(v: boolean): void

Parameters

  • v: boolean

Returns void

crosshairsSkipZeroValueFragments

Section titled "crosshairsSkipZeroValueFragments"

Inherited from: IgrXYChart

Gets or sets whether axis annotation are skipped for zero-value fragments in a given position.

 
get crosshairsSkipZeroValueFragments(): boolean

Returns boolean 

set crosshairsSkipZeroValueFragments(v: boolean): void

Parameters

  • v: boolean

Returns void

crosshairsSnapToData

Section titled "crosshairsSnapToData"

Inherited from: IgrXYChart

Gets or sets whether crosshairs will snap to the nearest data point.

 
get crosshairsSnapToData(): boolean

Returns boolean 

set crosshairsSnapToData(v: boolean): void

Parameters

  • v: boolean

Returns void

dataSource

Section titled "dataSource" 
get dataSource(): any[]

Returns any[] 

set dataSource(value: any[]): void

Parameters

  • value: any[]

Returns void

dataToolTipBadgeMarginBottom

Section titled "dataToolTipBadgeMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipBadgeMarginBottom(): number

Returns number 

set dataToolTipBadgeMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipBadgeMarginLeft

Section titled "dataToolTipBadgeMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipBadgeMarginLeft(): number

Returns number 

set dataToolTipBadgeMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipBadgeMarginRight

Section titled "dataToolTipBadgeMarginRight"

Inherited from: IgrXYChart 

get dataToolTipBadgeMarginRight(): number

Returns number 

set dataToolTipBadgeMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipBadgeMarginTop

Section titled "dataToolTipBadgeMarginTop"

Inherited from: IgrXYChart 

get dataToolTipBadgeMarginTop(): number

Returns number 

set dataToolTipBadgeMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipBadgeShape

Section titled "dataToolTipBadgeShape"

Inherited from: IgrXYChart

Gets or sets the BadgeShape for the data legend.

 
get dataToolTipBadgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape 

set dataToolTipBadgeShape(v: LegendItemBadgeShape): void

Parameters

  • v: LegendItemBadgeShape

Returns void

dataToolTipDefaultPositionOffsetX

Section titled "dataToolTipDefaultPositionOffsetX"

Inherited from: IgrXYChart

Gets or sets the offset of the tooltip layer on the X axis.

 
get dataToolTipDefaultPositionOffsetX(): number

Returns number 

set dataToolTipDefaultPositionOffsetX(v: number): void

Parameters

  • v: number

Returns void

dataToolTipDefaultPositionOffsetY

Section titled "dataToolTipDefaultPositionOffsetY"

Inherited from: IgrXYChart

Gets or sets the offset of the tooltip layer on the Y axis.

 
get dataToolTipDefaultPositionOffsetY(): number

Returns number 

set dataToolTipDefaultPositionOffsetY(v: number): void

Parameters

  • v: number

Returns void

dataToolTipExcludedColumns

Section titled "dataToolTipExcludedColumns"

Inherited from: IgrXYChart

Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" The DataToolTipExcludedColumns property takes precedence over values of DataToolTipIncludedColumns property

 
get dataToolTipExcludedColumns(): string[]

Returns string[] 

set dataToolTipExcludedColumns(v: string[]): void

Parameters

  • v: string[]

Returns void

dataToolTipExcludedSeries

Section titled "dataToolTipExcludedSeries"

Inherited from: IgrXYChart

Gets or sets indexes, titles, or names of series to exclude from displaying in the data tooltip, e.g. "0, 1" or "Series1 Title, Series2 Title" The DataToolTipExcludedSeries property takes precedence over values of DataToolTipIncludedSeries property

 
get dataToolTipExcludedSeries(): string[]

Returns string[] 

set dataToolTipExcludedSeries(v: string[]): void

Parameters

  • v: string[]

Returns void

dataToolTipGroupedPositionModeX

Section titled "dataToolTipGroupedPositionModeX"

Inherited from: IgrXYChart

Gets or sets the tooltip position mode on the X axis for grouped series.

 
get dataToolTipGroupedPositionModeX(): DataTooltipGroupedPositionX

Returns DataTooltipGroupedPositionX 

set dataToolTipGroupedPositionModeX(v: DataTooltipGroupedPositionX): void

Parameters

  • v: DataTooltipGroupedPositionX

Returns void

dataToolTipGroupedPositionModeY

Section titled "dataToolTipGroupedPositionModeY"

Inherited from: IgrXYChart

Gets or sets the tooltip position mode on the Y axis for grouped series.

 
get dataToolTipGroupedPositionModeY(): DataTooltipGroupedPositionY

Returns DataTooltipGroupedPositionY 

set dataToolTipGroupedPositionModeY(v: DataTooltipGroupedPositionY): void

Parameters

  • v: DataTooltipGroupedPositionY

Returns void

dataToolTipGroupingMode

Section titled "dataToolTipGroupingMode"

Inherited from: IgrXYChart 

get dataToolTipGroupingMode(): DataToolTipLayerGroupingMode

Returns DataToolTipLayerGroupingMode 

set dataToolTipGroupingMode(v: DataToolTipLayerGroupingMode): void

Parameters

  • v: DataToolTipLayerGroupingMode

Returns void

dataToolTipGroupRowMarginBottom

Section titled "dataToolTipGroupRowMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipGroupRowMarginBottom(): number

Returns number 

set dataToolTipGroupRowMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupRowMarginLeft

Section titled "dataToolTipGroupRowMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipGroupRowMarginLeft(): number

Returns number 

set dataToolTipGroupRowMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupRowMarginRight

Section titled "dataToolTipGroupRowMarginRight"

Inherited from: IgrXYChart 

get dataToolTipGroupRowMarginRight(): number

Returns number 

set dataToolTipGroupRowMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupRowMarginTop

Section titled "dataToolTipGroupRowMarginTop"

Inherited from: IgrXYChart 

get dataToolTipGroupRowMarginTop(): number

Returns number 

set dataToolTipGroupRowMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupRowVisible

Section titled "dataToolTipGroupRowVisible"

Inherited from: IgrXYChart

Gets or sets whether to show Group row.

 
get dataToolTipGroupRowVisible(): boolean

Returns boolean 

set dataToolTipGroupRowVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

dataToolTipGroupTextColor

Section titled "dataToolTipGroupTextColor"

Inherited from: IgrXYChart

Gets or sets the Group text color.

 
get dataToolTipGroupTextColor(): string

Returns string 

set dataToolTipGroupTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipGroupTextMarginBottom

Section titled "dataToolTipGroupTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipGroupTextMarginBottom(): number

Returns number 

set dataToolTipGroupTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupTextMarginLeft

Section titled "dataToolTipGroupTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipGroupTextMarginLeft(): number

Returns number 

set dataToolTipGroupTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupTextMarginRight

Section titled "dataToolTipGroupTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipGroupTextMarginRight(): number

Returns number 

set dataToolTipGroupTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupTextMarginTop

Section titled "dataToolTipGroupTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipGroupTextMarginTop(): number

Returns number 

set dataToolTipGroupTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipGroupTextStyle

Section titled "dataToolTipGroupTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the Group text.

 
get dataToolTipGroupTextStyle(): string

Returns string 

set dataToolTipGroupTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipHeaderFormatCulture

Section titled "dataToolTipHeaderFormatCulture"

Inherited from: IgrXYChart

Gets or sets globalization culture when displaying header as date time This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

 
get dataToolTipHeaderFormatCulture(): string

Returns string 

set dataToolTipHeaderFormatCulture(v: string): void

Parameters

  • v: string

Returns void

dataToolTipHeaderFormatDate

Section titled "dataToolTipHeaderFormatDate"

Inherited from: IgrXYChart

Gets or sets date format for the header This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

 
get dataToolTipHeaderFormatDate(): DataLegendHeaderDateMode

Returns DataLegendHeaderDateMode 

set dataToolTipHeaderFormatDate(v: DataLegendHeaderDateMode): void

Parameters

  • v: DataLegendHeaderDateMode

Returns void

dataToolTipHeaderFormatSpecifiers

Section titled "dataToolTipHeaderFormatSpecifiers"

Inherited from: IgrXYChart

Gets or sets the format specifiers to use with the HeaderFormatString string.

 
get dataToolTipHeaderFormatSpecifiers(): any[]

Returns any[] 

set dataToolTipHeaderFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

dataToolTipHeaderFormatString

Section titled "dataToolTipHeaderFormatString"

Inherited from: IgrXYChart

Gets or sets the format string for header text displayed in the data legend.

 
get dataToolTipHeaderFormatString(): string

Returns string 

set dataToolTipHeaderFormatString(v: string): void

Parameters

  • v: string

Returns void

dataToolTipHeaderFormatTime

Section titled "dataToolTipHeaderFormatTime"

Inherited from: IgrXYChart

Gets or sets time format for the header This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

 
get dataToolTipHeaderFormatTime(): DataLegendHeaderTimeMode

Returns DataLegendHeaderTimeMode 

set dataToolTipHeaderFormatTime(v: DataLegendHeaderTimeMode): void

Parameters

  • v: DataLegendHeaderTimeMode

Returns void

dataToolTipHeaderRowMarginBottom

Section titled "dataToolTipHeaderRowMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipHeaderRowMarginBottom(): number

Returns number 

set dataToolTipHeaderRowMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderRowMarginLeft

Section titled "dataToolTipHeaderRowMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipHeaderRowMarginLeft(): number

Returns number 

set dataToolTipHeaderRowMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderRowMarginRight

Section titled "dataToolTipHeaderRowMarginRight"

Inherited from: IgrXYChart 

get dataToolTipHeaderRowMarginRight(): number

Returns number 

set dataToolTipHeaderRowMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderRowMarginTop

Section titled "dataToolTipHeaderRowMarginTop"

Inherited from: IgrXYChart 

get dataToolTipHeaderRowMarginTop(): number

Returns number 

set dataToolTipHeaderRowMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderRowVisible

Section titled "dataToolTipHeaderRowVisible"

Inherited from: IgrXYChart

Gets or sets whether to show Header row.

 
get dataToolTipHeaderRowVisible(): boolean

Returns boolean 

set dataToolTipHeaderRowVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

dataToolTipHeaderText

Section titled "dataToolTipHeaderText"

Inherited from: IgrXYChart

Gets or sets the HeaderText for the data legend.

 
get dataToolTipHeaderText(): string

Returns string 

set dataToolTipHeaderText(v: string): void

Parameters

  • v: string

Returns void

dataToolTipHeaderTextColor

Section titled "dataToolTipHeaderTextColor"

Inherited from: IgrXYChart

Gets or sets the header text color.

 
get dataToolTipHeaderTextColor(): string

Returns string 

set dataToolTipHeaderTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipHeaderTextMarginBottom

Section titled "dataToolTipHeaderTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipHeaderTextMarginBottom(): number

Returns number 

set dataToolTipHeaderTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderTextMarginLeft

Section titled "dataToolTipHeaderTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipHeaderTextMarginLeft(): number

Returns number 

set dataToolTipHeaderTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderTextMarginRight

Section titled "dataToolTipHeaderTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipHeaderTextMarginRight(): number

Returns number 

set dataToolTipHeaderTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderTextMarginTop

Section titled "dataToolTipHeaderTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipHeaderTextMarginTop(): number

Returns number 

set dataToolTipHeaderTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipHeaderTextStyle

Section titled "dataToolTipHeaderTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the header text.

 
get dataToolTipHeaderTextStyle(): string

Returns string 

set dataToolTipHeaderTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipIncludedColumns

Section titled "dataToolTipIncludedColumns"

Inherited from: IgrXYChart

Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" The DataToolTipExcludedColumns property takes precedence over values of DataToolTipIncludedColumns property

 
get dataToolTipIncludedColumns(): string[]

Returns string[] 

set dataToolTipIncludedColumns(v: string[]): void

Parameters

  • v: string[]

Returns void

dataToolTipIncludedSeries

Section titled "dataToolTipIncludedSeries"

Inherited from: IgrXYChart

Gets or sets indexes, titles, or names of series to include in displaying in the data tooltip, e.g. "0, 1" or "Series1 Title, Series2 Title" The DataToolTipExcludedSeries property takes precedence over values of DataToolTipIncludedSeries property

 
get dataToolTipIncludedSeries(): string[]

Returns string[] 

set dataToolTipIncludedSeries(v: string[]): void

Parameters

  • v: string[]

Returns void

dataToolTipLabelDisplayMode

Section titled "dataToolTipLabelDisplayMode"

Inherited from: IgrXYChart

Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series

 
get dataToolTipLabelDisplayMode(): DataLegendLabelMode

Returns DataLegendLabelMode 

set dataToolTipLabelDisplayMode(v: DataLegendLabelMode): void

Parameters

  • v: DataLegendLabelMode

Returns void

dataToolTipLabelTextColor

Section titled "dataToolTipLabelTextColor"

Inherited from: IgrXYChart

Gets or sets the units text color.

 
get dataToolTipLabelTextColor(): string

Returns string 

set dataToolTipLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipLabelTextMarginBottom

Section titled "dataToolTipLabelTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipLabelTextMarginBottom(): number

Returns number 

set dataToolTipLabelTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipLabelTextMarginLeft

Section titled "dataToolTipLabelTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipLabelTextMarginLeft(): number

Returns number 

set dataToolTipLabelTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipLabelTextMarginRight

Section titled "dataToolTipLabelTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipLabelTextMarginRight(): number

Returns number 

set dataToolTipLabelTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipLabelTextMarginTop

Section titled "dataToolTipLabelTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipLabelTextMarginTop(): number

Returns number 

set dataToolTipLabelTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipLabelTextStyle

Section titled "dataToolTipLabelTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the units text.

 
get dataToolTipLabelTextStyle(): string

Returns string 

set dataToolTipLabelTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipPositionOffsetX

Section titled "dataToolTipPositionOffsetX"

Inherited from: IgrXYChart

Gets or sets the offset of the tooltip layer on the X axis.

 
get dataToolTipPositionOffsetX(): number

Returns number 

set dataToolTipPositionOffsetX(v: number): void

Parameters

  • v: number

Returns void

dataToolTipPositionOffsetY

Section titled "dataToolTipPositionOffsetY"

Inherited from: IgrXYChart

Gets or sets the offset of the tooltip layer on the Y axis.

 
get dataToolTipPositionOffsetY(): number

Returns number 

set dataToolTipPositionOffsetY(v: number): void

Parameters

  • v: number

Returns void

dataToolTipShouldUpdateWhenSeriesDataChanges

Section titled "dataToolTipShouldUpdateWhenSeriesDataChanges"

Inherited from: IgrXYChart

Gets or sets whether the data legend should update when the series data is mutated.

 
get dataToolTipShouldUpdateWhenSeriesDataChanges(): boolean

Returns boolean 

set dataToolTipShouldUpdateWhenSeriesDataChanges(v: boolean): void

Parameters

  • v: boolean

Returns void

dataToolTipSummaryLabelText

Section titled "dataToolTipSummaryLabelText"

Inherited from: IgrXYChart

Gets or sets the units text for the data legend.

 
get dataToolTipSummaryLabelText(): string

Returns string 

set dataToolTipSummaryLabelText(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryLabelTextColor

Section titled "dataToolTipSummaryLabelTextColor"

Inherited from: IgrXYChart

Gets or sets the units text color.

 
get dataToolTipSummaryLabelTextColor(): string

Returns string 

set dataToolTipSummaryLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryLabelTextStyle

Section titled "dataToolTipSummaryLabelTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the units text.

 
get dataToolTipSummaryLabelTextStyle(): string

Returns string 

set dataToolTipSummaryLabelTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryRowMarginBottom

Section titled "dataToolTipSummaryRowMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipSummaryRowMarginBottom(): number

Returns number 

set dataToolTipSummaryRowMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryRowMarginLeft

Section titled "dataToolTipSummaryRowMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipSummaryRowMarginLeft(): number

Returns number 

set dataToolTipSummaryRowMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryRowMarginRight

Section titled "dataToolTipSummaryRowMarginRight"

Inherited from: IgrXYChart 

get dataToolTipSummaryRowMarginRight(): number

Returns number 

set dataToolTipSummaryRowMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryRowMarginTop

Section titled "dataToolTipSummaryRowMarginTop"

Inherited from: IgrXYChart 

get dataToolTipSummaryRowMarginTop(): number

Returns number 

set dataToolTipSummaryRowMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryTitleText

Section titled "dataToolTipSummaryTitleText"

Inherited from: IgrXYChart

Gets or sets the SummaryTitleText for the data legend.

 
get dataToolTipSummaryTitleText(): string

Returns string 

set dataToolTipSummaryTitleText(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryTitleTextColor

Section titled "dataToolTipSummaryTitleTextColor"

Inherited from: IgrXYChart

Gets or sets the summary text color.

 
get dataToolTipSummaryTitleTextColor(): string

Returns string 

set dataToolTipSummaryTitleTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryTitleTextMarginBottom

Section titled "dataToolTipSummaryTitleTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipSummaryTitleTextMarginBottom(): number

Returns number 

set dataToolTipSummaryTitleTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryTitleTextMarginLeft

Section titled "dataToolTipSummaryTitleTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipSummaryTitleTextMarginLeft(): number

Returns number 

set dataToolTipSummaryTitleTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryTitleTextMarginRight

Section titled "dataToolTipSummaryTitleTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipSummaryTitleTextMarginRight(): number

Returns number 

set dataToolTipSummaryTitleTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryTitleTextMarginTop

Section titled "dataToolTipSummaryTitleTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipSummaryTitleTextMarginTop(): number

Returns number 

set dataToolTipSummaryTitleTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipSummaryTitleTextStyle

Section titled "dataToolTipSummaryTitleTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the summary text.

 
get dataToolTipSummaryTitleTextStyle(): string

Returns string 

set dataToolTipSummaryTitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryType

Section titled "dataToolTipSummaryType"

Inherited from: IgrXYChart

Gets or sets the SummaryType for the data legend.

 
get dataToolTipSummaryType(): DataLegendSummaryType

Returns DataLegendSummaryType 

set dataToolTipSummaryType(v: DataLegendSummaryType): void

Parameters

  • v: DataLegendSummaryType

Returns void

dataToolTipSummaryUnitsText

Section titled "dataToolTipSummaryUnitsText"

Inherited from: IgrXYChart

Gets or sets the units text for the data legend.

 
get dataToolTipSummaryUnitsText(): string

Returns string 

set dataToolTipSummaryUnitsText(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryUnitsTextColor

Section titled "dataToolTipSummaryUnitsTextColor"

Inherited from: IgrXYChart

Gets or sets the units text color.

 
get dataToolTipSummaryUnitsTextColor(): string

Returns string 

set dataToolTipSummaryUnitsTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryUnitsTextStyle

Section titled "dataToolTipSummaryUnitsTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the units text.

 
get dataToolTipSummaryUnitsTextStyle(): string

Returns string 

set dataToolTipSummaryUnitsTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryValueTextColor

Section titled "dataToolTipSummaryValueTextColor"

Inherited from: IgrXYChart

Gets or sets the units text color.

 
get dataToolTipSummaryValueTextColor(): string

Returns string 

set dataToolTipSummaryValueTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipSummaryValueTextStyle

Section titled "dataToolTipSummaryValueTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the units text.

 
get dataToolTipSummaryValueTextStyle(): string

Returns string 

set dataToolTipSummaryValueTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipTitleTextColor

Section titled "dataToolTipTitleTextColor"

Inherited from: IgrXYChart

Gets or sets the display text color.

 
get dataToolTipTitleTextColor(): string

Returns string 

set dataToolTipTitleTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipTitleTextMarginBottom

Section titled "dataToolTipTitleTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipTitleTextMarginBottom(): number

Returns number 

set dataToolTipTitleTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipTitleTextMarginLeft

Section titled "dataToolTipTitleTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipTitleTextMarginLeft(): number

Returns number 

set dataToolTipTitleTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipTitleTextMarginRight

Section titled "dataToolTipTitleTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipTitleTextMarginRight(): number

Returns number 

set dataToolTipTitleTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipTitleTextMarginTop

Section titled "dataToolTipTitleTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipTitleTextMarginTop(): number

Returns number 

set dataToolTipTitleTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipTitleTextStyle

Section titled "dataToolTipTitleTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the display text.

 
get dataToolTipTitleTextStyle(): string

Returns string 

set dataToolTipTitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipUnitsDisplayMode

Section titled "dataToolTipUnitsDisplayMode"

Inherited from: IgrXYChart

Gets or sets the UnitsMode for the data legend.

 
get dataToolTipUnitsDisplayMode(): DataLegendUnitsMode

Returns DataLegendUnitsMode 

set dataToolTipUnitsDisplayMode(v: DataLegendUnitsMode): void

Parameters

  • v: DataLegendUnitsMode

Returns void

dataToolTipUnitsText

Section titled "dataToolTipUnitsText"

Inherited from: IgrXYChart

Gets or sets the units text for the data legend.

 
get dataToolTipUnitsText(): string

Returns string 

set dataToolTipUnitsText(v: string): void

Parameters

  • v: string

Returns void

dataToolTipUnitsTextColor

Section titled "dataToolTipUnitsTextColor"

Inherited from: IgrXYChart

Gets or sets the units text color.

 
get dataToolTipUnitsTextColor(): string

Returns string 

set dataToolTipUnitsTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipUnitsTextMarginBottom

Section titled "dataToolTipUnitsTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipUnitsTextMarginBottom(): number

Returns number 

set dataToolTipUnitsTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipUnitsTextMarginLeft

Section titled "dataToolTipUnitsTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipUnitsTextMarginLeft(): number

Returns number 

set dataToolTipUnitsTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipUnitsTextMarginRight

Section titled "dataToolTipUnitsTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipUnitsTextMarginRight(): number

Returns number 

set dataToolTipUnitsTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipUnitsTextMarginTop

Section titled "dataToolTipUnitsTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipUnitsTextMarginTop(): number

Returns number 

set dataToolTipUnitsTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipUnitsTextStyle

Section titled "dataToolTipUnitsTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the units text.

 
get dataToolTipUnitsTextStyle(): string

Returns string 

set dataToolTipUnitsTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipValueFormatAbbreviation

Section titled "dataToolTipValueFormatAbbreviation"

Inherited from: IgrXYChart

Gets or sets mode for abbreviating large numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

 
get dataToolTipValueFormatAbbreviation(): DataAbbreviationMode

Returns DataAbbreviationMode 

set dataToolTipValueFormatAbbreviation(v: DataAbbreviationMode): void

Parameters

  • v: DataAbbreviationMode

Returns void

dataToolTipValueFormatCulture

Section titled "dataToolTipValueFormatCulture"

Inherited from: IgrXYChart

Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

 
get dataToolTipValueFormatCulture(): string

Returns string 

set dataToolTipValueFormatCulture(v: string): void

Parameters

  • v: string

Returns void

dataToolTipValueFormatMaxFractions

Section titled "dataToolTipValueFormatMaxFractions"

Inherited from: IgrXYChart

Gets or sets maximum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

 
get dataToolTipValueFormatMaxFractions(): number

Returns number 

set dataToolTipValueFormatMaxFractions(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueFormatMinFractions

Section titled "dataToolTipValueFormatMinFractions"

Inherited from: IgrXYChart

Gets or sets minimum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

 
get dataToolTipValueFormatMinFractions(): number

Returns number 

set dataToolTipValueFormatMinFractions(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueFormatMode

Section titled "dataToolTipValueFormatMode"

Inherited from: IgrXYChart

Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)

 
get dataToolTipValueFormatMode(): DataLegendValueMode

Returns DataLegendValueMode 

set dataToolTipValueFormatMode(v: DataLegendValueMode): void

Parameters

  • v: DataLegendValueMode

Returns void

dataToolTipValueFormatSpecifiers

Section titled "dataToolTipValueFormatSpecifiers"

Inherited from: IgrXYChart

Gets or sets the format specifiers to use with the ValueFormatString string.

 
get dataToolTipValueFormatSpecifiers(): any[]

Returns any[] 

set dataToolTipValueFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

dataToolTipValueFormatString

Section titled "dataToolTipValueFormatString"

Inherited from: IgrXYChart

Gets or sets the format string for values displayed in the data legend.

 
get dataToolTipValueFormatString(): string

Returns string 

set dataToolTipValueFormatString(v: string): void

Parameters

  • v: string

Returns void

dataToolTipValueFormatUseGrouping

Section titled "dataToolTipValueFormatUseGrouping"

Inherited from: IgrXYChart

Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

 
get dataToolTipValueFormatUseGrouping(): boolean

Returns boolean 

set dataToolTipValueFormatUseGrouping(v: boolean): void

Parameters

  • v: boolean

Returns void

dataToolTipValueRowMarginBottom

Section titled "dataToolTipValueRowMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipValueRowMarginBottom(): number

Returns number 

set dataToolTipValueRowMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueRowMarginLeft

Section titled "dataToolTipValueRowMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipValueRowMarginLeft(): number

Returns number 

set dataToolTipValueRowMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueRowMarginRight

Section titled "dataToolTipValueRowMarginRight"

Inherited from: IgrXYChart 

get dataToolTipValueRowMarginRight(): number

Returns number 

set dataToolTipValueRowMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueRowMarginTop

Section titled "dataToolTipValueRowMarginTop"

Inherited from: IgrXYChart 

get dataToolTipValueRowMarginTop(): number

Returns number 

set dataToolTipValueRowMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueRowVisible

Section titled "dataToolTipValueRowVisible"

Inherited from: IgrXYChart

Gets or sets whether to show series rows.

 
get dataToolTipValueRowVisible(): boolean

Returns boolean 

set dataToolTipValueRowVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

dataToolTipValueTextColor

Section titled "dataToolTipValueTextColor"

Inherited from: IgrXYChart

Gets or sets the units text color.

 
get dataToolTipValueTextColor(): string

Returns string 

set dataToolTipValueTextColor(v: string): void

Parameters

  • v: string

Returns void

dataToolTipValueTextMarginBottom

Section titled "dataToolTipValueTextMarginBottom"

Inherited from: IgrXYChart 

get dataToolTipValueTextMarginBottom(): number

Returns number 

set dataToolTipValueTextMarginBottom(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueTextMarginLeft

Section titled "dataToolTipValueTextMarginLeft"

Inherited from: IgrXYChart 

get dataToolTipValueTextMarginLeft(): number

Returns number 

set dataToolTipValueTextMarginLeft(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueTextMarginRight

Section titled "dataToolTipValueTextMarginRight"

Inherited from: IgrXYChart 

get dataToolTipValueTextMarginRight(): number

Returns number 

set dataToolTipValueTextMarginRight(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueTextMarginTop

Section titled "dataToolTipValueTextMarginTop"

Inherited from: IgrXYChart 

get dataToolTipValueTextMarginTop(): number

Returns number 

set dataToolTipValueTextMarginTop(v: number): void

Parameters

  • v: number

Returns void

dataToolTipValueTextStyle

Section titled "dataToolTipValueTextStyle"

Inherited from: IgrXYChart

Gets or Sets the style to use for the units text.

 
get dataToolTipValueTextStyle(): string

Returns string 

set dataToolTipValueTextStyle(v: string): void

Parameters

  • v: string

Returns void

dataToolTipValueTextUseSeriesColors

Section titled "dataToolTipValueTextUseSeriesColors"

Inherited from: IgrXYChart

Gets or sets whether to use series colors when displaying values in the legend

 
get dataToolTipValueTextUseSeriesColors(): boolean

Returns boolean 

set dataToolTipValueTextUseSeriesColors(v: boolean): void

Parameters

  • v: boolean

Returns void

dataToolTipValueTextWhenMissingData

Section titled "dataToolTipValueTextWhenMissingData"

Inherited from: IgrXYChart

Gets or sets text displayed when data column is missing a value, e.g. "no data"

 
get dataToolTipValueTextWhenMissingData(): string

Returns string 

set dataToolTipValueTextWhenMissingData(v: string): void

Parameters

  • v: string

Returns void

domainType

Section titled "domainType"

Gets domain type of this chart

 
get domainType(): DomainType

Returns DomainType

excludedProperties

Section titled "excludedProperties"

Inherited from: IgrXYChart

Gets or sets a set of property paths that should be excluded from consideration by the category chart.

The ExcludedProperties property used for the property paths that should be excluded from consideration by the category chart.

``

``

 
get excludedProperties(): string[]

Returns string[] 

set excludedProperties(v: string[]): void

Parameters

  • v: string[]

Returns void

filterExpressions

Section titled "filterExpressions"

Inherited from: IgrXYChart

Gets the current filter that is applied to the chart. Collection can be updated to modify the filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties.

 
get filterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

filterStringErrorsParsing

Section titled "filterStringErrorsParsing"

Inherited from: IgrXYChart 

get filterStringErrorsParsing(): object

Returns object 

set filterStringErrorsParsing(ev: object): void

Parameters

  • ev: object

Returns void

finalValueAnnotationsBackground

Section titled "finalValueAnnotationsBackground"

Inherited from: IgrXYChart

Gets or sets the background of final value annotation.

 
get finalValueAnnotationsBackground(): string

Returns string 

set finalValueAnnotationsBackground(v: string): void

Parameters

  • v: string

Returns void

finalValueAnnotationsPrecision

Section titled "finalValueAnnotationsPrecision"

Inherited from: IgrXYChart

Gets or sets precision on final value annotation.

 
get finalValueAnnotationsPrecision(): number

Returns number 

set finalValueAnnotationsPrecision(v: number): void

Parameters

  • v: number

Returns void

finalValueAnnotationsTextColor

Section titled "finalValueAnnotationsTextColor"

Inherited from: IgrXYChart

Gets or sets the text color of final value annotation.

 
get finalValueAnnotationsTextColor(): string

Returns string 

set finalValueAnnotationsTextColor(v: string): void

Parameters

  • v: string

Returns void

finalValueAnnotationsVisible

Section titled "finalValueAnnotationsVisible"

Inherited from: IgrXYChart

Gets or sets whether annotations for the final value of each series is displayed on the axis.

 
get finalValueAnnotationsVisible(): boolean

Returns boolean 

set finalValueAnnotationsVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

focusBrush

Section titled "focusBrush"

Inherited from: IgrXYChart

Gets or sets the focus brush to use for the series.

 
get focusBrush(): string

Returns string 

set focusBrush(v: string): void

Parameters

  • v: string

Returns void

focusDismissDelayMilliseconds

Section titled "focusDismissDelayMilliseconds"

Inherited from: IgrXYChart

Gets or sets the time to wait before visually dismissing a focus highlight.

 
get focusDismissDelayMilliseconds(): number

Returns number 

set focusDismissDelayMilliseconds(v: number): void

Parameters

  • v: number

Returns void

focusedSeriesItems

Section titled "focusedSeriesItems"

Inherited from: IgrXYChart

Gets the currently focused data items. Adding or removing data items from this collection will focus or blur the visuals associated with those items.

 
get focusedSeriesItems(): IgrChartSelectedItemCollection

Returns IgrChartSelectedItemCollection 

set focusedSeriesItems(v: IgrChartSelectedItemCollection): void

Parameters

Returns void

focusedSeriesItemsChanged

Section titled "focusedSeriesItemsChanged"

Inherited from: IgrXYChart 

get focusedSeriesItemsChanged(): object

Returns object 

set focusedSeriesItemsChanged(ev: object): void

Parameters

  • ev: object

Returns void

focusMode

Section titled "focusMode"

Inherited from: IgrXYChart

Gets or sets the focus mode to use for the series in the component, when supported.

 
get focusMode(): SeriesSelectionMode

Returns SeriesSelectionMode 

set focusMode(v: SeriesSelectionMode): void

Parameters

Returns void

focusTransitionDuration

Section titled "focusTransitionDuration"

Inherited from: IgrXYChart

Gets or sets the duration used for animating Focus changes

 
get focusTransitionDuration(): number

Returns number 

set focusTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

groupDescriptions

Section titled "groupDescriptions"

Inherited from: IgrXYChart

Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.

 
get groupDescriptions(): IgrChartSortDescriptionCollection

Returns IgrChartSortDescriptionCollection

groupSortDescriptions

Section titled "groupSortDescriptions"

Inherited from: IgrXYChart

groupSorts

Section titled "groupSorts"

Inherited from: IgrXYChart

Gets or sets the sorts to apply after grouping has been applied.

 
get groupSorts(): string

Returns string 

set groupSorts(v: string): void

Parameters

  • v: string

Returns void

height

Section titled "height" 
get height(): string

Returns string 

set height(value: string): void

Parameters

  • value: string

Returns void

highlightedDataSource

Section titled "highlightedDataSource"

Inherited from: IgrXYChart

Gets or sets a collection of data items used to generate the chart. The HighlightedItemsSource of this chart can be a list of objects containing one or more numeric properties. Additionally, if the objects in the list implement the IEnumerable interface, the Chart will attempt to delve into the sub-collections when reading through the data source. Data binding can be further configured by attributing the data item classes with the DataSeriesMemberIntentAttribute.

 
get highlightedDataSource(): any

Returns any 

set highlightedDataSource(v: any): void

Parameters

  • v: any

Returns void

highlightedLegendItemVisibility

Section titled "highlightedLegendItemVisibility"

Inherited from: IgrXYChart

Gets or sets whether the chart can highlight series through user interactions. This property applies to Category Chart and Financial Chart controls.

 
get highlightedLegendItemVisibility(): Visibility

Returns Visibility 

set highlightedLegendItemVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

highlightedValuesDisplayMode

Section titled "highlightedValuesDisplayMode"

Inherited from: IgrXYChart

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. This property applies to Category Chart and Financial Chart controls.

 
get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode

Returns SeriesHighlightedValuesDisplayMode 

set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode): void

Parameters

  • v: SeriesHighlightedValuesDisplayMode

Returns void

highlightFilterExpressions

Section titled "highlightFilterExpressions"

Inherited from: IgrXYChart

Gets the current highlight filter that is applied to the chart. Collection can be updated to modify the highlight filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties.

 
get highlightFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

highlightingBehavior

Section titled "highlightingBehavior"

Inherited from: IgrXYChart

Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled.

 
get highlightingBehavior(): SeriesHighlightingBehavior

Returns SeriesHighlightingBehavior 

set highlightingBehavior(v: SeriesHighlightingBehavior): void

Parameters

Returns void

highlightingDismissDelayMilliseconds

Section titled "highlightingDismissDelayMilliseconds"

Inherited from: IgrXYChart

Gets or sets the time to wait before visually dismissing a highlight.

 
get highlightingDismissDelayMilliseconds(): number

Returns number 

set highlightingDismissDelayMilliseconds(v: number): void

Parameters

  • v: number

Returns void

highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

Inherited from: IgrXYChart

Gets or sets the target opacity to fade to for fade style highlighting.

 
get highlightingFadeOpacity(): number

Returns number 

set highlightingFadeOpacity(v: number): void

Parameters

  • v: number

Returns void

highlightingMode

Section titled "highlightingMode"

Inherited from: IgrXYChart

Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled.

 
get highlightingMode(): SeriesHighlightingMode

Returns SeriesHighlightingMode 

set highlightingMode(v: SeriesHighlightingMode): void

Parameters

Returns void

highlightingTransitionDuration

Section titled "highlightingTransitionDuration"

Inherited from: IgrXYChart

Gets or sets the duration used for animating highlighting changes

 
get highlightingTransitionDuration(): number

Returns number 

set highlightingTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarCornerRadius

Section titled "horizontalViewScrollbarCornerRadius"

Inherited from: IgrXYChart

Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarCornerRadius(): number

Returns number 

set horizontalViewScrollbarCornerRadius(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarFill

Section titled "horizontalViewScrollbarFill"

Inherited from: IgrXYChart

Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarFill(): string

Returns string 

set horizontalViewScrollbarFill(v: string): void

Parameters

  • v: string

Returns void

horizontalViewScrollbarHeight

Section titled "horizontalViewScrollbarHeight"

Inherited from: IgrXYChart

Gets or sets the height to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarHeight(): number

Returns number 

set horizontalViewScrollbarHeight(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarInset

Section titled "horizontalViewScrollbarInset"

Inherited from: IgrXYChart

Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarInset(): number

Returns number 

set horizontalViewScrollbarInset(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarMaxOpacity

Section titled "horizontalViewScrollbarMaxOpacity"

Inherited from: IgrXYChart

Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarMaxOpacity(): number

Returns number 

set horizontalViewScrollbarMaxOpacity(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarMode

Section titled "horizontalViewScrollbarMode"

Inherited from: IgrXYChart

Gets or sets the horizontal scrollbar mode to use for the series viewer.

 
get horizontalViewScrollbarMode(): SeriesViewerScrollbarMode

Returns SeriesViewerScrollbarMode 

set horizontalViewScrollbarMode(v: SeriesViewerScrollbarMode): void

Parameters

Returns void

horizontalViewScrollbarOutline

Section titled "horizontalViewScrollbarOutline"

Inherited from: IgrXYChart

Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarOutline(): string

Returns string 

set horizontalViewScrollbarOutline(v: string): void

Parameters

  • v: string

Returns void

horizontalViewScrollbarPosition

Section titled "horizontalViewScrollbarPosition"

Inherited from: IgrXYChart

Gets or sets the position to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarPosition(): SeriesViewerHorizontalScrollbarPosition

Returns SeriesViewerHorizontalScrollbarPosition 

set horizontalViewScrollbarPosition(v: SeriesViewerHorizontalScrollbarPosition): void

Parameters

Returns void

horizontalViewScrollbarShouldAddAutoTrackInsets

Section titled "horizontalViewScrollbarShouldAddAutoTrackInsets"

Inherited from: IgrXYChart

Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarShouldAddAutoTrackInsets(): boolean

Returns boolean 

set horizontalViewScrollbarShouldAddAutoTrackInsets(v: boolean): void

Parameters

  • v: boolean

Returns void

horizontalViewScrollbarStrokeThickness

Section titled "horizontalViewScrollbarStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarStrokeThickness(): number

Returns number 

set horizontalViewScrollbarStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarTrackEndInset

Section titled "horizontalViewScrollbarTrackEndInset"

Inherited from: IgrXYChart

Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarTrackEndInset(): number

Returns number 

set horizontalViewScrollbarTrackEndInset(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarTrackStartInset

Section titled "horizontalViewScrollbarTrackStartInset"

Inherited from: IgrXYChart

Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled.

 
get horizontalViewScrollbarTrackStartInset(): number

Returns number 

set horizontalViewScrollbarTrackStartInset(v: number): void

Parameters

  • v: number

Returns void

includedProperties

Section titled "includedProperties"

Inherited from: IgrXYChart

Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remainder excluded. If null, all properties will be considered.

The IncludedProperties property used to include the properties for the consideration of the category chart.

``

``

 
get includedProperties(): string[]

Returns string[] 

set includedProperties(v: string[]): void

Parameters

  • v: string[]

Returns void

initialFilter

Section titled "initialFilter"

Inherited from: IgrXYChart

Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.

 
get initialFilter(): string

Returns string 

set initialFilter(v: string): void

Parameters

  • v: string

Returns void

initialFilterExpressions

Section titled "initialFilterExpressions"

Inherited from: IgrXYChart

Gets the initial filters that are applied to the chart.

 
get initialFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

initialGroupDescriptions

Section titled "initialGroupDescriptions"

Inherited from: IgrXYChart

Gets the initial groupings that are applied to the chart.

 
get initialGroupDescriptions(): IgrChartSortDescriptionCollection

Returns IgrChartSortDescriptionCollection

initialGroups

Section titled "initialGroups"

Inherited from: IgrXYChart

Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property.

 
get initialGroups(): string

Returns string 

set initialGroups(v: string): void

Parameters

  • v: string

Returns void

initialGroupSortDescriptions

Section titled "initialGroupSortDescriptions"

Inherited from: IgrXYChart

Gets the initial sorts that are applied to the chart after groupings and summaries are applied.

 
get initialGroupSortDescriptions(): IgrChartSortDescriptionCollection

Returns IgrChartSortDescriptionCollection

initialHighlightFilter

Section titled "initialHighlightFilter"

Inherited from: IgrXYChart

Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.

 
get initialHighlightFilter(): string

Returns string 

set initialHighlightFilter(v: string): void

Parameters

  • v: string

Returns void

initialHighlightFilterExpressions

Section titled "initialHighlightFilterExpressions"

Inherited from: IgrXYChart

Gets the initial highlight filters that are applied to the chart.

 
get initialHighlightFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

initialSortDescriptions

Section titled "initialSortDescriptions"

Inherited from: IgrXYChart

Gets the initial sorts that are applied to the chart.

 
get initialSortDescriptions(): IgrChartSortDescriptionCollection

Returns IgrChartSortDescriptionCollection

initialSorts

Section titled "initialSorts"

Inherited from: IgrXYChart

Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property.

 
get initialSorts(): string

Returns string 

set initialSorts(v: string): void

Parameters

  • v: string

Returns void

initialSummaries

Section titled "initialSummaries"

Inherited from: IgrXYChart

Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property.

 
get initialSummaries(): string

Returns string 

set initialSummaries(v: string): void

Parameters

  • v: string

Returns void

initialSummaryDescriptions

Section titled "initialSummaryDescriptions"

Inherited from: IgrXYChart

Gets the initial summaries that are applied to the chart.

 
get initialSummaryDescriptions(): IgrChartSummaryDescriptionCollection

Returns IgrChartSummaryDescriptionCollection

isCategoryHighlightingEnabled

Section titled "isCategoryHighlightingEnabled"

Gets or sets whether the category should be highlighted when hovered

 
get isCategoryHighlightingEnabled(): boolean

Returns boolean 

set isCategoryHighlightingEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isDetached

Section titled "isDetached"

Inherited from: IgrXYChart 

get isDetached(): boolean

Returns boolean

isHorizontalZoomEnabled

Section titled "isHorizontalZoomEnabled"

Inherited from: IgrXYChart

Gets or sets whether the chart can be horizontally zoomed through user interactions.

Use the IsHorizontalZoomEnabled property to allow chart horizontally zoomed .

``

``

``

 
get isHorizontalZoomEnabled(): boolean

Returns boolean 

set isHorizontalZoomEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isItemHighlightingEnabled

Section titled "isItemHighlightingEnabled"

Gets or sets whether the item should be highlighted when hovered

 
get isItemHighlightingEnabled(): boolean

Returns boolean 

set isItemHighlightingEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isSeriesHighlightingEnabled

Section titled "isSeriesHighlightingEnabled"

Inherited from: IgrXYChart

Gets or sets whether the chart can highlight series through user interactions. This property applies to Category Chart and Financial Chart controls.

 
get isSeriesHighlightingEnabled(): boolean

Returns boolean 

set isSeriesHighlightingEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isSplineShapePartOfRange

Section titled "isSplineShapePartOfRange"

Gets or sets whether to include the spline shape in the axis range requested of the axis for spline type series.

 
get isSplineShapePartOfRange(): boolean

Returns boolean 

set isSplineShapePartOfRange(v: boolean): void

Parameters

  • v: boolean

Returns void

isTransitionInEnabled

Section titled "isTransitionInEnabled"

Gets or sets whether animation of series plots is enabled when the chart is loading into view

Set IsTransitionInEnabled to true if you want your chart series to animate into position when the chart is loading into view.

``

 
get isTransitionInEnabled(): boolean

Returns boolean 

set isTransitionInEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isUserAnnotationsEnabled

Section titled "isUserAnnotationsEnabled"

Inherited from: IgrXYChart

Gets or sets whether initiating user annotations from the toolbar is enabled.

 
get isUserAnnotationsEnabled(): boolean

Returns boolean 

set isUserAnnotationsEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isVerticalZoomEnabled

Section titled "isVerticalZoomEnabled"

Inherited from: IgrXYChart

Gets or sets whether the chart can be vertically zoomed through user interactions.

Use the IsVerticalZoomEnabled property to allow chart zoom vertically.

``

``

 
get isVerticalZoomEnabled(): boolean

Returns boolean 

set isVerticalZoomEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

leftMargin

Section titled "leftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of the chart content.

Use the 'leftMargin' property for the left margin of the chart content.

``

``

 
get leftMargin(): number

Returns number 

set leftMargin(v: number): void

Parameters

  • v: number

Returns void

legend

Section titled "legend"

Inherited from: IgrXYChart 

get legend(): any

Returns any 

set legend(v: any): void

Parameters

  • v: any

Returns void

legendHighlightingMode

Section titled "legendHighlightingMode"

Inherited from: IgrXYChart

Gets or sets the highlighting mode to use for the legend linked to the component, when supported.

 
get legendHighlightingMode(): LegendHighlightingMode

Returns LegendHighlightingMode 

set legendHighlightingMode(v: LegendHighlightingMode): void

Parameters

Returns void

legendItemBadgeMode

Section titled "legendItemBadgeMode"

Inherited from: IgrXYChart

Gets or sets the mode of legend badges representing all series displayed in a legend linked to this component. This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on a series

 
get legendItemBadgeMode(): LegendItemBadgeMode

Returns LegendItemBadgeMode 

set legendItemBadgeMode(v: LegendItemBadgeMode): void

Parameters

  • v: LegendItemBadgeMode

Returns void

legendItemBadgeShape

Section titled "legendItemBadgeShape"

Inherited from: IgrXYChart

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

 
get legendItemBadgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape 

set legendItemBadgeShape(v: LegendItemBadgeShape): void

Parameters

  • v: LegendItemBadgeShape

Returns void

legendItemVisibility

Section titled "legendItemVisibility"

Inherited from: IgrXYChart

Gets or sets whether to show the legend items for the series.

 
get legendItemVisibility(): Visibility

Returns Visibility 

set legendItemVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

markerAutomaticBehavior

Section titled "markerAutomaticBehavior"

Inherited from: IgrXYChart

Gets or sets the default marker type for all series plotted in this chart. This property is ignored when the MarkerTypes property is set

 
get markerAutomaticBehavior(): MarkerAutomaticBehavior

Returns MarkerAutomaticBehavior 

set markerAutomaticBehavior(v: MarkerAutomaticBehavior): void

Parameters

Returns void

markerBrushes

Section titled "markerBrushes"

Inherited from: IgrXYChart

Gets or sets the palette of brushes used for rendering fill area of data point markers. This property applies only to these chart types: point, line, spline, bubble, and polygon

MarkerBrushes property used for rendering fill area of data point markers.

``

``

 
get markerBrushes(): string[]

Returns string[] 

set markerBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

markerCollisionAvoidance

Section titled "markerCollisionAvoidance"

Gets or sets the behavior for markers in each series which are placed too close together for the current view, resulting in a collision.

MarkerCollisionAvoidance controls the technique the chart uses to avoid overlapping markers.

``

 
get markerCollisionAvoidance(): CategorySeriesMarkerCollisionAvoidance

Returns CategorySeriesMarkerCollisionAvoidance 

set markerCollisionAvoidance(v: CategorySeriesMarkerCollisionAvoidance): void

Parameters

Returns void

markerFillMode

Section titled "markerFillMode"

Inherited from: IgrXYChart

Gets or sets the MarkerFillMode for all series that support markers in this chart.

 
get markerFillMode(): MarkerFillMode

Returns MarkerFillMode 

set markerFillMode(v: MarkerFillMode): void

Parameters

Returns void

markerFillOpacity

Section titled "markerFillOpacity"

Inherited from: IgrXYChart

Gets or sets the Marker Fill Opacity for all series that support markers in this chart.

 
get markerFillOpacity(): number

Returns number 

set markerFillOpacity(v: number): void

Parameters

  • v: number

Returns void

markerMaxCount

Section titled "markerMaxCount"

Inherited from: IgrXYChart

Gets or sets the maximum number of markers displayed in the plot area of the chart.

markerMaxCount property used to display maximum number of markers in the plot area of the chart.

``

``

 
get markerMaxCount(): number

Returns number 

set markerMaxCount(v: number): void

Parameters

  • v: number

Returns void

markerOutlineMode

Section titled "markerOutlineMode"

Inherited from: IgrXYChart

Gets or sets the MarkerOutlineMode for all series that support markers in this chart.

 
get markerOutlineMode(): MarkerOutlineMode

Returns MarkerOutlineMode 

set markerOutlineMode(v: MarkerOutlineMode): void

Parameters

Returns void

markerOutlines

Section titled "markerOutlines"

Inherited from: IgrXYChart

Gets or sets the palette of brushes used for rendering outlines of data point markers. This property applies only to these chart types: point, line, spline, bubble, and polygon

MarkerOutlines property used for rendering outlines of data point markers.

``

``

 
get markerOutlines(): string[]

Returns string[] 

set markerOutlines(v: string[]): void

Parameters

  • v: string[]

Returns void

markerThickness

Section titled "markerThickness"

Inherited from: IgrXYChart

Gets or sets the Marker Thickness for all series that support markers in this chart.

 
get markerThickness(): number

Returns number 

set markerThickness(v: number): void

Parameters

  • v: number

Returns void

markerTypes

Section titled "markerTypes"

Inherited from: IgrXYChart

Gets or sets the marker shapes used for indicating location of data points in this chart. This property applies only to these chart types: point, line, spline, bubble, and polygon

 
get markerTypes(): IgrMarkerTypeCollection

Returns IgrMarkerTypeCollection 

set markerTypes(v: IgrMarkerTypeCollection): void

Parameters

Returns void

negativeBrushes

Section titled "negativeBrushes"

Gets or sets the palette used for coloring negative items of Waterfall chart type.

NegativeBrushes controls the brushes used by the chart for negative data, when the ChartType is one that supports negative brushes.

``

 
get negativeBrushes(): string[]

Returns string[] 

set negativeBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

negativeOutlines

Section titled "negativeOutlines"

Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall.

NegativeOutlines controls the outlines used by the chart for negative data, when the ChartType is one that supports negative brushes.

``

 
get negativeOutlines(): string[]

Returns string[] 

set negativeOutlines(v: string[]): void

Parameters

  • v: string[]

Returns void

outlineMode

Section titled "outlineMode"

Inherited from: IgrXYChart

Gets or sets the OutlineMode for all series in this chart.

 
get outlineMode(): SeriesOutlineMode

Returns SeriesOutlineMode 

set outlineMode(v: SeriesOutlineMode): void

Parameters

Returns void

outlines

Section titled "outlines"

Inherited from: IgrXYChart

Gets or sets the palette of brushes to use for outlines on the chart series. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

Use the Outlines property to sets the palette of brushes to use for outlines on the chart series

``

 
get outlines(): string[]

Returns string[] 

set outlines(v: string[]): void

Parameters

  • v: string[]

Returns void

pixelScalingRatio

Section titled "pixelScalingRatio"

Inherited from: IgrXYChart

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.

 
get pixelScalingRatio(): number

Returns number 

set pixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

plotAreaMarginBottom

Section titled "plotAreaMarginBottom"

Inherited from: IgrXYChart

Margin applied below the plot area.

 
get plotAreaMarginBottom(): number

Returns number 

set plotAreaMarginBottom(v: number): void

Parameters

  • v: number

Returns void

plotAreaMarginLeft

Section titled "plotAreaMarginLeft"

Inherited from: IgrXYChart

Margin applied to the Left of the plot area.

 
get plotAreaMarginLeft(): number

Returns number 

set plotAreaMarginLeft(v: number): void

Parameters

  • v: number

Returns void

plotAreaMarginRight

Section titled "plotAreaMarginRight"

Inherited from: IgrXYChart

Margin applied to the right of the plot area.

 
get plotAreaMarginRight(): number

Returns number 

set plotAreaMarginRight(v: number): void

Parameters

  • v: number

Returns void

plotAreaMarginTop

Section titled "plotAreaMarginTop"

Inherited from: IgrXYChart

Margin applied to the Top of the plot area.

 
get plotAreaMarginTop(): number

Returns number 

set plotAreaMarginTop(v: number): void

Parameters

  • v: number

Returns void

plotAreaPointerDown

Section titled "plotAreaPointerDown"

Inherited from: IgrXYChart

Occurs when the pointer is pressed down over the plot area.

 
get plotAreaPointerDown(): object

Returns object 

set plotAreaPointerDown(ev: object): void

Parameters

  • ev: object

Returns void

plotAreaPointerEnter

Section titled "plotAreaPointerEnter"

Inherited from: IgrXYChart

Occurs when the pointer enters the plot area.

 
get plotAreaPointerEnter(): object

Returns object 

set plotAreaPointerEnter(ev: object): void

Parameters

  • ev: object

Returns void

plotAreaPointerLeave

Section titled "plotAreaPointerLeave"

Inherited from: IgrXYChart

Occurs when the pointer leaves the plot area.

 
get plotAreaPointerLeave(): object

Returns object 

set plotAreaPointerLeave(ev: object): void

Parameters

  • ev: object

Returns void

plotAreaPointerMove

Section titled "plotAreaPointerMove"

Inherited from: IgrXYChart

Occurs when the pointer is over the plot area.

 
get plotAreaPointerMove(): object

Returns object 

set plotAreaPointerMove(ev: object): void

Parameters

  • ev: object

Returns void

plotAreaPointerUp

Section titled "plotAreaPointerUp"

Inherited from: IgrXYChart

Occurs when the pointer is released over the plot area.

 
get plotAreaPointerUp(): object

Returns object 

set plotAreaPointerUp(ev: object): void

Parameters

  • ev: object

Returns void

resolution

Section titled "resolution"

Inherited from: IgrXYChart

Gets or sets the rendering resolution for all series in this chart. Where n = Resolution, for every n horizontal pixels, combine all items into a single data point. When Resolution = 0, all data points will be rendered as graphical objects. Charts with a higher resolution will have faster performance.

Use the Resolution property if the callouts should be display.

``

``

 
get resolution(): number

Returns number 

set resolution(v: number): void

Parameters

  • v: number

Returns void

rightMargin

Section titled "rightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of the chart content.

Use rightMargin property for the right margin of the chart content.

``

``

 
get rightMargin(): number

Returns number 

set rightMargin(v: number): void

Parameters

  • v: number

Returns void

selectedSeriesItems

Section titled "selectedSeriesItems"

Inherited from: IgrXYChart

Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items.

 
get selectedSeriesItems(): IgrChartSelectedItemCollection

Returns IgrChartSelectedItemCollection 

set selectedSeriesItems(v: IgrChartSelectedItemCollection): void

Parameters

Returns void

selectedSeriesItemsChanged

Section titled "selectedSeriesItemsChanged"

Inherited from: IgrXYChart 

get selectedSeriesItemsChanged(): object

Returns object 

set selectedSeriesItemsChanged(ev: object): void

Parameters

  • ev: object

Returns void

selectionBehavior

Section titled "selectionBehavior"

Inherited from: IgrXYChart

Gets or sets the selection behavior to use for the series in the component, when supported.

 
get selectionBehavior(): SeriesSelectionBehavior

Returns SeriesSelectionBehavior 

set selectionBehavior(v: SeriesSelectionBehavior): void

Parameters

Returns void

selectionBrush

Section titled "selectionBrush"

Inherited from: IgrXYChart

Gets or sets the selection brush to use for the series.

 
get selectionBrush(): string

Returns string 

set selectionBrush(v: string): void

Parameters

  • v: string

Returns void

selectionDismissDelayMilliseconds

Section titled "selectionDismissDelayMilliseconds"

Inherited from: IgrXYChart

Gets or sets the time to wait before visually dismissing a selection highlight

 
get selectionDismissDelayMilliseconds(): number

Returns number 

set selectionDismissDelayMilliseconds(v: number): void

Parameters

  • v: number

Returns void

selectionMode

Section titled "selectionMode"

Inherited from: IgrXYChart

Gets or sets the selection mode to use for the series in the component, when supported.

 
get selectionMode(): SeriesSelectionMode

Returns SeriesSelectionMode 

set selectionMode(v: SeriesSelectionMode): void

Parameters

Returns void

selectionTransitionDuration

Section titled "selectionTransitionDuration"

Inherited from: IgrXYChart

Gets or sets the duration used for animating Selection changes

 
get selectionTransitionDuration(): number

Returns number 

set selectionTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

seriesAdded

Section titled "seriesAdded"

Inherited from: IgrXYChart

Event raised when a series is initialized and added to this chart.

SeriesAdded event raised when a series is initialized and added to this chart.

``

 
get seriesAdded(): object

Returns object 

set seriesAdded(ev: object): void

Parameters

  • ev: object

Returns void

seriesClick

Section titled "seriesClick"

Inherited from: IgrXYChart

Occurs when the pointer is clicked over a series.

 
get seriesClick(): object

Returns object 

set seriesClick(ev: object): void

Parameters

  • ev: object

Returns void

seriesPlotAreaMarginHorizontalMode

Section titled "seriesPlotAreaMarginHorizontalMode"

Inherited from: IgrXYChart

Gets or sets horizontal mode to use for automatically calculating the plot area margin based ont the series.

 
get seriesPlotAreaMarginHorizontalMode(): SeriesPlotAreaMarginHorizontalMode

Returns SeriesPlotAreaMarginHorizontalMode 

set seriesPlotAreaMarginHorizontalMode(v: SeriesPlotAreaMarginHorizontalMode): void

Parameters

Returns void

seriesPlotAreaMarginVerticalMode

Section titled "seriesPlotAreaMarginVerticalMode"

Inherited from: IgrXYChart

Gets or sets vertical mode to use for automatically calculating the plot area margin based ont the series.

 
get seriesPlotAreaMarginVerticalMode(): SeriesPlotAreaMarginVerticalMode

Returns SeriesPlotAreaMarginVerticalMode 

set seriesPlotAreaMarginVerticalMode(v: SeriesPlotAreaMarginVerticalMode): void

Parameters

Returns void

seriesPointerDown

Section titled "seriesPointerDown"

Inherited from: IgrXYChart

Occurs when the pointer is pressed down over a Series.

SeriesPointerDown event raised when the pointer is pressed down over a Series

``

 
get seriesPointerDown(): object

Returns object 

set seriesPointerDown(ev: object): void

Parameters

  • ev: object

Returns void

seriesPointerEnter

Section titled "seriesPointerEnter"

Inherited from: IgrXYChart

Occurs when the pointer enters a Series.

SeriesPointerEnter event raised when the pointer enters a Series.

``

``

 
get seriesPointerEnter(): object

Returns object 

set seriesPointerEnter(ev: object): void

Parameters

  • ev: object

Returns void

seriesPointerLeave

Section titled "seriesPointerLeave"

Inherited from: IgrXYChart

Occurs when the pointer leaves a Series.

SeriesPointerLeave event raised when the pointer leaves a Series.

``

``

 
get seriesPointerLeave(): object

Returns object 

set seriesPointerLeave(ev: object): void

Parameters

  • ev: object

Returns void

seriesPointerMove

Section titled "seriesPointerMove"

Inherited from: IgrXYChart

Occurs when the pointer moves over a Series.

SeriesPointerMove event raised when the pointer moves over a Series.

``

``

 
get seriesPointerMove(): object

Returns object 

set seriesPointerMove(ev: object): void

Parameters

  • ev: object

Returns void

seriesPointerUp

Section titled "seriesPointerUp"

Inherited from: IgrXYChart

Occurs when the pointer is released over a Series.

SeriesPointerUp event raised when the pointer is released over a Series.

``

``

 
get seriesPointerUp(): object

Returns object 

set seriesPointerUp(ev: object): void

Parameters

  • ev: object

Returns void

seriesRemoved

Section titled "seriesRemoved"

Inherited from: IgrXYChart

Event raised when a series is removed from this chart.

SeriesRemoved event raised when a series is removed from this chart.

``

``

 
get seriesRemoved(): object

Returns object 

set seriesRemoved(ev: object): void

Parameters

  • ev: object

Returns void

seriesValueLayerUseLegend

Section titled "seriesValueLayerUseLegend"

Inherited from: IgrXYChart

Gets or sets if the chart should use the legend for value layers that target series.

 
get seriesValueLayerUseLegend(): boolean

Returns boolean 

set seriesValueLayerUseLegend(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldAutoExpandMarginForInitialLabels

Section titled "shouldAutoExpandMarginForInitialLabels"

Gets or sets a whether the series viewer should auto expand margins to accommodate the initial horizontal axis labels.

 
get shouldAutoExpandMarginForInitialLabels(): boolean

Returns boolean 

set shouldAutoExpandMarginForInitialLabels(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldAvoidAxisAnnotationCollisions

Section titled "shouldAvoidAxisAnnotationCollisions"

Inherited from: IgrXYChart

Gets or sets whether annotations for the final value of each series is displayed on the axis.

 
get shouldAvoidAxisAnnotationCollisions(): boolean

Returns boolean 

set shouldAvoidAxisAnnotationCollisions(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldConsiderAutoRotationForInitialLabels

Section titled "shouldConsiderAutoRotationForInitialLabels"

Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true.

 
get shouldConsiderAutoRotationForInitialLabels(): boolean

Returns boolean 

set shouldConsiderAutoRotationForInitialLabels(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldDisplayMockData

Section titled "shouldDisplayMockData"

Inherited from: IgrXYChart

Gets or sets whether the chart should display mock data when the data source has not been provided, if supported for this type of chart.

 
get shouldDisplayMockData(): boolean

Returns boolean 

set shouldDisplayMockData(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldPanOnMaximumZoom

Section titled "shouldPanOnMaximumZoom"

Inherited from: IgrXYChart

Gets or sets a whether the chart should pan its content when zoo,ing in passed max zoom level.

 
get shouldPanOnMaximumZoom(): boolean

Returns boolean 

set shouldPanOnMaximumZoom(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldSimulateHoverMoveCrosshairPoint

Section titled "shouldSimulateHoverMoveCrosshairPoint"

Inherited from: IgrXYChart

Gets or sets whether calling SimulateHover should shift the crosshair point.

 
get shouldSimulateHoverMoveCrosshairPoint(): boolean

Returns boolean 

set shouldSimulateHoverMoveCrosshairPoint(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldUseSkeletonStyleForMockData

Section titled "shouldUseSkeletonStyleForMockData"

Inherited from: IgrXYChart

Gets or sets whether the chart should use a faded skeleton style for mock data.

 
get shouldUseSkeletonStyleForMockData(): boolean

Returns boolean 

set shouldUseSkeletonStyleForMockData(v: boolean): void

Parameters

  • v: boolean

Returns void

sortDescriptions

Section titled "sortDescriptions"

Inherited from: IgrXYChart

Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.

 
get sortDescriptions(): IgrChartSortDescriptionCollection

Returns IgrChartSortDescriptionCollection

subtitle

Section titled "subtitle"

Inherited from: IgrXYChart

Gets or sets text to display below the Title, above the plot area.

Use the Subtitle property to display the text below and above the plot area.

``

``

 
get subtitle(): string

Returns string 

set subtitle(v: string): void

Parameters

  • v: string

Returns void

subtitleAlignment

Section titled "subtitleAlignment"

Inherited from: IgrXYChart

Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the control.

Use the SubtitleAlignment property to Gets or sets horizontal alignment.

``

``

 
get subtitleAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set subtitleAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

subtitleBottomMargin

Section titled "subtitleBottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin of chart subtitle

Use subtitleBottomMargin property for the bottom margin of chart subtitle.

``

``

 
get subtitleBottomMargin(): number

Returns number 

set subtitleBottomMargin(v: number): void

Parameters

  • v: number

Returns void

subtitleLeftMargin

Section titled "subtitleLeftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of chart subtitle

Use subtitleLeftMargin property for the left margin of chart subtitle.

``

``

 
get subtitleLeftMargin(): number

Returns number 

set subtitleLeftMargin(v: number): void

Parameters

  • v: number

Returns void

subtitleRightMargin

Section titled "subtitleRightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of chart subtitle

Use subtitleRightMargin property for the right margin of chart subtitle.

``

``

 
get subtitleRightMargin(): number

Returns number 

set subtitleRightMargin(v: number): void

Parameters

  • v: number

Returns void

subtitleTextColor

Section titled "subtitleTextColor"

Inherited from: IgrXYChart

Gets or sets color of chart subtitle

Use subtitleTextColor property to color the subtitle.

``

``

 
get subtitleTextColor(): string

Returns string 

set subtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

subtitleTextStyle

Section titled "subtitleTextStyle"

Inherited from: IgrXYChart

Gets or sets CSS font property for the chart subtitle

Use subtitleTextStyle property for the CSS font of the chart subtitle.

``

``

 
get subtitleTextStyle(): string

Returns string 

set subtitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

subtitleTopMargin

Section titled "subtitleTopMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of chart subtitle

Use subtitleTopMargin property for the top margin of chart subtitle.

``

``

 
get subtitleTopMargin(): number

Returns number 

set subtitleTopMargin(v: number): void

Parameters

  • v: number

Returns void

summaryDescriptions

Section titled "summaryDescriptions"

Inherited from: IgrXYChart

Gets the current summaries that are applied to the grid.

 
get summaryDescriptions(): IgrChartSummaryDescriptionCollection

Returns IgrChartSummaryDescriptionCollection

thickness

Section titled "thickness"

Inherited from: IgrXYChart

Gets or sets the thickness for all series in this chart. Depending on the ChartType, this can be the main brush used, or just the outline.

Use the Thickness property for the thickness of all the series in this chart.

 
get thickness(): number

Returns number 

set thickness(v: number): void

Parameters

  • v: number

Returns void

titleAlignment

Section titled "titleAlignment"

Inherited from: IgrXYChart

Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the control.

Use the TitleAlignment property for the horizontal alignment of the title.

``

``

 
get titleAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set titleAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

titleBottomMargin

Section titled "titleBottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin of chart title

Use titleBottomMargin property for the bottom margin of chart title.

``

``

 
get titleBottomMargin(): number

Returns number 

set titleBottomMargin(v: number): void

Parameters

  • v: number

Returns void

titleLeftMargin

Section titled "titleLeftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of chart title

Use titleLeftMargin property for the left margin of chart title.

``

``

 
get titleLeftMargin(): number

Returns number 

set titleLeftMargin(v: number): void

Parameters

  • v: number

Returns void

titleRightMargin

Section titled "titleRightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of chart title

Use titleLeftMargin property for the right margin of chart title.

``

``

 
get titleRightMargin(): number

Returns number 

set titleRightMargin(v: number): void

Parameters

  • v: number

Returns void

titleTextColor

Section titled "titleTextColor"

Inherited from: IgrXYChart

Gets or sets color of chart title

Use titleTextColor property to color the chart title

``

``

 
get titleTextColor(): string

Returns string 

set titleTextColor(v: string): void

Parameters

  • v: string

Returns void

titleTextStyle

Section titled "titleTextStyle"

Inherited from: IgrXYChart

Gets or sets CSS font property for the chart title

Use titleTextStyle property for the CSS font property of the chart title

``

``

 
get titleTextStyle(): string

Returns string 

set titleTextStyle(v: string): void

Parameters

  • v: string

Returns void

titleTopMargin

Section titled "titleTopMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of chart title

Use titleTopMargin property for the top margin of chart title.

``

``

 
get titleTopMargin(): number

Returns number 

set titleTopMargin(v: number): void

Parameters

  • v: number

Returns void

tooltipTemplate

Section titled "tooltipTemplate"

Inherited from: IgrXYChart

Sets or gets the template reference to use for tooltips for all the series.

 
get tooltipTemplate(): any

Returns any 

set tooltipTemplate(v: any): void

Parameters

  • v: any

Returns void

tooltipTemplates

Section titled "tooltipTemplates"

Inherited from: IgrXYChart

Sets or gets the template references to use for tooltips for all the series, in order.

 
get tooltipTemplates(): any[]

Returns any[] 

set tooltipTemplates(v: any[]): void

Parameters

  • v: any[]

Returns void

toolTipType

Section titled "toolTipType"

Inherited from: IgrXYChart

Gets or sets the style of tooltip to be displayed.

 
get toolTipType(): ToolTipType

Returns ToolTipType 

set toolTipType(v: ToolTipType): void

Parameters

Returns void

topMargin

Section titled "topMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of the chart content.

Use topMargin property for the margin of the chart content.

``

``

 
get topMargin(): number

Returns number 

set topMargin(v: number): void

Parameters

  • v: number

Returns void

transitionDuration

Section titled "transitionDuration"

Inherited from: IgrXYChart

Gets or sets the duration used for animating series plots when the data is changing

Use the TransitionDuration property to animating between data values.

``

``

 
get transitionDuration(): number

Returns number 

set transitionDuration(v: number): void

Parameters

  • v: number

Returns void

transitionEasingFunction

Section titled "transitionEasingFunction"

Inherited from: IgrXYChart

Gets or sets the easing function used for animating series plots when the data is changing. This can be set to one of the known values "linear" or "cubic," or it can be set to an easing function which takes a single numeric parameter and returns a number.

The 'transitionInEasingFunction' property used for easing function for animating series plots when the chart is loading into view.

``

``

 
get transitionEasingFunction(): object

Returns object 

set transitionEasingFunction(v: object): void

Parameters

  • v: object

Returns void

transitionInDuration

Section titled "transitionInDuration"

Gets or sets the duration used for animating series plots when the chart is loading into view

TransitionInDuration controls the length of time taken by the transition-in animation. Try setting it to 2 seconds:

``

 
get transitionInDuration(): number

Returns number 

set transitionInDuration(v: number): void

Parameters

  • v: number

Returns void

transitionInEasingFunction

Section titled "transitionInEasingFunction"

Gets or sets the easing function used for animating series plots when the chart is loading into view This can be set to one of the known values "linear" or "cubic," or it can be set to an easing function which takes a single numeric parameter and returns a number.

 
get transitionInEasingFunction(): object

Returns object 

set transitionInEasingFunction(v: object): void

Parameters

  • v: object

Returns void

transitionInMode

Section titled "transitionInMode"

Gets or sets the method that determines how to animate series plots when the chart is loading into view

TransitionInMode controls the direction of the transition-in animation.

``

 
get transitionInMode(): CategoryTransitionInMode

Returns CategoryTransitionInMode 

set transitionInMode(v: CategoryTransitionInMode): void

Parameters

Returns void

transitionInSpeedType

Section titled "transitionInSpeedType"

Gets or sets the arrival speed used for animating series plots when the chart is loading into view

TransitionInSpeedType controls the speed of the transition-in animation.

``

 
get transitionInSpeedType(): TransitionInSpeedType

Returns TransitionInSpeedType 

set transitionInSpeedType(v: TransitionInSpeedType): void

Parameters

Returns void

transitionOutDuration

Section titled "transitionOutDuration"

Gets or sets the duration used for animating series plots when the series is leaving view

 
get transitionOutDuration(): number

Returns number 

set transitionOutDuration(v: number): void

Parameters

  • v: number

Returns void

transitionOutEasingFunction

Section titled "transitionOutEasingFunction"

Gets or sets the easing function used for animating series plots when the chart is loading into view This can be set to one of the known values "linear" or "cubic," or it can be set to an easing function which takes a single numeric parameter and returns a number.

 
get transitionOutEasingFunction(): object

Returns object 

set transitionOutEasingFunction(v: object): void

Parameters

  • v: object

Returns void

trendLineBrushes

Section titled "trendLineBrushes"

Inherited from: IgrXYChart

Gets or sets the palette of brushes to used for coloring trend lines in this chart. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

Use the TrendLineBrushes property for coloring trend lines in the chart.

``

``

 
get trendLineBrushes(): string[]

Returns string[] 

set trendLineBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

trendLineLayerUseLegend

Section titled "trendLineLayerUseLegend"

Inherited from: IgrXYChart

Gets or sets if the chart should use the legend for trendline layers.

 
get trendLineLayerUseLegend(): boolean

Returns boolean 

set trendLineLayerUseLegend(v: boolean): void

Parameters

  • v: boolean

Returns void

trendLinePeriod

Section titled "trendLinePeriod"

Inherited from: IgrXYChart 

get trendLinePeriod(): number

Returns number 

set trendLinePeriod(v: number): void

Parameters

  • v: number

Returns void

trendLineThickness

Section titled "trendLineThickness"

Inherited from: IgrXYChart

Gets or sets the thickness of the trend lines in this chart. This property applies only to these chart types: point, line, spline, and bubble

Use the TrendLineThickness property for the thickness of the trend lines in the chart.

``

``

 
get trendLineThickness(): number

Returns number 

set trendLineThickness(v: number): void

Parameters

  • v: number

Returns void

trendLineType

Section titled "trendLineType"

Inherited from: IgrXYChart

Gets or sets the formula used for calculating trend lines in this chart. This property applies only to these chart types: point, line, spline, and bubble

Use the TrendLineType property for calculating trend lines.

``

``

 
get trendLineType(): TrendLineType

Returns TrendLineType 

set trendLineType(v: TrendLineType): void

Parameters

  • v: TrendLineType

Returns void

trendLineTypes

Section titled "trendLineTypes"

Inherited from: IgrXYChart

Gets or sets what trendlines to use in the chart.

 
get trendLineTypes(): IgrTrendLineTypeCollection

Returns IgrTrendLineTypeCollection 

set trendLineTypes(v: IgrTrendLineTypeCollection): void

Parameters

Returns void

unknownValuePlotting

Section titled "unknownValuePlotting"

Inherited from: IgrXYChart

Gets or sets the behavior that determines how unknown values will be plotted on the chart. Null and Double.NaN are two examples of unknown values.

Use the UnknownValuePlotting property to determines the behavior that how unknown values will be plotted on the chart.

``

``

 
get unknownValuePlotting(): UnknownValuePlotting

Returns UnknownValuePlotting 

set unknownValuePlotting(v: UnknownValuePlotting): void

Parameters

  • v: UnknownValuePlotting

Returns void

userAnnotationInformationRequested

Section titled "userAnnotationInformationRequested"

Inherited from: IgrXYChart

Occurs to request additional information for an annotation being added.

 
get userAnnotationInformationRequested(): object

Returns object 

set userAnnotationInformationRequested(ev: object): void

Parameters

  • ev: object

Returns void

userAnnotationToolTipContentUpdating

Section titled "userAnnotationToolTipContentUpdating"

Inherited from: IgrXYChart

Occurs to request additional content to display for an annotation tooltip.

 
get userAnnotationToolTipContentUpdating(): object

Returns object 

set userAnnotationToolTipContentUpdating(ev: object): void

Parameters

  • ev: object

Returns void

useValueForAutoCalloutLabels

Section titled "useValueForAutoCalloutLabels"

Inherited from: IgrXYChart

Gets or sets if event annotations should be displayed.

 
get useValueForAutoCalloutLabels(): boolean

Returns boolean 

set useValueForAutoCalloutLabels(v: boolean): void

Parameters

  • v: boolean

Returns void

valueLines

Section titled "valueLines"

Inherited from: IgrXYChart

Gets or sets what value lines to use in the chart.

 
get valueLines(): IgrValueModeCollection

Returns IgrValueModeCollection 

set valueLines(v: IgrValueModeCollection): void

Parameters

Returns void

valueLinesBrushes

Section titled "valueLinesBrushes"

Inherited from: IgrXYChart

Gets or sets the palette of brushes to use for coloring the value lines present in the ValueLines property. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

 
get valueLinesBrushes(): string[]

Returns string[] 

set valueLinesBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

valueLinesThickness

Section titled "valueLinesThickness"

Inherited from: IgrXYChart

Gets or sets thickness of value lines.

 
get valueLinesThickness(): number

Returns number 

set valueLinesThickness(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarCornerRadius

Section titled "verticalViewScrollbarCornerRadius"

Inherited from: IgrXYChart

Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarCornerRadius(): number

Returns number 

set verticalViewScrollbarCornerRadius(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarFill

Section titled "verticalViewScrollbarFill"

Inherited from: IgrXYChart

Gets or sets the fill to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarFill(): string

Returns string 

set verticalViewScrollbarFill(v: string): void

Parameters

  • v: string

Returns void

verticalViewScrollbarInset

Section titled "verticalViewScrollbarInset"

Inherited from: IgrXYChart

Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarInset(): number

Returns number 

set verticalViewScrollbarInset(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarMaxOpacity

Section titled "verticalViewScrollbarMaxOpacity"

Inherited from: IgrXYChart

Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarMaxOpacity(): number

Returns number 

set verticalViewScrollbarMaxOpacity(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarMode

Section titled "verticalViewScrollbarMode"

Inherited from: IgrXYChart

Gets or sets the vertical scrollbar mode to use for the series viewer.

 
get verticalViewScrollbarMode(): SeriesViewerScrollbarMode

Returns SeriesViewerScrollbarMode 

set verticalViewScrollbarMode(v: SeriesViewerScrollbarMode): void

Parameters

Returns void

verticalViewScrollbarOutline

Section titled "verticalViewScrollbarOutline"

Inherited from: IgrXYChart

Gets or sets the outline to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarOutline(): string

Returns string 

set verticalViewScrollbarOutline(v: string): void

Parameters

  • v: string

Returns void

verticalViewScrollbarPosition

Section titled "verticalViewScrollbarPosition"

Inherited from: IgrXYChart

Gets or sets the position to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarPosition(): SeriesViewerVerticalScrollbarPosition

Returns SeriesViewerVerticalScrollbarPosition 

set verticalViewScrollbarPosition(v: SeriesViewerVerticalScrollbarPosition): void

Parameters

Returns void

verticalViewScrollbarShouldAddAutoTrackInsets

Section titled "verticalViewScrollbarShouldAddAutoTrackInsets"

Inherited from: IgrXYChart

Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarShouldAddAutoTrackInsets(): boolean

Returns boolean 

set verticalViewScrollbarShouldAddAutoTrackInsets(v: boolean): void

Parameters

  • v: boolean

Returns void

verticalViewScrollbarStrokeThickness

Section titled "verticalViewScrollbarStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarStrokeThickness(): number

Returns number 

set verticalViewScrollbarStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarTrackEndInset

Section titled "verticalViewScrollbarTrackEndInset"

Inherited from: IgrXYChart

Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarTrackEndInset(): number

Returns number 

set verticalViewScrollbarTrackEndInset(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarTrackStartInset

Section titled "verticalViewScrollbarTrackStartInset"

Inherited from: IgrXYChart

Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarTrackStartInset(): number

Returns number 

set verticalViewScrollbarTrackStartInset(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarWidth

Section titled "verticalViewScrollbarWidth"

Inherited from: IgrXYChart

Gets or sets the width to use for the vertical scrollbar in the component, when enabled.

 
get verticalViewScrollbarWidth(): number

Returns number 

set verticalViewScrollbarWidth(v: number): void

Parameters

  • v: number

Returns void

viewport

Section titled "viewport"

Inherited from: IgrXYChart

Gets a rectangle representing the bounds of the plot area.

viewport property representing the bounds of the plot area.

``

 
get viewport(): IgRect

Returns IgRect

width

Section titled "width" 
get width(): string

Returns string 

set width(value: string): void

Parameters

  • value: string

Returns void

windowRect

Section titled "windowRect"

Inherited from: IgrXYChart

Gets or sets the rectangle representing the current scroll and zoom state of the chart. WindowRect is expressed as a Rectangle with coordinates and sizes between 0 and 1.

Use WindowRect property representing the current scroll and zoom state of the chart.

``

``

 
get windowRect(): IgRect

Returns IgRect 

set windowRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

windowRectMinHeight

Section titled "windowRectMinHeight"

Inherited from: IgrXYChart

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

 
get windowRectMinHeight(): number

Returns number 

set windowRectMinHeight(v: number): void

Parameters

  • v: number

Returns void

windowRectMinWidth

Section titled "windowRectMinWidth"

Inherited from: IgrXYChart

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

 
get windowRectMinWidth(): number

Returns number 

set windowRectMinWidth(v: number): void

Parameters

  • v: number

Returns void

windowSizeMinHeight

Section titled "windowSizeMinHeight"

Inherited from: IgrXYChart

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

 
get windowSizeMinHeight(): number

Returns number 

set windowSizeMinHeight(v: number): void

Parameters

  • v: number

Returns void

windowSizeMinWidth

Section titled "windowSizeMinWidth"

Inherited from: IgrXYChart

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

 
get windowSizeMinWidth(): number

Returns number 

set windowSizeMinWidth(v: number): void

Parameters

  • v: number

Returns void

xAxisActualMaximum

Section titled "xAxisActualMaximum"

Gets the current maximum value for the X-axis.

 
get xAxisActualMaximum(): number

Returns number

xAxisActualMinimum

Section titled "xAxisActualMinimum"

Gets the current minimum value for the X-axis.

 
get xAxisActualMinimum(): number

Returns number

xAxisEnhancedIntervalPreferMoreCategoryLabels

Section titled "xAxisEnhancedIntervalPreferMoreCategoryLabels"

Gets or sets whether the x axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

 
get xAxisEnhancedIntervalPreferMoreCategoryLabels(): boolean

Returns boolean 

set xAxisEnhancedIntervalPreferMoreCategoryLabels(v: boolean): void

Parameters

  • v: boolean

Returns void

xAxisExtent

Section titled "xAxisExtent"

Inherited from: IgrXYChart

Gets or sets the distance between the X-axis and the bottom of the chart.

To allocate space between the x-axis and the edge of the chart, set the XAxisExtent property.

``

``

 
get xAxisExtent(): number

Returns number 

set xAxisExtent(v: number): void

Parameters

  • v: number

Returns void

xAxisFormatLabel

Section titled "xAxisFormatLabel"

Inherited from: IgrXYChart

Gets or sets function which takes an context object and returns a formatted label for the X-axis.

To customize the text of the x-axis label, set XAxisFormatLabel to a single-parameter function. The argument passed to that function will be your data item.

``

``

 
get xAxisFormatLabel(): object

Returns object 

set xAxisFormatLabel(v: object): void

Parameters

  • v: object

Returns void

xAxisGap

Section titled "xAxisGap"

Gets or sets the amount of space between adjacent categories for the X-axis. The gap is silently clamped to the range [0, 1] when used.

Use the XAxisGap property to configure the spacing between items on the x-axis. This property is relevant only when the displayed series is a type with item spacing, like column series.

An XAxisGap of 0 allocates no space between items. An XAxisGap of 1 allocates a space between items equal to the width of one item.

To set the item spacing to 75% the width of one item, set the XAxisGap to 0.75, as in this code:

``

 
get xAxisGap(): number

Returns number 

set xAxisGap(v: number): void

Parameters

  • v: number

Returns void

xAxisInterval

Section titled "xAxisInterval"

Gets or sets the frequency of displayed labels along the X-axis. Gets or sets the set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

XAxisInterval determines how often to show a label, tickmark, and/or gridline along the x-axis. Set this property to n to display a label every nth item.

``

 
get xAxisInterval(): number

Returns number 

set xAxisInterval(v: number): void

Parameters

  • v: number

Returns void

xAxisInverted

Section titled "xAxisInverted"

Inherited from: IgrXYChart

Gets or sets whether to invert the direction of the X-axis by placing the first data items on the right side of the chart.

To reverse the direction of items along the x-axis, set the XAxisInverted property to true.

``

``

 
get xAxisInverted(): boolean

Returns boolean 

set xAxisInverted(v: boolean): void

Parameters

  • v: boolean

Returns void

xAxisIsLastLabelMandatory

Section titled "xAxisIsLastLabelMandatory"

Gets or sets whether the final category label on the x-axis is always displayed, even when the axis interval would normally skip it.

 
get xAxisIsLastLabelMandatory(): boolean

Returns boolean 

set xAxisIsLastLabelMandatory(v: boolean): void

Parameters

  • v: boolean

Returns void

xAxisLabel

Section titled "xAxisLabel"

Inherited from: IgrXYChart

Gets or sets the format for labels along the X-axis.

 
get xAxisLabel(): any

Returns any 

set xAxisLabel(v: any): void

Parameters

  • v: any

Returns void

xAxisLabelAngle

Section titled "xAxisLabelAngle"

Inherited from: IgrXYChart

Gets or sets the angle of rotation for labels along the X-axis.

To control the rotation of labels on the x-axis, set the XAxisLabelAngle property to a number of rotational degrees.

``

``

 
get xAxisLabelAngle(): number

Returns number 

set xAxisLabelAngle(v: number): void

Parameters

  • v: number

Returns void

xAxisLabelBottomMargin

Section titled "xAxisLabelBottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin of labels on the X-axis

Use the XAxisLabelBottomMargin property to apply a margin below the x-axis labels.

``

``

 
get xAxisLabelBottomMargin(): number

Returns number 

set xAxisLabelBottomMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisLabelFormat

Section titled "xAxisLabelFormat"

Inherited from: IgrXYChart

Gets or sets the format string for the X axis label.

 
get xAxisLabelFormat(): string

Returns string 

set xAxisLabelFormat(v: string): void

Parameters

  • v: string

Returns void

xAxisLabelFormatSpecifiers

Section titled "xAxisLabelFormatSpecifiers"

Inherited from: IgrXYChart

Gets or sets the format specifiers to use with the XAxisLabelFormat string.

 
get xAxisLabelFormatSpecifiers(): any[]

Returns any[] 

set xAxisLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

xAxisLabelHorizontalAlignment

Section titled "xAxisLabelHorizontalAlignment"

Inherited from: IgrXYChart

Gets or sets Horizontal alignment of X-axis labels.

 
get xAxisLabelHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set xAxisLabelHorizontalAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

xAxisLabelLeftMargin

Section titled "xAxisLabelLeftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of labels on the X-axis

Use the XAxisLabelLeftMargin property to apply a margin left of the x-axis labels.

``

``

 
get xAxisLabelLeftMargin(): number

Returns number 

set xAxisLabelLeftMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisLabelLocation

Section titled "xAxisLabelLocation"

Inherited from: IgrXYChart

Gets or sets location of X-axis labels, relative to the plot area.

 
get xAxisLabelLocation(): XAxisLabelLocation

Returns XAxisLabelLocation 

set xAxisLabelLocation(v: XAxisLabelLocation): void

Parameters

Returns void

xAxisLabelRightMargin

Section titled "xAxisLabelRightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of labels on the X-axis

Use the XAxisLabelRightMargin property to apply a margin right of the x-axis labels.

``

``

 
get xAxisLabelRightMargin(): number

Returns number 

set xAxisLabelRightMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisLabelTextColor

Section titled "xAxisLabelTextColor"

Inherited from: IgrXYChart

Gets or sets color of labels on the X-axis

To change the color of x-axis labels, set the XAxisLabelTextColor property to a color string.

``

``

 
get xAxisLabelTextColor(): string

Returns string 

set xAxisLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

xAxisLabelTextStyle

Section titled "xAxisLabelTextStyle"

Inherited from: IgrXYChart

Gets or sets CSS font property for labels on X-axis

To change the font of x-axis labels, set the XAxisLabelTextStyle property.

``

``

 
get xAxisLabelTextStyle(): string

Returns string 

set xAxisLabelTextStyle(v: string): void

Parameters

  • v: string

Returns void

xAxisLabelTopMargin

Section titled "xAxisLabelTopMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of labels on the X-axis

Use the XAxisLabelTopMargin property to apply a margin above the x-axis labels.

``

``

 
get xAxisLabelTopMargin(): number

Returns number 

set xAxisLabelTopMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisLabelVerticalAlignment

Section titled "xAxisLabelVerticalAlignment"

Inherited from: IgrXYChart

Gets or sets Vertical alignment of X-axis labels.

Use the XAxisLabelVerticalAlignment property to change the vertical position of x-axis labels.

``

``

 
get xAxisLabelVerticalAlignment(): VerticalAlignment

Returns VerticalAlignment 

set xAxisLabelVerticalAlignment(v: VerticalAlignment): void

Parameters

  • v: VerticalAlignment

Returns void

xAxisLabelVisibility

Section titled "xAxisLabelVisibility"

Inherited from: IgrXYChart

Gets or sets Visibility of X-axis labels.

To hide the x-axis labels, set XAxisLabelVisibility to collapsed.

``

``

 
get xAxisLabelVisibility(): Visibility

Returns Visibility 

set xAxisLabelVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

xAxisMajorStroke

Section titled "xAxisMajorStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to major gridlines along the X-axis.

Set XAxisMajorStroke to control the color of major gridlines extending vertically from the x-axis.

``

``

 
get xAxisMajorStroke(): string

Returns string 

set xAxisMajorStroke(v: string): void

Parameters

  • v: string

Returns void

xAxisMajorStrokeThickness

Section titled "xAxisMajorStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to major gridlines along the X-axis.

Set XAxisMajorStrokeThickness to control the thickness of major gridlines extending vertically from the x-axis.

``

``

 
get xAxisMajorStrokeThickness(): number

Returns number 

set xAxisMajorStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

xAxisMaximumExtent

Section titled "xAxisMaximumExtent"

Inherited from: IgrXYChart

Gets or sets the distance between the X-axis and the bottom of the chart.

 
get xAxisMaximumExtent(): number

Returns number 

set xAxisMaximumExtent(v: number): void

Parameters

  • v: number

Returns void

xAxisMaximumExtentPercentage

Section titled "xAxisMaximumExtentPercentage"

Inherited from: IgrXYChart

Gets or sets the distance between the X-axis and the bottom of the chart.

 
get xAxisMaximumExtentPercentage(): number

Returns number 

set xAxisMaximumExtentPercentage(v: number): void

Parameters

  • v: number

Returns void

xAxisMaximumGap

Section titled "xAxisMaximumGap"

Gets or sets the maximum gap value to allow. This defaults to 1.0.

 
get xAxisMaximumGap(): number

Returns number 

set xAxisMaximumGap(v: number): void

Parameters

  • v: number

Returns void

xAxisMinimumGapSize

Section titled "xAxisMinimumGapSize"

Gets or sets the minimum amount of pixels to use for the gap between categories, if possible.

 
get xAxisMinimumGapSize(): number

Returns number 

set xAxisMinimumGapSize(v: number): void

Parameters

  • v: number

Returns void

xAxisMinorInterval

Section titled "xAxisMinorInterval"

Gets or sets the frequency of displayed minor lines along the X-axis. Gets or sets the set value is a factor that determines how the minor lines will be displayed.

XAxisMinorInterval determines how often to show a minor gridline along the x-axis. This property is relevant only when the displayed series is a type with grouping, like column series.

XAxisMinorInterval is expressed as a number between 0 and 1, representing the frequency of the interval. To display minor gridlines representing 10ths of an item width, set XAxisMinorInterval to 0.1.

``

 
get xAxisMinorInterval(): number

Returns number 

set xAxisMinorInterval(v: number): void

Parameters

  • v: number

Returns void

xAxisMinorStroke

Section titled "xAxisMinorStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to minor gridlines along the X-axis.

Set XAxisMinorStroke to control the color of minor gridlines extending vertically from the x-axis.

``

``

 
get xAxisMinorStroke(): string

Returns string 

set xAxisMinorStroke(v: string): void

Parameters

  • v: string

Returns void

xAxisMinorStrokeThickness

Section titled "xAxisMinorStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to minor gridlines along the X-axis.

Set XAxisMinorStrokeThickness to control the thickness of minor gridlines extending vertically from the x-axis.

``

``

 
get xAxisMinorStrokeThickness(): number

Returns number 

set xAxisMinorStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

xAxisOverlap

Section titled "xAxisOverlap"

Gets or sets the amount of overlap between adjacent categories for the X-axis. Gets or sets the overlap is silently clamped to the range [-1, 1] when used.

Use the XAxisOverlap property to configure the spacing between items on the x-axis. This property is relevant only when the displayed series is a type with item spacing, like column series.

An XAxisOverlap of 0 places grouped items adjacent to each other. An XAxisOverlap of 1 places grouped items in the same axis space, completely overlapping. An XAxisOverlap of -1 places a space between grouped items equal to the width of one item.

To place grouped items with 75% overlap, set the XAxisOverlap to 0.75, as in this code:

``

 
get xAxisOverlap(): number

Returns number 

set xAxisOverlap(v: number): void

Parameters

  • v: number

Returns void

xAxisStrip

Section titled "xAxisStrip"

Inherited from: IgrXYChart

Gets or sets the color to apply to stripes along the X-axis.

Set XAxisStrip to control the alternating color of stripes extending vertically from the x-axis.

``

``

 
get xAxisStrip(): string

Returns string 

set xAxisStrip(v: string): void

Parameters

  • v: string

Returns void

xAxisStroke

Section titled "xAxisStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to the X-axis line.

Set XAxisStroke to control the color of the x-axis line.

``

``

 
get xAxisStroke(): string

Returns string 

set xAxisStroke(v: string): void

Parameters

  • v: string

Returns void

xAxisStrokeThickness

Section titled "xAxisStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to the X-axis line.

Set XAxisStrokeThickness to control the thickness of the x-axis line.

``

``

 
get xAxisStrokeThickness(): number

Returns number 

set xAxisStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

xAxisTickLength

Section titled "xAxisTickLength"

Inherited from: IgrXYChart

Gets or sets the length of tickmarks along the X-axis.

Set XAxisTickLength to control the length of tickmarks extending vertically from the x-axis line.

``

``

 
get xAxisTickLength(): number

Returns number 

set xAxisTickLength(v: number): void

Parameters

  • v: number

Returns void

xAxisTickStroke

Section titled "xAxisTickStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to tickmarks along the X-axis.

Set XAxisTickStroke to control the color of tickmarks extending vertically from the x-axis line.

``

``

 
get xAxisTickStroke(): string

Returns string 

set xAxisTickStroke(v: string): void

Parameters

  • v: string

Returns void

xAxisTickStrokeThickness

Section titled "xAxisTickStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to tickmarks along the X-axis.

Set XAxisTickStrokeThickness to control the thickness of tickmarks extending vertically from the x-axis line.

``

``

 
get xAxisTickStrokeThickness(): number

Returns number 

set xAxisTickStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

xAxisTitle

Section titled "xAxisTitle"

Inherited from: IgrXYChart

Gets or sets the Text to display below the X-axis.

Set XAxisTitle to display a label adjacent to the x-axis.

``

``

 
get xAxisTitle(): string

Returns string 

set xAxisTitle(v: string): void

Parameters

  • v: string

Returns void

xAxisTitleAlignment

Section titled "xAxisTitleAlignment"

Inherited from: IgrXYChart

Gets or sets Horizontal alignment of the X-axis title.

Set XAxisTitleAlignment to control the horizontal alignment of the x-axis title.

``

``

 
get xAxisTitleAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set xAxisTitleAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

xAxisTitleAngle

Section titled "xAxisTitleAngle"

Inherited from: IgrXYChart

Gets or sets the angle of rotation for the X-axis title.

Set XAxisTitleAngle to control the rotation of the x-axis title.

``

``

 
get xAxisTitleAngle(): number

Returns number 

set xAxisTitleAngle(v: number): void

Parameters

  • v: number

Returns void

xAxisTitleBottomMargin

Section titled "xAxisTitleBottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin of a title on the X-axis

Use the XAxisTitleBottomMargin property to apply a margin below the x-axis title.

``

``

 
get xAxisTitleBottomMargin(): number

Returns number 

set xAxisTitleBottomMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisTitleLeftMargin

Section titled "xAxisTitleLeftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of a title on the X-axis

Use the XAxisTitleLeftMargin property to apply a margin left of the x-axis title.

``

``

 
get xAxisTitleLeftMargin(): number

Returns number 

set xAxisTitleLeftMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisTitleMargin

Section titled "xAxisTitleMargin"

Inherited from: IgrXYChart

Gets or sets the margin around a title on the X-axis

Use the XAxisTitleMargin property to set a margin around the y-axis title.

 
get xAxisTitleMargin(): number

Returns number 

set xAxisTitleMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisTitleRightMargin

Section titled "xAxisTitleRightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of a title on the X-axis

Use the XAxisTitleRightMargin property to apply a margin right of the x-axis title.

``

``

 
get xAxisTitleRightMargin(): number

Returns number 

set xAxisTitleRightMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisTitleTextColor

Section titled "xAxisTitleTextColor"

Inherited from: IgrXYChart

Gets or sets color of title on the X-axis

To change the color of the x-axis title, set the XAxisTitleTextColor property to a color string.

``

``

 
get xAxisTitleTextColor(): string

Returns string 

set xAxisTitleTextColor(v: string): void

Parameters

  • v: string

Returns void

xAxisTitleTextStyle

Section titled "xAxisTitleTextStyle"

Inherited from: IgrXYChart

Gets or sets CSS font property for title on X-axis

To change the font of the x-axis title, set the XAxisTitleTextStyle property.

``

``

 
get xAxisTitleTextStyle(): string

Returns string 

set xAxisTitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

xAxisTitleTopMargin

Section titled "xAxisTitleTopMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of a title on the X-axis

Use the XAxisTitleTopMargin property to apply a margin above the x-axis title.

``

``

 
get xAxisTitleTopMargin(): number

Returns number 

set xAxisTitleTopMargin(v: number): void

Parameters

  • v: number

Returns void

xAxisZoomMaximumCategoryRange

Section titled "xAxisZoomMaximumCategoryRange"

Gets or sets number of visible categories at maximum zooming level This property is overridden by chart's WindowRectMinWidth property

 
get xAxisZoomMaximumCategoryRange(): number

Returns number 

set xAxisZoomMaximumCategoryRange(v: number): void

Parameters

  • v: number

Returns void

xAxisZoomMaximumItemSpan

Section titled "xAxisZoomMaximumItemSpan"

Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value. This property is overridden by chart's WindowRectMinWidth property

 
get xAxisZoomMaximumItemSpan(): number

Returns number 

set xAxisZoomMaximumItemSpan(v: number): void

Parameters

  • v: number

Returns void

xAxisZoomToCategoryRange

Section titled "xAxisZoomToCategoryRange"

Gets or sets number of categories that the chart will zoom in and fill plot area This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

 
get xAxisZoomToCategoryRange(): number

Returns number 

set xAxisZoomToCategoryRange(v: number): void

Parameters

  • v: number

Returns void

xAxisZoomToCategoryStart

Section titled "xAxisZoomToCategoryStart"

Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

 
get xAxisZoomToCategoryStart(): number

Returns number 

set xAxisZoomToCategoryStart(v: number): void

Parameters

  • v: number

Returns void

xAxisZoomToItemSpan

Section titled "xAxisZoomToItemSpan"

Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automatically zoom in until series item has specified pixel span. This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

 
get xAxisZoomToItemSpan(): number

Returns number 

set xAxisZoomToItemSpan(v: number): void

Parameters

  • v: number

Returns void

yAxisAbbreviateLargeNumbers

Section titled "yAxisAbbreviateLargeNumbers"

Gets or sets whether the large numbers on the Y-axis labels are abbreviated.

To abbreviate on the y-axis using formats like "1K" or "1M," set YAxisAbbreviateLargeNumbers to true.

``

 
get yAxisAbbreviateLargeNumbers(): boolean

Returns boolean 

set yAxisAbbreviateLargeNumbers(v: boolean): void

Parameters

  • v: boolean

Returns void

yAxisActualMaximum

Section titled "yAxisActualMaximum"

Gets the current maximum value for the Y-axis.

 
get yAxisActualMaximum(): number

Returns number

yAxisActualMinimum

Section titled "yAxisActualMinimum"

Gets the current minimum value for the Y-axis.

 
get yAxisActualMinimum(): number

Returns number

yAxisAutoRangeBufferMode

Section titled "yAxisAutoRangeBufferMode"

Gets or sets how the numeric axis will adjust its range buffer to less closely fix the data from the series.

 
get yAxisAutoRangeBufferMode(): AxisRangeBufferMode

Returns AxisRangeBufferMode 

set yAxisAutoRangeBufferMode(v: AxisRangeBufferMode): void

Parameters

Returns void

yAxisEnhancedIntervalPreferMoreCategoryLabels

Section titled "yAxisEnhancedIntervalPreferMoreCategoryLabels"

Gets or sets whether the y axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

 
get yAxisEnhancedIntervalPreferMoreCategoryLabels(): boolean

Returns boolean 

set yAxisEnhancedIntervalPreferMoreCategoryLabels(v: boolean): void

Parameters

  • v: boolean

Returns void

yAxisExtent

Section titled "yAxisExtent"

Inherited from: IgrXYChart

Gets or sets the distance between the Y-axis and the left edge of the chart.

To allocate space between the x-axis and the edge of the chart, set the XAxisExtent property.

``

``

 
get yAxisExtent(): number

Returns number 

set yAxisExtent(v: number): void

Parameters

  • v: number

Returns void

yAxisFavorLabellingScaleEnd

Section titled "yAxisFavorLabellingScaleEnd"

Gets or sets whether the axis should favor emitting a label at the end of the scale.

 
get yAxisFavorLabellingScaleEnd(): boolean

Returns boolean 

set yAxisFavorLabellingScaleEnd(v: boolean): void

Parameters

  • v: boolean

Returns void

yAxisFormatLabel

Section titled "yAxisFormatLabel"

Inherited from: IgrXYChart

Gets or sets function which takes a context object and returns a formatted label for the Y-axis.

To customize the text of the y-axis label, set YAxisFormatLabel to a single-parameter function. The argument passed to that function will be the numeric value corresponding to a position on the y-axis.

``

``

 
get yAxisFormatLabel(): object

Returns object 

set yAxisFormatLabel(v: object): void

Parameters

  • v: object

Returns void

yAxisInterval

Section titled "yAxisInterval"

Gets or sets the distance between each label and grid line along the Y-axis.

YAxisInterval determines how often to show a label, tickmark, and/or gridline along the y-axis. Set this property to a number less than the numeric range of the y-axis.

``

 
get yAxisInterval(): number

Returns number 

set yAxisInterval(v: number): void

Parameters

  • v: number

Returns void

yAxisInverted

Section titled "yAxisInverted"

Inherited from: IgrXYChart

Gets or sets whether to invert the direction of the Y-axis by placing the minimum numeric value at the top of the chart.

You can use YAxisInverted to invert the scale of the y axis like this:

``

``

The default value of YAxisInverted is false.

 
get yAxisInverted(): boolean

Returns boolean 

set yAxisInverted(v: boolean): void

Parameters

  • v: boolean

Returns void

yAxisIsLastLabelMandatory

Section titled "yAxisIsLastLabelMandatory"

Gets or sets whether the final category label on the y-axis is always displayed, even when the axis interval would normally skip it.

 
get yAxisIsLastLabelMandatory(): boolean

Returns boolean 

set yAxisIsLastLabelMandatory(v: boolean): void

Parameters

  • v: boolean

Returns void

yAxisIsLogarithmic

Section titled "yAxisIsLogarithmic"

Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one. Since log(-1) is imaginary and log(0) is undefined, it is recommended to enable this property only when the Y-axis minimum is greater than zero.

Set YAxisIsLogarithmic to true if you want the y-axis to be a logarithmic scale.

``

 
get yAxisIsLogarithmic(): boolean

Returns boolean 

set yAxisIsLogarithmic(v: boolean): void

Parameters

  • v: boolean

Returns void

yAxisLabel

Section titled "yAxisLabel"

Inherited from: IgrXYChart

Gets or sets the property or string from which the labels are derived.

 
get yAxisLabel(): any

Returns any 

set yAxisLabel(v: any): void

Parameters

  • v: any

Returns void

yAxisLabelAngle

Section titled "yAxisLabelAngle"

Inherited from: IgrXYChart

Gets or sets the angle of rotation for labels along the Y-axis.

To control the rotation of labels on the y-axis, set the YAxisLabelAngle property to a number of rotational degrees.

``

``

 
get yAxisLabelAngle(): number

Returns number 

set yAxisLabelAngle(v: number): void

Parameters

  • v: number

Returns void

yAxisLabelBottomMargin

Section titled "yAxisLabelBottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin of labels on the Y-axis

Use the YAxisLabelBottomMargin property to apply a margin below the y-axis labels.

``

``

 
get yAxisLabelBottomMargin(): number

Returns number 

set yAxisLabelBottomMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisLabelFormat

Section titled "yAxisLabelFormat"

Inherited from: IgrXYChart

Gets or sets the format string for the Y axis label.

 
get yAxisLabelFormat(): string

Returns string 

set yAxisLabelFormat(v: string): void

Parameters

  • v: string

Returns void

yAxisLabelFormatSpecifiers

Section titled "yAxisLabelFormatSpecifiers"

Inherited from: IgrXYChart

Gets or sets the format specifiers to use with the YAxisLabelFormat string.

 
get yAxisLabelFormatSpecifiers(): any[]

Returns any[] 

set yAxisLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

yAxisLabelHorizontalAlignment

Section titled "yAxisLabelHorizontalAlignment"

Inherited from: IgrXYChart

Gets or sets Horizontal alignment of Y-axis labels.

Set the YAxisLabelHorizontalAlignment property to change the horizontal alignment of y-axis labels.

 
get yAxisLabelHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set yAxisLabelHorizontalAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

yAxisLabelLeftMargin

Section titled "yAxisLabelLeftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of labels on the Y-axis

Use the YAxisLabelLeftMargin property to apply a margin left of the y-axis labels.

``

``

 
get yAxisLabelLeftMargin(): number

Returns number 

set yAxisLabelLeftMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisLabelLocation

Section titled "yAxisLabelLocation"

Inherited from: IgrXYChart

Gets or sets location of Y-axis labels, relative to the plot area.

Set the YAxisLabelLocation property to change the location of the y-axis and its labels.

``

``

 
get yAxisLabelLocation(): YAxisLabelLocation

Returns YAxisLabelLocation 

set yAxisLabelLocation(v: YAxisLabelLocation): void

Parameters

Returns void

yAxisLabelRightMargin

Section titled "yAxisLabelRightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of labels on the Y-axis

Use the YAxisLabelRightMargin property to apply a margin right of the y-axis labels.

``

``

 
get yAxisLabelRightMargin(): number

Returns number 

set yAxisLabelRightMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisLabelTextColor

Section titled "yAxisLabelTextColor"

Inherited from: IgrXYChart

Gets or sets color of labels on the Y-axis

To change the color of y-axis labels, set the YAxisLabelTextColor property to a color string.

``

``

 
get yAxisLabelTextColor(): string

Returns string 

set yAxisLabelTextColor(v: string): void

Parameters

  • v: string

Returns void

yAxisLabelTextStyle

Section titled "yAxisLabelTextStyle"

Inherited from: IgrXYChart

Gets or sets CSS font property for labels on Y-axis

To change the font of x-axis labels, set the YAxisLabelTextStyle property.

``

``

 
get yAxisLabelTextStyle(): string

Returns string 

set yAxisLabelTextStyle(v: string): void

Parameters

  • v: string

Returns void

yAxisLabelTopMargin

Section titled "yAxisLabelTopMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of labels on the Y-axis

Use the YAxisLabelTopMargin property to apply a margin above the y-axis labels.

``

``

 
get yAxisLabelTopMargin(): number

Returns number 

set yAxisLabelTopMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisLabelVerticalAlignment

Section titled "yAxisLabelVerticalAlignment"

Inherited from: IgrXYChart

Gets or sets Vertical alignment of Y-axis labels.

 
get yAxisLabelVerticalAlignment(): VerticalAlignment

Returns VerticalAlignment 

set yAxisLabelVerticalAlignment(v: VerticalAlignment): void

Parameters

  • v: VerticalAlignment

Returns void

yAxisLabelVisibility

Section titled "yAxisLabelVisibility"

Inherited from: IgrXYChart

Gets or sets Visibility of Y-axis labels.

To hide the y-axis labels, set YAxisLabelVisibility to collapsed.

``

``

 
get yAxisLabelVisibility(): Visibility

Returns Visibility 

set yAxisLabelVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

yAxisLogarithmBase

Section titled "yAxisLogarithmBase"

Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis. This property is effective only when YAxisIsLogarithmic is true.

When YAxisIsLogarithmic is true, YAxisLogarithmBase sets the logarithm base of the y-axis scale.

``

 
get yAxisLogarithmBase(): number

Returns number 

set yAxisLogarithmBase(v: number): void

Parameters

  • v: number

Returns void

yAxisMajorStroke

Section titled "yAxisMajorStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to major gridlines along the Y-axis.

Set YAxisMajorStroke to control the color of major gridlines extending horizontally from the y-axis.

``

``

 
get yAxisMajorStroke(): string

Returns string 

set yAxisMajorStroke(v: string): void

Parameters

  • v: string

Returns void

yAxisMajorStrokeThickness

Section titled "yAxisMajorStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to major gridlines along the Y-axis.

Set YAxisMajorStrokeThickness to control the thickness of major gridlines extending horizontally from the y-axis.

``

``

 
get yAxisMajorStrokeThickness(): number

Returns number 

set yAxisMajorStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

yAxisMaximumExtent

Section titled "yAxisMaximumExtent"

Inherited from: IgrXYChart

Gets or sets the distance between the Y-axis and the left edge of the chart.

 
get yAxisMaximumExtent(): number

Returns number 

set yAxisMaximumExtent(v: number): void

Parameters

  • v: number

Returns void

yAxisMaximumExtentPercentage

Section titled "yAxisMaximumExtentPercentage"

Inherited from: IgrXYChart

Gets or sets the distance between the Y-axis and the left edge of the chart.

 
get yAxisMaximumExtentPercentage(): number

Returns number 

set yAxisMaximumExtentPercentage(v: number): void

Parameters

  • v: number

Returns void

yAxisMaximumValue

Section titled "yAxisMaximumValue"

Gets or sets the data value corresponding to the maximum value of the Y-axis.

YAxisMaximumValue determines the maximum of the y-axis.

``

 
get yAxisMaximumValue(): number

Returns number 

set yAxisMaximumValue(v: number): void

Parameters

  • v: number

Returns void

yAxisMinimumValue

Section titled "yAxisMinimumValue"

Gets or sets the data value corresponding to the minimum value of the Y-axis.

YAxisMaximumValue determines the minimum of the y-axis.

``

 
get yAxisMinimumValue(): number

Returns number 

set yAxisMinimumValue(v: number): void

Parameters

  • v: number

Returns void

yAxisMinorInterval

Section titled "yAxisMinorInterval"

Gets or sets the frequency of displayed minor lines along the Y-axis.

YAxisMinorInterval determines how often to show a minor gridline along the y-axis. Set this property to a number less than the y-axis interval.

``

 
get yAxisMinorInterval(): number

Returns number 

set yAxisMinorInterval(v: number): void

Parameters

  • v: number

Returns void

yAxisMinorStroke

Section titled "yAxisMinorStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to minor gridlines along the Y-axis.

Set YAxisMinorStroke to control the color of minor gridlines extending horizontally from the y-axis.

``

``

 
get yAxisMinorStroke(): string

Returns string 

set yAxisMinorStroke(v: string): void

Parameters

  • v: string

Returns void

yAxisMinorStrokeThickness

Section titled "yAxisMinorStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to minor gridlines along the Y-axis.

Set YAxisMinorStrokeThickness to control the thickness of minor gridlines extending horizontally from the y-axis.

``

``

 
get yAxisMinorStrokeThickness(): number

Returns number 

set yAxisMinorStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

yAxisStrip

Section titled "yAxisStrip"

Inherited from: IgrXYChart

Gets or sets the color to apply to stripes along the Y-axis.

Set YAxisStrip to control the alternating color of stripes extending horizontally from the y-axis.

``

``

 
get yAxisStrip(): string

Returns string 

set yAxisStrip(v: string): void

Parameters

  • v: string

Returns void

yAxisStroke

Section titled "yAxisStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to the Y-axis line.

Set YAxisStroke to control the color of the y-axis line.

``

``

 
get yAxisStroke(): string

Returns string 

set yAxisStroke(v: string): void

Parameters

  • v: string

Returns void

yAxisStrokeThickness

Section titled "yAxisStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to the Y-axis line.

Set YAxisStrokeThickness to control the thickness of the y-axis line.

``

``

 
get yAxisStrokeThickness(): number

Returns number 

set yAxisStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

yAxisTickLength

Section titled "yAxisTickLength"

Inherited from: IgrXYChart

Gets or sets the length of tickmarks along the Y-axis.

Set YAxisTickLength to control the length of tickmarks extending horizontally from the y-axis line.

``

``

 
get yAxisTickLength(): number

Returns number 

set yAxisTickLength(v: number): void

Parameters

  • v: number

Returns void

yAxisTickStroke

Section titled "yAxisTickStroke"

Inherited from: IgrXYChart

Gets or sets the color to apply to tickmarks along the Y-axis.

Set YAxisTickStroke to control the color of tickmarks extending horizontally from the y-axis line.

``

``

 
get yAxisTickStroke(): string

Returns string 

set yAxisTickStroke(v: string): void

Parameters

  • v: string

Returns void

yAxisTickStrokeThickness

Section titled "yAxisTickStrokeThickness"

Inherited from: IgrXYChart

Gets or sets the thickness to apply to tickmarks along the Y-axis.

Set YAxisTickStrokeThickness to control the thickness of tickmarks extending vertically from the y-axis line.

``

``

 
get yAxisTickStrokeThickness(): number

Returns number 

set yAxisTickStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

yAxisTitle

Section titled "yAxisTitle"

Inherited from: IgrXYChart

Gets or sets the Text to display to the left of the Y-axis.

Set YAxisTitle to display a label adjacent to the y-axis.

``

``

 
get yAxisTitle(): string

Returns string 

set yAxisTitle(v: string): void

Parameters

  • v: string

Returns void

yAxisTitleAlignment

Section titled "yAxisTitleAlignment"

Inherited from: IgrXYChart

Gets or sets Vertical alignment of the Y-axis title.

Set YAxisTitleAlignment to control the vertical alignment of the x-axis title.

``

``

 
get yAxisTitleAlignment(): VerticalAlignment

Returns VerticalAlignment 

set yAxisTitleAlignment(v: VerticalAlignment): void

Parameters

  • v: VerticalAlignment

Returns void

yAxisTitleAngle

Section titled "yAxisTitleAngle"

Inherited from: IgrXYChart

Gets or sets the angle of rotation for the Y-axis title.

Set YAxisTitleAngle to control the rotation of the y-axis title.

``

``

 
get yAxisTitleAngle(): number

Returns number 

set yAxisTitleAngle(v: number): void

Parameters

  • v: number

Returns void

yAxisTitleBottomMargin

Section titled "yAxisTitleBottomMargin"

Inherited from: IgrXYChart

Gets or sets the bottom margin of a title on the Y-axis

Use the YAxisTitleBottomMargin property to apply a margin below the y-axis title.

``

``

 
get yAxisTitleBottomMargin(): number

Returns number 

set yAxisTitleBottomMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisTitleLeftMargin

Section titled "yAxisTitleLeftMargin"

Inherited from: IgrXYChart

Gets or sets the left margin of a title on the Y-axis

Use the YAxisTitleLeftMargin property to apply a margin left of the y-axis title.

``

``

 
get yAxisTitleLeftMargin(): number

Returns number 

set yAxisTitleLeftMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisTitleMargin

Section titled "yAxisTitleMargin"

Inherited from: IgrXYChart

Gets or sets the margin around a title on the Y-axis

Use the YAxisTitleMargin property to set a margin around the y-axis title.

 
get yAxisTitleMargin(): number

Returns number 

set yAxisTitleMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisTitleRightMargin

Section titled "yAxisTitleRightMargin"

Inherited from: IgrXYChart

Gets or sets the right margin of a title on the Y-axis

Use the YAxisTitleRightMargin property to apply a margin right of the y-axis title.

``

``

 
get yAxisTitleRightMargin(): number

Returns number 

set yAxisTitleRightMargin(v: number): void

Parameters

  • v: number

Returns void

yAxisTitleTextColor

Section titled "yAxisTitleTextColor"

Inherited from: IgrXYChart

Gets or sets color of title on the Y-axis

To change the color of the y-axis title, set the YAxisTitleTextColor property to a color string.

``

``

 
get yAxisTitleTextColor(): string

Returns string 

set yAxisTitleTextColor(v: string): void

Parameters

  • v: string

Returns void

yAxisTitleTextStyle

Section titled "yAxisTitleTextStyle"

Inherited from: IgrXYChart

Gets or sets CSS font property for title on Y-axis

To change the font of the x-axis title, set the YAxisTitleTextStyle property.

``

``

 
get yAxisTitleTextStyle(): string

Returns string 

set yAxisTitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

yAxisTitleTopMargin

Section titled "yAxisTitleTopMargin"

Inherited from: IgrXYChart

Gets or sets the top margin of a title on the Y-axis

Use the YAxisTitleTopMargin property to apply a margin above the y-axis title.

``

``

 
get yAxisTitleTopMargin(): number

Returns number 

set yAxisTitleTopMargin(v: number): void

Parameters

  • v: number

Returns void

i

Section titled "i" 
get i(): DomainChart

Returns DomainChart

Methods

Section titled "Methods"

addCommandAvailabilityListener

Section titled "addCommandAvailabilityListener"

Inherited from: IgrXYChart 

addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

  • listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener

Section titled "addCommandStateChangedListener"

Inherited from: IgrXYChart 

addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

  • listener: ICommandStateChangedListener

Returns void

bindCalloutsData

Section titled "bindCalloutsData"

Inherited from: IgrXYChart 

bindCalloutsData(): void

Returns void

bindData

Section titled "bindData" 
bindData(): void

Returns void

cancelAnnotationFlow

Section titled "cancelAnnotationFlow"

Inherited from: IgrXYChart 

cancelAnnotationFlow(annotationFlowId: string): void

Parameters

  • annotationFlowId: string

Returns void

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy"

Destroy this control

Use the destroy property to destroy the chart.

``

 
destroy(): void

Returns void

ensureDataToolTipBadgeMargin

Section titled "ensureDataToolTipBadgeMargin"

Inherited from: IgrXYChart 

ensureDataToolTipBadgeMargin(): void

Returns void

ensureDataToolTipGroupRowMargin

Section titled "ensureDataToolTipGroupRowMargin"

Inherited from: IgrXYChart 

ensureDataToolTipGroupRowMargin(): void

Returns void

ensureDataToolTipGroupTextMargin

Section titled "ensureDataToolTipGroupTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipGroupTextMargin(): void

Returns void

ensureDataToolTipHeaderRowMargin

Section titled "ensureDataToolTipHeaderRowMargin"

Inherited from: IgrXYChart 

ensureDataToolTipHeaderRowMargin(): void

Returns void

ensureDataToolTipHeaderTextMargin

Section titled "ensureDataToolTipHeaderTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipHeaderTextMargin(): void

Returns void

ensureDataToolTipLabelTextMargin

Section titled "ensureDataToolTipLabelTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipLabelTextMargin(): void

Returns void

ensureDataToolTipSummaryRowMargin

Section titled "ensureDataToolTipSummaryRowMargin"

Inherited from: IgrXYChart 

ensureDataToolTipSummaryRowMargin(): void

Returns void

ensureDataToolTipSummaryTitleTextMargin

Section titled "ensureDataToolTipSummaryTitleTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipSummaryTitleTextMargin(): void

Returns void

ensureDataToolTipTitleTextMargin

Section titled "ensureDataToolTipTitleTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipTitleTextMargin(): void

Returns void

ensureDataToolTipUnitsTextMargin

Section titled "ensureDataToolTipUnitsTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipUnitsTextMargin(): void

Returns void

ensureDataToolTipValueRowMargin

Section titled "ensureDataToolTipValueRowMargin"

Inherited from: IgrXYChart 

ensureDataToolTipValueRowMargin(): void

Returns void

ensureDataToolTipValueTextMargin

Section titled "ensureDataToolTipValueTextMargin"

Inherited from: IgrXYChart 

ensureDataToolTipValueTextMargin(): void

Returns void

exportDomainChartTestingInfo

Section titled "exportDomainChartTestingInfo"

Inherited from: IgrXYChart 

exportDomainChartTestingInfo(): IgrDomainChartTestingInfo

Returns IgrDomainChartTestingInfo

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Export serialized visual data.

 
exportSerializedVisualData(): string

Returns string

findByName

Section titled "findByName"

Inherited from: IgrXYChart 

findByName(name: string): any

Parameters

  • name: string

Returns any

finishAnnotationFlow

Section titled "finishAnnotationFlow"

Inherited from: IgrXYChart 

finishAnnotationFlow(flowInformation: IgrUserAnnotationInformation): void

Parameters

Returns void

flush

Section titled "flush"

Inherited from: IgrXYChart

Forces any pending refresh to the chart to be finished.

Method flush used to Forces any pending deferred work to render on the chart before continuing.

``

 
flush(): void

Returns void

getCurrentXAxisActualMaximum

Section titled "getCurrentXAxisActualMaximum" 
getCurrentXAxisActualMaximum(): number

Returns number

getCurrentXAxisActualMinimum

Section titled "getCurrentXAxisActualMinimum" 
getCurrentXAxisActualMinimum(): number

Returns number

getCurrentYAxisActualMaximum

Section titled "getCurrentYAxisActualMaximum" 
getCurrentYAxisActualMaximum(): number

Returns number

getCurrentYAxisActualMinimum

Section titled "getCurrentYAxisActualMinimum" 
getCurrentYAxisActualMinimum(): number

Returns number

getDesiredToolbarActions

Section titled "getDesiredToolbarActions"

Inherited from: IgrXYChart 

getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

getScaledValueX

Section titled "getScaledValueX"

Inherited from: IgrXYChart

Converts the given visual location to a data value.

 
getScaledValueX(unscaledValue: number): number

Parameters

  • unscaledValue: number
    • The x-coordinate of the location to scale.

Returns number

getScaledValueY

Section titled "getScaledValueY"

Inherited from: IgrXYChart

Converts the given visual location to a data value.

 
getScaledValueY(unscaledValue: number): number

Parameters

  • unscaledValue: number
    • The y-coordinate of the location to scale.

Returns number

getUnscaledValueX

Section titled "getUnscaledValueX"

Inherited from: IgrXYChart

Converts the given data value to a visual location.

 
getUnscaledValueX(scaledValue: number): number

Parameters

  • scaledValue: number
    • The data value to un-scale.

Returns number

getUnscaledValueY

Section titled "getUnscaledValueY"

Inherited from: IgrXYChart

Converts the given data value to a visual location.

 
getUnscaledValueY(scaledValue: number): number

Parameters

  • scaledValue: number
    • The data value to un-scale.

Returns number

hideToolTip

Section titled "hideToolTip"

Inherited from: IgrXYChart

Hides the active main tooltip, if displayed.

Use the HideToolTip method to hide the active tooltip.

``

 
hideToolTip(): void

Returns void

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

loadAnnotationsFromJson

Section titled "loadAnnotationsFromJson"

Inherited from: IgrXYChart 

loadAnnotationsFromJson(jsonString: string): void

Parameters

  • jsonString: string

Returns void

notifyClearItems

Section titled "notifyClearItems"

Inherited from: IgrXYChart

Used to manually notify the chart that the data source has reset or cleared its items.

Use notifyClearItems method to notifies the chart that the items have been cleared from an associated data source.

``

 
notifyClearItems(source_: any): void

Parameters

  • source_: any

Returns void

notifyInsertItem

Section titled "notifyInsertItem"

Inherited from: IgrXYChart 

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

Parameters

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

Returns void

notifyRemoveItem

Section titled "notifyRemoveItem"

Inherited from: IgrXYChart 

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

Parameters

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

Returns void

notifyResized

Section titled "notifyResized"

Inherited from: IgrXYChart

Called when the control has been resized.

NotifyResized method Called when the control has been resized.

``

 
notifyResized(): void

Returns void

notifySeriesDataChanged

Section titled "notifySeriesDataChanged"

Inherited from: IgrXYChart 

notifySeriesDataChanged(): void

Returns void

notifySetItem

Section titled "notifySetItem"

Inherited from: IgrXYChart 

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

Parameters

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

Returns void

notifyVisualPropertiesChanged

Section titled "notifyVisualPropertiesChanged"

Inherited from: IgrXYChart 

notifyVisualPropertiesChanged(): void

Returns void

onDetach

Section titled "onDetach"

Inherited from: IgrXYChart 

onDetach(): void

Returns void

provideContainer

Section titled "provideContainer"

Inherited from: IgrXYChart

Called by the UI framework to provide a UI container for rendering this control.

 
provideContainer(container: any): void

Parameters

  • container: any
    • The UI container element.

Returns void

recalculateMarginAutoExpansion

Section titled "recalculateMarginAutoExpansion" 
recalculateMarginAutoExpansion(): void

Returns void

removeCommandAvailabilityListener

Section titled "removeCommandAvailabilityListener"

Inherited from: IgrXYChart 

removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

  • listener: ICommandAvailabilityListener

Returns void

removeCommandStateChangedListener

Section titled "removeCommandStateChangedListener"

Inherited from: IgrXYChart 

removeCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

  • listener: ICommandStateChangedListener

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

replayTransitionIn

Section titled "replayTransitionIn"

Inherited from: IgrXYChart

Replays transition-in animation on all series in the chart.

 
replayTransitionIn(): void

Returns void

resetAnnotations

Section titled "resetAnnotations"

Inherited from: IgrXYChart 

resetAnnotations(): void

Returns void

resetZoom

Section titled "resetZoom"

Inherited from: IgrXYChart

Resets the zoom level to default.

 
resetZoom(): void

Returns void

saveAnnotationsToJson

Section titled "saveAnnotationsToJson"

Inherited from: IgrXYChart 

saveAnnotationsToJson(): string

Returns string

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrXYChart 

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

simulateClick

Section titled "simulateClick"

Inherited from: IgrXYChart 

simulateClick(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulateHover

Section titled "simulateHover"

Inherited from: IgrXYChart 

simulateHover(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulatePlotPointerUp

Section titled "simulatePlotPointerUp"

Inherited from: IgrXYChart 

simulatePlotPointerUp(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulatePressAndHold

Section titled "simulatePressAndHold"

Inherited from: IgrXYChart 

simulatePressAndHold(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

startCreatingAnnotation

Section titled "startCreatingAnnotation"

Inherited from: IgrXYChart 

startCreatingAnnotation(): void

Returns void

startDeletingAnnotation

Section titled "startDeletingAnnotation"

Inherited from: IgrXYChart 

startDeletingAnnotation(): void

Returns void

zoomIn

Section titled "zoomIn"

Inherited from: IgrXYChart

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

 
zoomIn(v: number): void

Parameters

  • v: number

Returns void

zoomOut

Section titled "zoomOut"

Inherited from: IgrXYChart

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

 
zoomOut(v: number): void

Parameters

  • v: number

Returns void