Represents a DoughnutChartComponent base series.

Constructors

Section titled "Constructors"

IgrRingSeriesBase 

new IgrRingSeriesBase(props: P): IgrRingSeriesBase

Returns IgrRingSeriesBase

Accessors

Section titled "Accessors"

brushes

Section titled "brushes"

Gets or sets the palette of brushes to use for coloring the slices.

 
get brushes(): string[]

Returns string[] 

set brushes(v: string[]): void

Parameters

  • v: string[]

Returns void

dataSource

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

Returns any[] 

set dataSource(value: any[]): void

Parameters

  • value: any[]

Returns void

formatLabel

Section titled "formatLabel"

Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

 
get formatLabel(): object

Returns object 

set formatLabel(v: object): void

Parameters

  • v: object

Returns void

formatLegendLabel

Section titled "formatLegendLabel"

Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend.

 
get formatLegendLabel(): object

Returns object 

set formatLegendLabel(v: object): void

Parameters

  • v: object

Returns void

i

Section titled "i" 
get i(): RingSeriesBase

Returns RingSeriesBase

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

labelExtent

Section titled "labelExtent"

Gets or sets the pixel amount by which the labels are offset from the edge of the slices.

 
get labelExtent(): number

Returns number 

set labelExtent(v: number): void

Parameters

  • v: number

Returns void

labelFormat

Section titled "labelFormat"

Gets or sets the label format string to use for the label.

 
get labelFormat(): string

Returns string 

set labelFormat(v: string): void

Parameters

  • v: string

Returns void

labelFormatSpecifiers

Section titled "labelFormatSpecifiers"

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

 
get labelFormatSpecifiers(): any[]

Returns any[] 

set labelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

labelInnerColor

Section titled "labelInnerColor"

Gets or sets the color for labels rendered inside of the pie chart.

 
get labelInnerColor(): string

Returns string 

set labelInnerColor(v: string): void

Parameters

  • v: string

Returns void

labelMemberPath

Section titled "labelMemberPath"

Gets or sets the property name that contains the labels.

 
get labelMemberPath(): string

Returns string 

set labelMemberPath(v: string): void

Parameters

  • v: string

Returns void

labelOuterColor

Section titled "labelOuterColor"

Gets or sets the color for labels rendered outside of the pie chart.

 
get labelOuterColor(): string

Returns string 

set labelOuterColor(v: string): void

Parameters

  • v: string

Returns void

labelsPosition

Section titled "labelsPosition"

Gets or sets the position of chart labels.

 
get labelsPosition(): LabelsPosition

Returns LabelsPosition 

set labelsPosition(v: LabelsPosition): void

Parameters

Returns void

leaderLineFill

Section titled "leaderLineFill"

Gets or sets the fill brush.

 
get leaderLineFill(): string

Returns string 

set leaderLineFill(v: string): void

Parameters

  • v: string

Returns void

leaderLineMargin

Section titled "leaderLineMargin"

Gets or sets the margin between a label and its leader line. The default is 6 pixels.

 
get leaderLineMargin(): number

Returns number 

set leaderLineMargin(v: number): void

Parameters

  • v: number

Returns void

leaderLineOpacity

Section titled "leaderLineOpacity"

Gets or sets the opacity.

 
get leaderLineOpacity(): number

Returns number 

set leaderLineOpacity(v: number): void

Parameters

  • v: number

Returns void

leaderLineStroke

Section titled "leaderLineStroke"

Gets or sets the stroke brush.

 
get leaderLineStroke(): string

Returns string 

set leaderLineStroke(v: string): void

Parameters

  • v: string

Returns void

leaderLineStrokeThickness

Section titled "leaderLineStrokeThickness"

Gets or sets the stroke thickness.

 
get leaderLineStrokeThickness(): number

Returns number 

set leaderLineStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

leaderLineType

Section titled "leaderLineType"

Gets or sets what type of leader lines will be used for the outside end labels.

 
get leaderLineType(): LeaderLineType

Returns LeaderLineType 

set leaderLineType(v: LeaderLineType): void

Parameters

Returns void

leaderLineVisibility

Section titled "leaderLineVisibility"

Gets or sets whether the leader lines are visible.

 
get leaderLineVisibility(): Visibility

Returns Visibility 

set leaderLineVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

legend

Section titled "legend" 
get legend(): any

Returns any 

set legend(v: any): void

Parameters

  • v: any

Returns void

legendLabelFormat

Section titled "legendLabelFormat"

Gets or sets the label format string to use for the label.

 
get legendLabelFormat(): string

Returns string 

set legendLabelFormat(v: string): void

Parameters

  • v: string

Returns void

legendLabelFormatSpecifiers

Section titled "legendLabelFormatSpecifiers"

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

 
get legendLabelFormatSpecifiers(): any[]

Returns any[] 

set legendLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

legendLabelMemberPath

Section titled "legendLabelMemberPath"

Gets or sets the property name that contains the legend labels.

 
get legendLabelMemberPath(): string

Returns string 

set legendLabelMemberPath(v: string): void

Parameters

  • v: string

Returns void

legendOthersLabelFormat

Section titled "legendOthersLabelFormat"

Gets or sets the label format string to use for the label.

 
get legendOthersLabelFormat(): string

Returns string 

set legendOthersLabelFormat(v: string): void

Parameters

  • v: string

Returns void

legendOthersLabelFormatSpecifiers

Section titled "legendOthersLabelFormatSpecifiers"

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

 
get legendOthersLabelFormatSpecifiers(): any[]

Returns any[] 

set legendOthersLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

othersCategoryFill

Section titled "othersCategoryFill"

Gets or sets the fill brush.

 
get othersCategoryFill(): string

Returns string 

set othersCategoryFill(v: string): void

Parameters

  • v: string

Returns void

othersCategoryOpacity

Section titled "othersCategoryOpacity"

Gets or sets the opacity.

 
get othersCategoryOpacity(): number

Returns number 

set othersCategoryOpacity(v: number): void

Parameters

  • v: number

Returns void

othersCategoryStroke

Section titled "othersCategoryStroke"

Gets or sets the stroke brush.

 
get othersCategoryStroke(): string

Returns string 

set othersCategoryStroke(v: string): void

Parameters

  • v: string

Returns void

othersCategoryStrokeThickness

Section titled "othersCategoryStrokeThickness"

Gets or sets the stroke thickness.

 
get othersCategoryStrokeThickness(): number

Returns number 

set othersCategoryStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

othersCategoryText

Section titled "othersCategoryText"

Gets or sets the label of the Others slice.

 
get othersCategoryText(): string

Returns string 

set othersCategoryText(v: string): void

Parameters

  • v: string

Returns void

othersCategoryThreshold

Section titled "othersCategoryThreshold"

Gets or sets the threshold value that determines if slices are grouped into the Others slice.

 
get othersCategoryThreshold(): number

Returns number 

set othersCategoryThreshold(v: number): void

Parameters

  • v: number

Returns void

othersCategoryType

Section titled "othersCategoryType"

Gets or sets whether to use numeric or percent-based threshold value.

 
get othersCategoryType(): OthersCategoryType

Returns OthersCategoryType 

set othersCategoryType(v: OthersCategoryType): void

Parameters

  • v: OthersCategoryType

Returns void

othersLabelFormat

Section titled "othersLabelFormat"

Gets or sets the label format string to use for the label.

 
get othersLabelFormat(): string

Returns string 

set othersLabelFormat(v: string): void

Parameters

  • v: string

Returns void

othersLabelFormatSpecifiers

Section titled "othersLabelFormatSpecifiers"

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

 
get othersLabelFormatSpecifiers(): any[]

Returns any[] 

set othersLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

outlines

Section titled "outlines"

Gets or sets the palette of brushes to use for outlines on the slices.

 
get outlines(): string[]

Returns string[] 

set outlines(v: string[]): void

Parameters

  • v: string[]

Returns void

propertyUpdated

Section titled "propertyUpdated"

Event raised when a property (including "effective" and non-dependency property) value changes.

 
get propertyUpdated(): object

Returns object 

set propertyUpdated(ev: object): void

Parameters

  • ev: object

Returns void

radiusFactor

Section titled "radiusFactor"

Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.

 
get radiusFactor(): number

Returns number 

set radiusFactor(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

showDefaultTooltip

Section titled "showDefaultTooltip"

Gets or sets whether default tooltip will be shown.

 
get showDefaultTooltip(): boolean

Returns boolean 

set showDefaultTooltip(v: boolean): void

Parameters

  • v: boolean

Returns void

startAngle

Section titled "startAngle"

Gets or sets the starting angle of the chart. The default zero value is equivalent to 3 o'clock.

 
get startAngle(): number

Returns number 

set startAngle(v: number): void

Parameters

  • v: number

Returns void

textStyle

Section titled "textStyle"

Gets or sets the text style to use for labels.

 
get textStyle(): string

Returns string 

set textStyle(v: string): void

Parameters

  • v: string

Returns void

tooltipContainerTemplate

Section titled "tooltipContainerTemplate" 
get tooltipContainerTemplate(): any

Returns any 

set tooltipContainerTemplate(value: any): void

Parameters

  • value: any

Returns void

tooltipTemplate

Section titled "tooltipTemplate" 
get tooltipTemplate(): any

Returns any 

set tooltipTemplate(value: any): void

Parameters

  • value: any

Returns void

valueMemberPath

Section titled "valueMemberPath"

Gets or Sets the property name that contains the values.

 
get valueMemberPath(): string

Returns string 

set valueMemberPath(v: string): void

Parameters

  • v: string

Returns void

Methods

Section titled "Methods"

bindData

Section titled "bindData" 
bindData(): void

Returns void

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

ensureLeaderLineStyle

Section titled "ensureLeaderLineStyle" 
ensureLeaderLineStyle(): void

Returns void

ensureOthersCategoryStyle

Section titled "ensureOthersCategoryStyle" 
ensureOthersCategoryStyle(): void

Returns void

ensureSelectedStyle

Section titled "ensureSelectedStyle" 
ensureSelectedStyle(): void

Returns void

findByName

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

Parameters

  • name: string

Returns any

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

Returns any

shouldComponentUpdate

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

sychronizeCollections

Section titled "sychronizeCollections" 
sychronizeCollections(): void

Returns void

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgrRingSeriesBase

Parameters

  • internal: any

Returns IgrRingSeriesBase