Represents concentric circles divided on arcs depending on data.

Constructors

Section titled "Constructors"

IgrDoughnutChart 

new IgrDoughnutChart(props: IIgrDoughnutChartProps): IgrDoughnutChart

Returns IgrDoughnutChart

Properties

Section titled "Properties"

actualSeries

Section titled "actualSeries"

The series actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing Angular to reproject the child content. Or adding and removing series from the manual series collection on the series property.

 
actualSeries: IgrRingSeriesBase<IIgrRingSeriesBaseProps>[]

contentSeries

Section titled "contentSeries" 
contentSeries: IgrRingSeriesBase<IIgrRingSeriesBaseProps>[]

Accessors

Section titled "Accessors"

actualPixelScalingRatio

Section titled "actualPixelScalingRatio"

Resolved pixel scaling ratio. Unless explicitly overridden by the DoughnutChart.PixelScalingRatioComponent property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value.

 
get actualPixelScalingRatio(): number

Returns number 

set actualPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

allowSliceExplosion

Section titled "allowSliceExplosion"

Gets or sets whether the slices can be exploded.

 
get allowSliceExplosion(): boolean

Returns boolean 

set allowSliceExplosion(v: boolean): void

Parameters

  • v: boolean

Returns void

allowSliceSelection

Section titled "allowSliceSelection"

Gets or sets whether the slices can be selected.

 
get allowSliceSelection(): boolean

Returns boolean 

set allowSliceSelection(v: boolean): void

Parameters

  • v: boolean

Returns void

height

Section titled "height" 
get height(): string

Returns string 

set height(value: string): void

Parameters

  • value: string

Returns void

holeDimensionsChanged

Section titled "holeDimensionsChanged"

Raised when the dimensions (center point or radius) of the doughnut hole change.

 
get holeDimensionsChanged(): object

Returns object 

set holeDimensionsChanged(ev: object): void

Parameters

  • ev: object

Returns void

i

Section titled "i" 
get i(): XamDoughnutChart

Returns XamDoughnutChart

innerExtent

Section titled "innerExtent"

Gets or sets the inner extent of the doughnut chart. It is percent from the outer ring's radius.

 
get innerExtent(): number

Returns number 

set innerExtent(v: number): void

Parameters

  • v: number

Returns void

isSurfaceInteractionDisabled

Section titled "isSurfaceInteractionDisabled"

Gets or sets whether all surface interactions with the plot area should be disabled.

 
get isSurfaceInteractionDisabled(): boolean

Returns boolean 

set isSurfaceInteractionDisabled(v: boolean): void

Parameters

  • v: boolean

Returns void

pixelScalingRatio

Section titled "pixelScalingRatio"

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

selectedSliceFill

Section titled "selectedSliceFill"

Gets or sets the fill brush.

 
get selectedSliceFill(): string

Returns string 

set selectedSliceFill(v: string): void

Parameters

  • v: string

Returns void

selectedSliceOpacity

Section titled "selectedSliceOpacity"

Gets or sets the opacity.

 
get selectedSliceOpacity(): number

Returns number 

set selectedSliceOpacity(v: number): void

Parameters

  • v: number

Returns void

selectedSliceStroke

Section titled "selectedSliceStroke"

Gets or sets the stroke brush.

 
get selectedSliceStroke(): string

Returns string 

set selectedSliceStroke(v: string): void

Parameters

  • v: string

Returns void

selectedSliceStrokeThickness

Section titled "selectedSliceStrokeThickness"

Gets or sets the stroke thickness.

 
get selectedSliceStrokeThickness(): number

Returns number 

set selectedSliceStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

series

Section titled "series"

A collection or manually added series for the chart.

 
get series(): IgrRingSeriesCollection

Returns IgrRingSeriesCollection

sliceClick

Section titled "sliceClick"

Raised when the slice is clicked.

 
get sliceClick(): object

Returns object 

set sliceClick(ev: object): void

Parameters

  • ev: object

Returns void

width

Section titled "width" 
get width(): string

Returns string 

set width(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

ensureSelectedStyle

Section titled "ensureSelectedStyle" 
ensureSelectedStyle(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Returns the chart visuals expressed as a serialized string.

 
exportSerializedVisualData(): string

Returns string

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

flush

Section titled "flush"

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

 
flush(): void

Returns void

getCenterCoordinates

Section titled "getCenterCoordinates"

Gets the center coordinates of the doughnut chart's center presenter.

 
getCenterCoordinates(): IgPoint

Returns IgPoint

getContainerID

Section titled "getContainerID"

Gets the ID of the UI container.

 
getContainerID(): string

Returns string

getHoleRadius

Section titled "getHoleRadius"

Gets the hole radius of the doughnut chart's center presenter.

 
getHoleRadius(): number

Returns number

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

notifyClearItems

Section titled "notifyClearItems"

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

 
notifyClearItems(source_: any): void

Parameters

  • source_: any

Returns void

notifyInsertItem

Section titled "notifyInsertItem" 
notifyInsertItem(source_: any, index: number, newItem: any): void

Parameters

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

Returns void

notifyRemoveItem

Section titled "notifyRemoveItem" 
notifyRemoveItem(source_: any, index: number, oldItem: any): void

Parameters

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

Returns void

notifyResized

Section titled "notifyResized"

Called when the control has been resized.

 
notifyResized(): void

Returns void

notifySetItem

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

Parameters

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

Returns void

provideContainer

Section titled "provideContainer"

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

render

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

Returns DetailedReactHTMLElement<object, HTMLDivElement>

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean