Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrRingSeriesProps

Hierarchy

Hierarchy

Properties

Properties

Optional brushes

brushes?: string | string[]

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

Optional children

children?: ReactNode

Optional dataSource

dataSource?: any[]

Optional explodedSlices

explodedSlices?: IgrIndexCollection

Optional formatLabel

formatLabel?: ((obj) => string)

Type declaration

    • (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

Optional formatLegendLabel

formatLegendLabel?: ((obj) => string)

Type declaration

    • (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

Optional isSurfaceInteractionDisabled

isSurfaceInteractionDisabled?: string | boolean

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

Optional labelExtent

labelExtent?: string | number

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

Optional labelFormat

labelFormat?: string

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

Optional labelFormatSpecifiers

labelFormatSpecifiers?: any[]

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

Optional labelInnerColor

labelInnerColor?: string

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

Optional labelMemberPath

labelMemberPath?: string

Gets or sets the property name that contains the labels.

Optional labelOuterColor

labelOuterColor?: string

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

Optional labelsPosition

labelsPosition?: string | LabelsPosition

Gets or sets the position of chart labels.

Optional leaderLineFill

leaderLineFill?: string

Gets or sets the fill brush.

Optional leaderLineMargin

leaderLineMargin?: string | number

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

Optional leaderLineOpacity

leaderLineOpacity?: string | number

Gets or sets the opacity.

Optional leaderLineStroke

leaderLineStroke?: string

Gets or sets the stroke brush.

Optional leaderLineStrokeThickness

leaderLineStrokeThickness?: string | number

Gets or sets the stroke thickness.

Optional leaderLineType

leaderLineType?: string | LeaderLineType

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

Optional leaderLineVisibility

leaderLineVisibility?: string | Visibility

Gets or sets whether the leader lines are visible.

Optional legend

legend?: any

Optional legendLabelFormat

legendLabelFormat?: string

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

Optional legendLabelFormatSpecifiers

legendLabelFormatSpecifiers?: any[]

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

Optional legendLabelMemberPath

legendLabelMemberPath?: string

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

Optional legendOthersLabelFormat

legendOthersLabelFormat?: string

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

Optional legendOthersLabelFormatSpecifiers

legendOthersLabelFormatSpecifiers?: any[]

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

name

name: string

Sets or gets a required unique name for the series.

Optional othersCategoryFill

othersCategoryFill?: string

Gets or sets the fill brush.

Optional othersCategoryOpacity

othersCategoryOpacity?: string | number

Gets or sets the opacity.

Optional othersCategoryStroke

othersCategoryStroke?: string

Gets or sets the stroke brush.

Optional othersCategoryStrokeThickness

othersCategoryStrokeThickness?: string | number

Gets or sets the stroke thickness.

Optional othersCategoryText

othersCategoryText?: string

Gets or sets the label of the Others slice.

Optional othersCategoryThreshold

othersCategoryThreshold?: string | number

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

Optional othersCategoryType

othersCategoryType?: string | OthersCategoryType

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

Optional othersLabelFormat

othersLabelFormat?: string

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

Optional othersLabelFormatSpecifiers

othersLabelFormatSpecifiers?: any[]

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

Optional outlines

outlines?: string | string[]

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

Optional propertyUpdated

propertyUpdated?: ((s, e) => void)

Type declaration

    • (s, e): void

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

      Parameters

      Returns void

Optional radiusFactor

radiusFactor?: string | number

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

Optional ring

ring?: IgrRing

Gets reference to the ring data.

Optional selectedSliceFill

selectedSliceFill?: string

Gets or sets the fill brush.

Optional selectedSliceOpacity

selectedSliceOpacity?: string | number

Gets or sets the opacity.

Optional selectedSliceStroke

selectedSliceStroke?: string

Gets or sets the stroke brush.

Optional selectedSliceStrokeThickness

selectedSliceStrokeThickness?: string | number

Gets or sets the stroke thickness.

Optional selectedSlices

selectedSlices?: IgrIndexCollection

Optional showDefaultTooltip

showDefaultTooltip?: boolean

Optional startAngle

startAngle?: string | number

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

Optional tooltipContainerTemplate

tooltipContainerTemplate?: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

Optional tooltipTemplate

tooltipTemplate?: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

Optional valueMemberPath

valueMemberPath?: string

Gets or Sets the property name that contains the values.