Class IgrDoughnutChart<S, SS, S>

Represents concentric circles divided on arcs depending on data.

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

constructor

Properties

actualSeries

actualSeries: IgrRingSeriesBase[] = []

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.

contentSeries

contentSeries: IgrRingSeriesBase[]

context

context: any

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

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

if used without a type annotation, or without static contextType

see

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

props

props: Readonly<IIgrDoughnutChartProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

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

Accessors

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • Resolved pixel scaling ratio. Unless explicitly overridden by the IgxDoughnutChart.PixelScalingRatioComponent property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value.

    Returns number

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

    Parameters

    • v: number

    Returns void

allowSliceExplosion

  • get allowSliceExplosion(): boolean
  • set allowSliceExplosion(v: boolean): void
  • Gets or sets whether the slices can be exploded.

    Returns boolean

  • Gets or sets whether the slices can be exploded.

    Parameters

    • v: boolean

    Returns void

allowSliceSelection

  • get allowSliceSelection(): boolean
  • set allowSliceSelection(v: boolean): void
  • Gets or sets whether the slices can be selected.

    Returns boolean

  • Gets or sets whether the slices can be selected.

    Parameters

    • v: boolean

    Returns void

height

  • get height(): string
  • set height(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

holeDimensionsChanged

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

i

  • get i(): XamDoughnutChart
  • Returns XamDoughnutChart

innerExtent

  • get innerExtent(): number
  • set innerExtent(v: number): void
  • Gets or sets the inner extent of the doughnut chart. It is percent from the outer ring's radius.

    Returns number

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

    Parameters

    • v: number

    Returns void

isSurfaceInteractionDisabled

  • get isSurfaceInteractionDisabled(): boolean
  • set isSurfaceInteractionDisabled(v: boolean): void
  • Gets or sets whether all surface interactions with the plot area should be disabled.

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number
  • set pixelScalingRatio(v: number): void
  • Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Returns number

  • Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Parameters

    • v: number

    Returns void

selectedSliceFill

  • get selectedSliceFill(): string
  • set selectedSliceFill(v: string): void
  • Gets or sets the fill brush.

    Returns string

  • Gets or sets the fill brush.

    Parameters

    • v: string

    Returns void

selectedSliceOpacity

  • get selectedSliceOpacity(): number
  • set selectedSliceOpacity(v: number): void
  • Gets or sets the opacity.

    Returns number

  • Gets or sets the opacity.

    Parameters

    • v: number

    Returns void

selectedSliceStroke

  • get selectedSliceStroke(): string
  • set selectedSliceStroke(v: string): void
  • Gets or sets the stroke brush.

    Returns string

  • Gets or sets the stroke brush.

    Parameters

    • v: string

    Returns void

selectedSliceStrokeThickness

  • get selectedSliceStrokeThickness(): number
  • set selectedSliceStrokeThickness(v: number): void
  • Gets or sets the stroke thickness.

    Returns number

  • Gets or sets the stroke thickness.

    Parameters

    • v: number

    Returns void

series

  • A collection or manually added series for the chart.

    Returns IgrRingSeriesCollection

sliceClick

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

width

  • get width(): string
  • set width(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrDoughnutChartProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrDoughnutChartProps>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

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

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrDoughnutChartProps>, nextState: Readonly<S>, nextContext: any): void

destroy

  • destroy(): void
  • Returns void

ensureSelectedStyle

  • ensureSelectedStyle(): void
  • Returns void

exportSerializedVisualData

  • exportSerializedVisualData(): string
  • Returns the chart visuals expressed as a serialized string.

    Returns string

flush

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

    Returns void

forceUpdate

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

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

    Returns void

getCenterCoordinates

  • getCenterCoordinates(): IgPoint
  • Gets the center coordinates of the doughnut chart's center presenter.

    Returns IgPoint

getContainerID

  • getContainerID(): string
  • Gets the ID of the UI container.

    Returns string

getHoleRadius

  • getHoleRadius(): number
  • Gets the hole radius of the doughnut chart's center presenter.

    Returns number

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

initializeContent

  • initializeContent(): void
  • Returns void

notifyClearItems

  • notifyClearItems(source_: any): void
  • Used to manually notify the chart that the data source has reset or cleared its items.

    Parameters

    • source_: any

    Returns void

notifyInsertItem

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

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

    Returns void

notifyRemoveItem

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

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

    Returns void

notifyResized

  • notifyResized(): void
  • Called when the control has been resized.

    Returns void

notifySetItem

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

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

    Returns void

provideContainer

  • provideContainer(container: any): void
  • Called by the UI framework to provide a UI container for rendering this control.

    Parameters

    • container: any
      • The UI container element.

    Returns void

render

  • render(): DetailedReactHTMLElement<object, HTMLDivElement>
  • Returns DetailedReactHTMLElement<object, HTMLDivElement>

setState

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

    • K: keyof S

    Parameters

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

    Returns void

shouldComponentUpdate

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

    • nextProps: any
    • nextState: any

    Returns boolean