Represents the base class for the pie chart.

Hierarchy

Hierarchy

Implements

  • OnInit

Constructors

Properties

Accessors

Methods

Constructors

Properties

ngAcceptInputType_actualBrushes: string | string[]
ngAcceptInputType_actualOutlines: string | string[]
ngAcceptInputType_actualPixelScalingRatio: string | number
ngAcceptInputType_allowSliceExplosion: string | boolean
ngAcceptInputType_allowSliceSelection: string | boolean
ngAcceptInputType_brushes: string | string[]
ngAcceptInputType_explodedRadius: string | number
ngAcceptInputType_explodedSlices: string | IgxIndexCollection
ngAcceptInputType_innerExtent: string | number
ngAcceptInputType_isDragInteractionEnabled: string | boolean
ngAcceptInputType_isSurfaceInteractionDisabled: string | boolean
ngAcceptInputType_labelExtent: string | number
ngAcceptInputType_labelFormatSpecifiers: string | any[]
ngAcceptInputType_labelsPosition: string | LabelsPosition
ngAcceptInputType_leaderLineMargin: string | number
ngAcceptInputType_leaderLineType: string | LeaderLineType
ngAcceptInputType_leaderLineVisibility: string | Visibility
ngAcceptInputType_legendEmptyValuesMode: string | LegendEmptyValuesMode
ngAcceptInputType_legendLabelFormatSpecifiers: string | any[]
ngAcceptInputType_legendOthersLabelFormatSpecifiers: string | any[]
ngAcceptInputType_othersCategoryOpacity: string | number
ngAcceptInputType_othersCategoryStrokeThickness: string | number
ngAcceptInputType_othersCategoryThreshold: string | number
ngAcceptInputType_othersCategoryType: string | OthersCategoryType
ngAcceptInputType_othersLabelFormatSpecifiers: string | any[]
ngAcceptInputType_outlines: string | string[]
ngAcceptInputType_pixelScalingRatio: string | number
ngAcceptInputType_radiusFactor: string | number
ngAcceptInputType_selectedItems: string | IgxObjectCollection
ngAcceptInputType_selectedSliceOpacity: string | number
ngAcceptInputType_selectedSliceStrokeThickness: string | number
ngAcceptInputType_selectionMode: string | SliceSelectionMode
ngAcceptInputType_shouldDisplayMockData: string | boolean
ngAcceptInputType_shouldUseSkeletonStyleForMockData: string | boolean
ngAcceptInputType_startAngle: string | number
ngAcceptInputType_sweepDirection: string | SweepDirection
ɵcmp: unknown
ɵfac: unknown

Accessors

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

    Returns string[]

  • set actualBrushes(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get actualLabelInnerColor(): string
  • Gets the actual color for labels rendered inside of the pie chart.

    Returns string

  • set actualLabelInnerColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualLabelOuterColor(): string
  • Gets the actual color for labels rendered outside of the pie chart.

    Returns string

  • set actualLabelOuterColor(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string[]

  • set actualOutlines(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get actualPixelScalingRatio(): 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.

    Returns number

  • set actualPixelScalingRatio(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns boolean

  • set allowSliceExplosion(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns boolean

  • set allowSliceSelection(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns string[]

  • set brushes(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get explodedRadius(): number
  • Determines how much the exploded slice is offset from the center. Value between 0 and 1.

    Returns number

  • set explodedRadius(v: number): void
  • Parameters

    • v: number

    Returns void

  • get explodedSlices(): IgxIndexCollection
  • Gets or sets the collection of exploded slice indices.

    Returns IgxIndexCollection

  • set explodedSlices(v: IgxIndexCollection): void
  • Parameters

    Returns void

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

    Returns ((obj: any) => string)

      • (obj: any): 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: ((obj: any) => string)): void
  • Parameters

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

          • obj: any

          Returns string

    Returns void

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

    Returns ((obj: any) => string)

      • (obj: any): 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: ((obj: any) => string)): void
  • Parameters

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

          • obj: any

          Returns string

    Returns void

  • get innerExtent(): 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.

    Returns number

  • set innerExtent(v: number): void
  • Parameters

    • v: number

    Returns void

  • get isDragInteractionEnabled(): boolean
  • Gets or sets whether the pie chart will handle drag interaction and make them avaiilable in its events.

    Returns boolean

  • set isDragInteractionEnabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns boolean

  • set isSurfaceInteractionDisabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get labelClick(): EventEmitter<{
        args: IgxLabelClickEventArgs;
        sender: any;
    }>
  • Raised when the slice's label is clicked.

    Returns EventEmitter<{
        args: IgxLabelClickEventArgs;
        sender: any;
    }>

  • 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: number): 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: string): 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: any[]): 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: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns string

  • set labelMemberPath(v: string): 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: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns LabelsPosition

  • set labelsPosition(v: LabelsPosition): void
  • Parameters

    Returns void

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

    Returns number

  • set leaderLineMargin(v: number): 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: LeaderLineType): void
  • Parameters

    Returns void

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

    Returns Visibility

  • set leaderLineVisibility(v: Visibility): void
  • Parameters

    Returns void

  • get legendEmptyValuesMode(): 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.

    Returns LegendEmptyValuesMode

  • set legendEmptyValuesMode(v: LegendEmptyValuesMode): void
  • Parameters

    Returns void

  • get 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.

    Returns IgDataTemplate

  • set legendItemBadgeTemplate(v: IgDataTemplate): void
  • Parameters

    Returns void

  • get 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.

    Returns IgDataTemplate

  • set legendItemTemplate(v: IgDataTemplate): void
  • Parameters

    Returns void

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

    Returns string

  • set legendLabelFormat(v: string): 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: any[]): 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: string): 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: string): 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: any[]): void
  • Parameters

    • v: any[]

    Returns void

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

    Returns string

  • set othersCategoryFill(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set othersCategoryOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set othersCategoryStroke(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set othersCategoryStrokeThickness(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set othersCategoryText(v: string): 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: number): 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: OthersCategoryType): void
  • Parameters

    Returns void

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

    Returns string

  • set othersLabelFormat(v: string): 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: any[]): 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: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get pixelScalingRatio(): 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.

    Returns number

  • set pixelScalingRatio(v: number): void
  • Parameters

    • v: number

    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: number): void
  • Parameters

    • v: number

    Returns void

  • get 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.

    Returns any

  • set selectedItem(v: any): void
  • Parameters

    • v: any

    Returns void

  • get selectedItemChanged(): EventEmitter<{
        args: IgxSelectedItemChangedEventArgs;
        sender: any;
    }>
  • Raised when the SelectedItem property has changed.

    Returns EventEmitter<{
        args: IgxSelectedItemChangedEventArgs;
        sender: any;
    }>

  • get selectedItemChanging(): EventEmitter<{
        args: IgxSelectedItemChangingEventArgs;
        sender: any;
    }>
  • Raised when the SelectedItem property is changing. This event is cancelable.

    Returns EventEmitter<{
        args: IgxSelectedItemChangingEventArgs;
        sender: any;
    }>

  • get selectedItems(): IgxObjectCollection
  • Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the slices associated with those items.

    Returns IgxObjectCollection

  • set selectedItems(v: IgxObjectCollection): void
  • Parameters

    Returns void

  • get selectedItemsChanged(): EventEmitter<{
        args: IgxSelectedItemsChangedEventArgs;
        sender: any;
    }>
  • Raised when the SelectedItems collection has changed.

    Returns EventEmitter<{
        args: IgxSelectedItemsChangedEventArgs;
        sender: any;
    }>

  • get selectedItemsChanging(): EventEmitter<{
        args: IgxSelectedItemsChangingEventArgs;
        sender: any;
    }>
  • Raised when the SelectedItems collection is changing. This event is cancelable.

    Returns EventEmitter<{
        args: IgxSelectedItemsChangingEventArgs;
        sender: any;
    }>

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

    Returns string

  • set selectedSliceFill(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set selectedSliceOpacity(v: number): void
  • Parameters

    • v: number

    Returns void

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

    Returns string

  • set selectedSliceStroke(v: string): void
  • Parameters

    • v: string

    Returns void

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

    Returns number

  • set selectedSliceStrokeThickness(v: number): void
  • Parameters

    • v: number

    Returns void

  • get selectionMode(): SliceSelectionMode
  • Gets or sets which mode to use for selecting slices.

    Returns SliceSelectionMode

  • set selectionMode(v: SliceSelectionMode): void
  • Parameters

    Returns void

  • get shouldDisplayMockData(): boolean
  • Gets or sets whether the pie chart should display mock data when data isn't present.

    Returns boolean

  • set shouldDisplayMockData(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldUseSkeletonStyleForMockData(): boolean
  • Gets or sets whether the pie chart should use a skeleton style for mock data.

    Returns boolean

  • set shouldUseSkeletonStyleForMockData(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get sliceClick(): EventEmitter<{
        args: IgxSliceClickEventArgs;
        sender: any;
    }>
  • Raised when the slice is clicked.

    Returns EventEmitter<{
        args: IgxSliceClickEventArgs;
        sender: any;
    }>

  • get sliceEnter(): EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>
  • Raised when a slice is entered by the pointer.

    Returns EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>

  • get sliceHover(): EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>
  • Raised when a pointer moves over a slice.

    Returns EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>

  • get sliceLeave(): EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>
  • Raised when a slice is left by the pointer;

    Returns EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>

  • 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: number): void
  • Parameters

    • v: number

    Returns void

  • get sweepDirection(): SweepDirection
  • Gets or sets the rotational direction of the chart.

    Returns SweepDirection

  • set sweepDirection(v: SweepDirection): void
  • Parameters

    Returns void

  • get textStyle(): string
  • Manually overrides the style to use for the labels.

    Returns string

  • set textStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get toolTip(): any
  • Gets or sets the ToolTip for the chart.

    Returns any

  • set toolTip(v: any): void
  • Parameters

    • v: any

    Returns void

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

    Returns string

  • set valueMemberPath(v: string): void
  • Parameters

    • v: string

    Returns void

Methods

  • Invoked when the instance is being destroyed.

    Returns void

  • Returns void

  • Returns void

  • Returns the chart visuals expressed as a serialized string.

    Returns string

  • Parameters

    • name: string

    Returns any

  • Use to force the pie chart to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the pie chart needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the pie chart.

    Returns void

  • Returns void

  • Manually notifies the pie chart's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the pie chart is bound to is already observable.

    Parameters

    • source_: any
      • The data source.

    Returns void

  • Notification from the containing object that the container has been resized.

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Invoked by the containing object to provide reference to the container.

    Parameters

    • container: any
      • Reference to the container.

    Returns void

  • Resets items data source.

    Returns void

  • Assigns data source for the items.

    Parameters

    • source_: any
      • Array of the data source items.

    Returns void

  • Simulates a mouse click action at the specified point.

    Parameters

    • point: IgPoint
      • The point to click at.

    Returns void

  • Invoked when style is updated.

    Returns void