Represents a IgxDoughnutChartComponent base series.

Type Parameters

Hierarchy

Hierarchy

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

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

Usage:

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

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

Accessors

  • get brushes(): string[]
  • Gets or sets the palette of brushes to use for coloring the slices.

    Returns string[]

  • set brushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get dataSource(): any[]
  • Returns any[]

  • set dataSource(value): void
  • Parameters

    • value: any[]

    Returns void

  • get formatLabel(): ((obj) => string)
  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

    Returns ((obj) => string)

      • (obj): string
      • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

        Parameters

        • obj: any

        Returns string

  • set formatLabel(v): void
  • Parameters

    • v: ((obj) => string)
        • (obj): string
        • Parameters

          • obj: any

          Returns string

    Returns void

  • get formatLegendLabel(): ((obj) => string)
  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend.

    Returns ((obj) => string)

      • (obj): string
      • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend.

        Parameters

        • obj: any

        Returns string

  • set formatLegendLabel(v): void
  • Parameters

    • v: ((obj) => string)
        • (obj): string
        • Parameters

          • obj: any

          Returns string

    Returns void

  • get i(): RingSeriesBase
  • Returns RingSeriesBase

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

    Returns boolean

  • set isSurfaceInteractionDisabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get labelExtent(): number
  • Gets or sets the pixel amount by which the labels are offset from the edge of the slices.

    Returns number

  • set labelExtent(v): void
  • Parameters

    • v: number

    Returns void

  • get labelFormat(): string
  • Gets or sets the label format string to use for the label.

    Returns string

  • set labelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get labelFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the LabelFormat string.

    Returns any[]

  • set labelFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

  • get labelInnerColor(): string
  • Gets or sets the color for labels rendered inside of the pie chart.

    Returns string

  • set labelInnerColor(v): void
  • Parameters

    • v: string

    Returns void

  • get labelMemberPath(): string
  • Gets or sets the property name that contains the labels.

    Returns string

  • set labelMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get labelOuterColor(): string
  • Gets or sets the color for labels rendered outside of the pie chart.

    Returns string

  • set labelOuterColor(v): void
  • Parameters

    • v: string

    Returns void

  • get labelsPosition(): LabelsPosition
  • Gets or sets the position of chart labels.

    Returns LabelsPosition

  • set labelsPosition(v): void
  • Parameters

    Returns void

  • get leaderLineFill(): string
  • Gets or sets the fill brush.

    Returns string

  • set leaderLineFill(v): void
  • Parameters

    • v: string

    Returns void

  • get leaderLineMargin(): number
  • Gets or sets the margin between a label and its leader line. The default is 6 pixels.

    Returns number

  • set leaderLineMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get leaderLineOpacity(): number
  • Gets or sets the opacity.

    Returns number

  • set leaderLineOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get leaderLineStroke(): string
  • Gets or sets the stroke brush.

    Returns string

  • set leaderLineStroke(v): void
  • Parameters

    • v: string

    Returns void

  • get leaderLineStrokeThickness(): number
  • Gets or sets the stroke thickness.

    Returns number

  • set leaderLineStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get leaderLineType(): LeaderLineType
  • Gets or sets what type of leader lines will be used for the outside end labels.

    Returns LeaderLineType

  • set leaderLineType(v): void
  • Parameters

    Returns void

  • get leaderLineVisibility(): Visibility
  • Gets or sets whether the leader lines are visible.

    Returns Visibility

  • set leaderLineVisibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get legend(): any
  • Returns any

  • set legend(v): void
  • Parameters

    • v: any

    Returns void

  • get legendLabelFormat(): string
  • Gets or sets the label format string to use for the label.

    Returns string

  • set legendLabelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get legendLabelFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the LegendLabelFormat string.

    Returns any[]

  • set legendLabelFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

  • get legendLabelMemberPath(): string
  • Gets or sets the property name that contains the legend labels.

    Returns string

  • set legendLabelMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get legendOthersLabelFormat(): string
  • Gets or sets the label format string to use for the label.

    Returns string

  • set legendOthersLabelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get legendOthersLabelFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the LegendOthersLabelFormat string.

    Returns any[]

  • set legendOthersLabelFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

  • get othersCategoryFill(): string
  • Gets or sets the fill brush.

    Returns string

  • set othersCategoryFill(v): void
  • Parameters

    • v: string

    Returns void

  • get othersCategoryOpacity(): number
  • Gets or sets the opacity.

    Returns number

  • set othersCategoryOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get othersCategoryStroke(): string
  • Gets or sets the stroke brush.

    Returns string

  • set othersCategoryStroke(v): void
  • Parameters

    • v: string

    Returns void

  • get othersCategoryStrokeThickness(): number
  • Gets or sets the stroke thickness.

    Returns number

  • set othersCategoryStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get othersCategoryText(): string
  • Gets or sets the label of the Others slice.

    Returns string

  • set othersCategoryText(v): void
  • Parameters

    • v: string

    Returns void

  • get othersCategoryThreshold(): number
  • Gets or sets the threshold value that determines if slices are grouped into the Others slice.

    Returns number

  • set othersCategoryThreshold(v): void
  • Parameters

    • v: number

    Returns void

  • get othersCategoryType(): OthersCategoryType
  • Gets or sets whether to use numeric or percent-based threshold value.

    Returns OthersCategoryType

  • set othersCategoryType(v): void
  • Parameters

    • v: OthersCategoryType

    Returns void

  • get othersLabelFormat(): string
  • Gets or sets the label format string to use for the label.

    Returns string

  • set othersLabelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get othersLabelFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the OthersLabelFormat string.

    Returns any[]

  • set othersLabelFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

  • get outlines(): string[]
  • Gets or sets the palette of brushes to use for outlines on the slices.

    Returns string[]

  • set outlines(v): void
  • Parameters

    • v: string[]

    Returns void

  • get propertyUpdated(): ((s, e) => void)
  • Event raised when a property (including "effective" and non-dependency property) value changes.

    Returns ((s, e) => void)

      • (s, e): void
      • Event raised when a property (including "effective" and non-dependency property) value changes.

        Parameters

        Returns void

  • set propertyUpdated(ev): void
  • Parameters

    Returns void

  • get radiusFactor(): number
  • Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.

    Returns number

  • set radiusFactor(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set selectedSliceFill(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set selectedSliceOpacity(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set selectedSliceStroke(v): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set selectedSliceStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns boolean

  • set showDefaultTooltip(v): void
  • Parameters

    • v: boolean

    Returns void

  • get startAngle(): number
  • Gets or sets the starting angle of the chart. The default zero value is equivalent to 3 o'clock.

    Returns number

  • set startAngle(v): void
  • Parameters

    • v: number

    Returns void

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

  • set tooltipContainerTemplate(value): void
  • Parameters

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

    Returns void

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

  • set tooltipTemplate(value): void
  • Parameters

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

    Returns void

  • get valueMemberPath(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set valueMemberPath(v): void
  • Parameters

    • v: string

    Returns void

Methods

  • Returns void

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

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

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

    Parameters

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

    Returns void

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

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

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

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

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

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

    Parameters

    • container: any
      • The UI container element.

    Returns void

  • Returns any

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Returns void