Class IgrRingSeriesBase<P, SS>

Represents a IgxDoughnutChartComponent base series.

Type parameters

Hierarchy

Constructors

constructor

  • Parameters

    • props: P

    Returns IgrRingSeriesBase

Properties

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<P> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<__type>

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

brushes

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

    Returns string[]

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

    Parameters

    • v: string[]

    Returns void

dataSource

  • get dataSource(): Array<any>
  • set dataSource(value: Array<any>): void
  • Returns Array<any>

  • Parameters

    • value: Array<any>

    Returns void

formatLabel

  • get formatLabel(): function
  • set formatLabel(v: function): void
  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

    Returns function

      • (obj: any): string
      • Parameters

        • obj: any

        Returns string

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

    Parameters

    • v: function
        • (obj: any): string
        • Parameters

          • obj: any

          Returns string

    Returns void

formatLegendLabel

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

    Returns function

      • (obj: any): string
      • Parameters

        • obj: any

        Returns string

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

    Parameters

    • v: function
        • (obj: any): string
        • Parameters

          • obj: any

          Returns string

    Returns void

i

  • get i(): RingSeriesBase
  • Returns RingSeriesBase

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

labelExtent

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

    Returns number

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

    Parameters

    • v: number

    Returns void

labelInnerColor

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

    Returns string

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

    Parameters

    • v: string

    Returns void

labelMemberPath

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

    Returns string

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

    Parameters

    • v: string

    Returns void

labelOuterColor

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

    Returns string

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

    Parameters

    • v: string

    Returns void

labelsPosition

  • Gets or sets the position of chart labels.

    Returns LabelsPosition

  • Gets or sets the position of chart labels.

    Parameters

    Returns void

leaderLineFill

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

    Returns string

  • Gets or sets the fill brush.

    Parameters

    • v: string

    Returns void

leaderLineMargin

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

    Returns number

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

    Parameters

    • v: number

    Returns void

leaderLineOpacity

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

    Returns number

  • Gets or sets the opacity.

    Parameters

    • v: number

    Returns void

leaderLineStroke

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

    Returns string

  • Gets or sets the stroke brush.

    Parameters

    • v: string

    Returns void

leaderLineStrokeThickness

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

    Returns number

  • Gets or sets the stroke thickness.

    Parameters

    • v: number

    Returns void

leaderLineType

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

    Returns LeaderLineType

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

    Parameters

    Returns void

leaderLineVisibility

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

    Returns Visibility

  • Gets or sets whether the leader lines are visible.

    Parameters

    • v: Visibility

    Returns void

legend

  • get legend(): any
  • set legend(v: any): void
  • Returns any

  • Parameters

    • v: any

    Returns void

legendLabelMemberPath

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

    Returns string

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

    Parameters

    • v: string

    Returns void

othersCategoryFill

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

    Returns string

  • Gets or sets the fill brush.

    Parameters

    • v: string

    Returns void

othersCategoryOpacity

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

    Returns number

  • Gets or sets the opacity.

    Parameters

    • v: number

    Returns void

othersCategoryStroke

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

    Returns string

  • Gets or sets the stroke brush.

    Parameters

    • v: string

    Returns void

othersCategoryStrokeThickness

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

    Returns number

  • Gets or sets the stroke thickness.

    Parameters

    • v: number

    Returns void

othersCategoryText

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

    Returns string

  • Gets or sets the label of the Others slice.

    Parameters

    • v: string

    Returns void

othersCategoryThreshold

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

    Returns number

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

    Parameters

    • v: number

    Returns void

othersCategoryType

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

    Returns OthersCategoryType

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

    Parameters

    Returns void

outlines

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

    Returns string[]

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

    Parameters

    • v: string[]

    Returns void

propertyUpdated

  • get propertyUpdated(): function
  • set propertyUpdated(ev: function): void
  • Event raised when a property (including "effective" and non-dependency property) value changes.

    Returns function

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

    Parameters

    Returns void

radiusFactor

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

    Returns number

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

    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

showDefaultTooltip

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

    Returns boolean

  • Gets or sets whether default tooltip will be shown.

    Parameters

    • v: boolean

    Returns void

startAngle

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

    Returns number

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

    Parameters

    • v: number

    Returns void

tooltipContainerTemplate

  • get tooltipContainerTemplate(): React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>
  • set tooltipContainerTemplate(value: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>): void
  • Returns React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

  • Parameters

    • value: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

    Returns void

tooltipTemplate

  • get tooltipTemplate(): React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>
  • set tooltipTemplate(value: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>): void
  • Returns React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

  • Parameters

    • value: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

    Returns void

valueMemberPath

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

    Returns string

  • Gets or Sets the property name that contains the values.

    Parameters

    • v: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<__type>, nextContext: any): void

bindData

  • bindData(): void
  • Returns 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<P>, prevState: Readonly<__type>, 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

    • prevProps: Readonly<P>
    • prevState: Readonly<__type>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): 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

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<__type>, nextContext: any): void

ensureLeaderLineStyle

  • ensureLeaderLineStyle(): void
  • Returns void

ensureOthersCategoryStyle

  • ensureOthersCategoryStyle(): void
  • Returns void

ensureSelectedStyle

  • ensureSelectedStyle(): void
  • Returns void

forceUpdate

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

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

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<__type>): SS | null
  • 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<__type>

    Returns SS | null

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

setState

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

    • K: keyof __type

    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

sychronizeCollections

  • sychronizeCollections(): void
  • Returns void

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgrRingSeriesBase