Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrPieChartBaseProps

Hierarchy

Hierarchy

Properties

Properties

Optional actualBrushes

actualBrushes?: string | string[]

Gets the actual palette of brushes to use for coloring the slices.

Optional actualLabelInnerColor

actualLabelInnerColor?: string

Gets the actual color for labels rendered inside of the pie chart.

Optional actualLabelOuterColor

actualLabelOuterColor?: string

Gets the actual color for labels rendered outside of the pie chart.

Optional actualOutlines

actualOutlines?: string | string[]

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

Optional actualPixelScalingRatio

actualPixelScalingRatio?: string | number

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

Optional allowSliceExplosion

allowSliceExplosion?: string | boolean

Gets or sets whether the slices can be exploded.

Optional allowSliceSelection

allowSliceSelection?: string | boolean

Gets or sets whether the slices can be selected.

Optional brushes

brushes?: string | string[]

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

Optional children

children?: ReactNode

Optional explodedRadius

explodedRadius?: string | number

Determines how much the exploded slice is offset from the center. Value between 0 and 1.

Optional explodedSlices

explodedSlices?: string | IgrIndexCollection

Gets or sets the collection of exploded slice indices.

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 innerExtent

innerExtent?: string | number

Gets or sets the amount of space between the center and the start of the arc. This property should be set between 0 and 1. If InnerExtent is set to a value greater than 1, it will be interpreted as a percentage, effectively divided by 100.

Optional isDragInteractionEnabled

isDragInteractionEnabled?: string | boolean

Gets or sets whether the pie chart will handle drag interaction and make them avaiilable in its events.

Optional isSurfaceInteractionDisabled

isSurfaceInteractionDisabled?: string | boolean

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

Optional labelClick

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

Type declaration

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 leaderLineMargin

leaderLineMargin?: string | number

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

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 legendEmptyValuesMode

legendEmptyValuesMode?: string | LegendEmptyValuesMode

Determines display mode for zero values in the legend. For example, handling zero values as valid slices and providing them with proper appearance settings.

Optional legendItemBadgeTemplate

legendItemBadgeTemplate?: IgDataTemplate

Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the chart object itself.

Optional legendItemTemplate

legendItemTemplate?: IgDataTemplate

Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the chart object itself.

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.

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 pixelScalingRatio

pixelScalingRatio?: string | 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.

Optional radiusFactor

radiusFactor?: string | number

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

Optional selectedItem

selectedItem?: any

Gets or sets the currently selected data item. If a different data item is provided the pie chart will select the slice associated with the new item.

Optional selectedItemChanged

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

Type declaration

Optional selectedItemChanging

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

Type declaration

Optional selectedItems

selectedItems?: string | IgrObjectCollection

Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the slices associated with those items.

Optional selectedItemsChanged

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

Type declaration

Optional selectedItemsChanging

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

Type declaration

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 selectionMode

selectionMode?: string | SliceSelectionMode

Gets or sets which mode to use for selecting slices.

Optional shouldDisplayMockData

shouldDisplayMockData?: string | boolean

Gets or sets whether the pie chart should display mock data when data isn't present.

Optional shouldUseSkeletonStyleForMockData

shouldUseSkeletonStyleForMockData?: string | boolean

Gets or sets whether the pie chart should use a skeleton style for mock data.

Optional sliceClick

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

Type declaration

Optional sliceEnter

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

Type declaration

Optional sliceHover

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

Type declaration

Optional sliceLeave

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

Type declaration

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 sweepDirection

sweepDirection?: string | SweepDirection

Gets or sets the rotational direction of the chart.

Optional textStyle

textStyle?: string

Manually overrides the style to use for the labels.

Optional toolTip

toolTip?: any

Gets or sets the ToolTip for the chart.

Optional valueMemberPath

valueMemberPath?: string

Gets or Sets the property name that contains the values.