IgxPieChartBaseComponent

Represents the base class for the pie chart.

Constructors

new IgxPieChartBaseComponent(): IgxPieChartBaseComponent

Returns IgxPieChartBaseComponent

Properties

ngAcceptInputType_actualBrushes

ngAcceptInputType_actualBrushes: string | string[]

ngAcceptInputType_actualOutlines

ngAcceptInputType_actualOutlines: string | string[]

ngAcceptInputType_actualPixelScalingRatio

ngAcceptInputType_actualPixelScalingRatio: string | number

ngAcceptInputType_allowSliceExplosion

ngAcceptInputType_allowSliceExplosion: string | boolean

ngAcceptInputType_allowSliceSelection

ngAcceptInputType_allowSliceSelection: string | boolean

ngAcceptInputType_brushes

ngAcceptInputType_brushes: string | string[]

ngAcceptInputType_explodedRadius

ngAcceptInputType_explodedRadius: string | number

ngAcceptInputType_explodedSlices

ngAcceptInputType_explodedSlices: string | IgxIndexCollection

ngAcceptInputType_innerExtent

ngAcceptInputType_innerExtent: string | number

ngAcceptInputType_isDragInteractionEnabled

ngAcceptInputType_isDragInteractionEnabled: string | boolean

ngAcceptInputType_isSurfaceInteractionDisabled

ngAcceptInputType_isSurfaceInteractionDisabled: string | boolean

ngAcceptInputType_labelExtent

ngAcceptInputType_labelExtent: string | number

ngAcceptInputType_labelFormatSpecifiers

ngAcceptInputType_labelFormatSpecifiers: string | any[]

ngAcceptInputType_labelsPosition

ngAcceptInputType_labelsPosition: string | LabelsPosition

ngAcceptInputType_leaderLineMargin

ngAcceptInputType_leaderLineMargin: string | number

ngAcceptInputType_leaderLineType

ngAcceptInputType_leaderLineType: string | LeaderLineType

ngAcceptInputType_leaderLineVisibility

ngAcceptInputType_leaderLineVisibility: any

ngAcceptInputType_legendEmptyValuesMode

ngAcceptInputType_legendEmptyValuesMode: any

ngAcceptInputType_legendLabelFormatSpecifiers

ngAcceptInputType_legendLabelFormatSpecifiers: string | any[]

ngAcceptInputType_legendOthersLabelFormatSpecifiers

ngAcceptInputType_legendOthersLabelFormatSpecifiers: string | any[]

ngAcceptInputType_othersCategoryOpacity

ngAcceptInputType_othersCategoryOpacity: string | number

ngAcceptInputType_othersCategoryStrokeThickness

ngAcceptInputType_othersCategoryStrokeThickness: string | number

ngAcceptInputType_othersCategoryThreshold

ngAcceptInputType_othersCategoryThreshold: string | number

ngAcceptInputType_othersCategoryType

ngAcceptInputType_othersCategoryType: any

ngAcceptInputType_othersLabelFormatSpecifiers

ngAcceptInputType_othersLabelFormatSpecifiers: string | any[]

ngAcceptInputType_outlines

ngAcceptInputType_outlines: string | string[]

ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

ngAcceptInputType_radiusFactor

ngAcceptInputType_radiusFactor: string | number

ngAcceptInputType_selectedItems

ngAcceptInputType_selectedItems: any

ngAcceptInputType_selectedSliceOpacity

ngAcceptInputType_selectedSliceOpacity: string | number

ngAcceptInputType_selectedSliceStrokeThickness

ngAcceptInputType_selectedSliceStrokeThickness: string | number

ngAcceptInputType_selectionMode

ngAcceptInputType_selectionMode: string | SliceSelectionMode

ngAcceptInputType_shouldDisplayMockData

ngAcceptInputType_shouldDisplayMockData: string | boolean

ngAcceptInputType_shouldUseSkeletonStyleForMockData

ngAcceptInputType_shouldUseSkeletonStyleForMockData: string | boolean

ngAcceptInputType_startAngle

ngAcceptInputType_startAngle: string | number

ngAcceptInputType_sweepDirection

ngAcceptInputType_sweepDirection: any

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxPieChartBaseComponent, "ng-component", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxPieChartBaseComponent, never>

Accessors

actualBrushes

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

get actualBrushes(): string[]

Returns string[]

set actualBrushes(v: string[]): void

Parameters

v: string[]

Returns void

actualLabelInnerColor

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

get actualLabelInnerColor(): string

Returns string

set actualLabelInnerColor(v: string): void

Parameters

v: string

Returns void

actualLabelOuterColor

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

get actualLabelOuterColor(): string

Returns string

set actualLabelOuterColor(v: string): void

Parameters

v: string

Returns void

actualLegendItemBadgeTemplate

Gets the actual legend item badge template used by the pie chart.

get actualLegendItemBadgeTemplate(): IgDataTemplate

Returns IgDataTemplate

set actualLegendItemBadgeTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

actualOutlines

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

get actualOutlines(): string[]

Returns string[]

set actualOutlines(v: string[]): void

Parameters

v: string[]

Returns void

actualPixelScalingRatio

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.

get actualPixelScalingRatio(): number

Returns number

set actualPixelScalingRatio(v: number): void

Parameters

v: number

Returns void

allowSliceExplosion

Gets or sets whether the slices can be exploded.

get allowSliceExplosion(): boolean

Returns boolean

set allowSliceExplosion(v: boolean): void

Parameters

v: boolean

Returns void

allowSliceSelection

Gets or sets whether the slices can be selected.

get allowSliceSelection(): boolean

Returns boolean

set allowSliceSelection(v: boolean): void

Parameters

v: boolean

Returns void

brushes

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

get brushes(): string[]

Returns string[]

set brushes(v: string[]): void

Parameters

v: string[]

Returns void

explodedRadius

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

get explodedRadius(): number

Returns number

set explodedRadius(v: number): void

Parameters

v: number

Returns void

explodedSlices

Gets or sets the collection of exploded slice indices.

get explodedSlices(): IgxIndexCollection

Returns IgxIndexCollection

set explodedSlices(v: IgxIndexCollection): void

Parameters

v: IgxIndexCollection

Returns void

formatLabel

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

get formatLabel(): object

Returns object

set formatLabel(v: object): void

Parameters

v: object

Returns void

formatLegendLabel

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

get formatLegendLabel(): object

Returns object

set formatLegendLabel(v: object): void

Parameters

v: object

Returns void

innerExtent

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.

get innerExtent(): number

Returns number

set innerExtent(v: number): void

Parameters

v: number

Returns void

isDragInteractionEnabled

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

get isDragInteractionEnabled(): boolean

Returns boolean

set isDragInteractionEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isSurfaceInteractionDisabled

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

get isSurfaceInteractionDisabled(): boolean

Returns boolean

set isSurfaceInteractionDisabled(v: boolean): void

Parameters

v: boolean

Returns void

labelClick

Raised when the slice's label is clicked.

get labelClick(): EventEmitter<object>

Returns EventEmitter<object>

labelExtent

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

get labelExtent(): number

Returns number

set labelExtent(v: number): void

Parameters

v: number

Returns void

labelFormat

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

get labelFormat(): string

Returns string

set labelFormat(v: string): void

Parameters

v: string

Returns void

labelFormatSpecifiers

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

get labelFormatSpecifiers(): any[]

Returns any[]

set labelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

labelInnerColor

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

get labelInnerColor(): string

Returns string

set labelInnerColor(v: string): void

Parameters

v: string

Returns void

labelMemberPath

Gets or sets the property name that contains the labels.

get labelMemberPath(): string

Returns string

set labelMemberPath(v: string): void

Parameters

v: string

Returns void

labelOuterColor

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

get labelOuterColor(): string

Returns string

set labelOuterColor(v: string): void

Parameters

v: string

Returns void

labelsPosition

Gets or sets the position of chart labels.

get labelsPosition(): LabelsPosition

Returns LabelsPosition

set labelsPosition(v: LabelsPosition): void

Parameters

v: LabelsPosition

Returns void

leaderLineMargin

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

get leaderLineMargin(): number

Returns number

set leaderLineMargin(v: number): void

Parameters

v: number

Returns void

leaderLineType

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

get leaderLineType(): LeaderLineType

Returns LeaderLineType

set leaderLineType(v: LeaderLineType): void

Parameters

v: LeaderLineType

Returns void

leaderLineVisibility

Gets or sets whether the leader lines are visible.

get leaderLineVisibility(): Visibility

Returns Visibility

set leaderLineVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

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.

get legendEmptyValuesMode(): LegendEmptyValuesMode

Returns LegendEmptyValuesMode

set legendEmptyValuesMode(v: LegendEmptyValuesMode): void

Parameters

v: LegendEmptyValuesMode

Returns void

legendItemBadgeTemplate

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

get legendItemBadgeTemplate(): IgDataTemplate

Returns IgDataTemplate

set legendItemBadgeTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

legendItemTemplate

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

get legendItemTemplate(): IgDataTemplate

Returns IgDataTemplate

set legendItemTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

legendLabelFormat

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

get legendLabelFormat(): string

Returns string

set legendLabelFormat(v: string): void

Parameters

v: string

Returns void

legendLabelFormatSpecifiers

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

get legendLabelFormatSpecifiers(): any[]

Returns any[]

set legendLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

legendLabelMemberPath

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

get legendLabelMemberPath(): string

Returns string

set legendLabelMemberPath(v: string): void

Parameters

v: string

Returns void

legendOthersLabelFormat

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

get legendOthersLabelFormat(): string

Returns string

set legendOthersLabelFormat(v: string): void

Parameters

v: string

Returns void

legendOthersLabelFormatSpecifiers

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

get legendOthersLabelFormatSpecifiers(): any[]

Returns any[]

set legendOthersLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

othersCategoryFill

Gets or sets the fill brush.

get othersCategoryFill(): string

Returns string

set othersCategoryFill(v: string): void

Parameters

v: string

Returns void

othersCategoryOpacity

Gets or sets the opacity.

get othersCategoryOpacity(): number

Returns number

set othersCategoryOpacity(v: number): void

Parameters

v: number

Returns void

othersCategoryStroke

Gets or sets the stroke brush.

get othersCategoryStroke(): string

Returns string

set othersCategoryStroke(v: string): void

Parameters

v: string

Returns void

othersCategoryStrokeThickness

Gets or sets the stroke thickness.

get othersCategoryStrokeThickness(): number

Returns number

set othersCategoryStrokeThickness(v: number): void

Parameters

v: number

Returns void

othersCategoryText

Gets or sets the label of the Others slice.

get othersCategoryText(): string

Returns string

set othersCategoryText(v: string): void

Parameters

v: string

Returns void

othersCategoryThreshold

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

get othersCategoryThreshold(): number

Returns number

set othersCategoryThreshold(v: number): void

Parameters

v: number

Returns void

othersCategoryType

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

get othersCategoryType(): OthersCategoryType

Returns OthersCategoryType

set othersCategoryType(v: OthersCategoryType): void

Parameters

v: OthersCategoryType

Returns void

othersLabelFormat

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

get othersLabelFormat(): string

Returns string

set othersLabelFormat(v: string): void

Parameters

v: string

Returns void

othersLabelFormatSpecifiers

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

get othersLabelFormatSpecifiers(): any[]

Returns any[]

set othersLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

outlines

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

get outlines(): string[]

Returns string[]

set outlines(v: string[]): void

Parameters

v: string[]

Returns void

pixelScalingRatio

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.

get pixelScalingRatio(): number

Returns number

set pixelScalingRatio(v: number): void

Parameters

v: number

Returns void

radiusFactor

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

get radiusFactor(): number

Returns number

set radiusFactor(v: number): void

Parameters

v: number

Returns void

selectedItem

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.

get selectedItem(): any

Returns any

set selectedItem(v: any): void

Parameters

v: any

Returns void

selectedItemChanged

Raised when the SelectedItem property has changed.

get selectedItemChanged(): EventEmitter<object>

Returns EventEmitter<object>

selectedItemChanging

Raised when the SelectedItem property is changing. This event is cancelable.

get selectedItemChanging(): EventEmitter<object>

Returns EventEmitter<object>

selectedItems

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

get selectedItems(): IgxObjectCollection

Returns IgxObjectCollection

set selectedItems(v: IgxObjectCollection): void

Parameters

v: IgxObjectCollection

Returns void

selectedItemsChanged

Raised when the SelectedItems collection has changed.

get selectedItemsChanged(): EventEmitter<object>

Returns EventEmitter<object>

selectedItemsChanging

Raised when the SelectedItems collection is changing. This event is cancelable.

get selectedItemsChanging(): EventEmitter<object>

Returns EventEmitter<object>

selectedSliceFill

Gets or sets the fill brush.

get selectedSliceFill(): string

Returns string

set selectedSliceFill(v: string): void

Parameters

v: string

Returns void

selectedSliceOpacity

Gets or sets the opacity.

get selectedSliceOpacity(): number

Returns number

set selectedSliceOpacity(v: number): void

Parameters

v: number

Returns void

selectedSliceStroke

Gets or sets the stroke brush.

get selectedSliceStroke(): string

Returns string

set selectedSliceStroke(v: string): void

Parameters

v: string

Returns void

selectedSliceStrokeThickness

Gets or sets the stroke thickness.

get selectedSliceStrokeThickness(): number

Returns number

set selectedSliceStrokeThickness(v: number): void

Parameters

v: number

Returns void

selectionMode

Gets or sets which mode to use for selecting slices.

get selectionMode(): SliceSelectionMode

Returns SliceSelectionMode

set selectionMode(v: SliceSelectionMode): void

Parameters

v: SliceSelectionMode

Returns void

shouldDisplayMockData

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

get shouldDisplayMockData(): boolean

Returns boolean

set shouldDisplayMockData(v: boolean): void

Parameters

v: boolean

Returns void

shouldUseSkeletonStyleForMockData

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

get shouldUseSkeletonStyleForMockData(): boolean

Returns boolean

set shouldUseSkeletonStyleForMockData(v: boolean): void

Parameters

v: boolean

Returns void

sliceClick

Raised when the slice is clicked.

get sliceClick(): EventEmitter<object>

Returns EventEmitter<object>

sliceEnter

Raised when a slice is entered by the pointer.

get sliceEnter(): EventEmitter<object>

Returns EventEmitter<object>

sliceHover

Raised when a pointer moves over a slice.

get sliceHover(): EventEmitter<object>

Returns EventEmitter<object>

sliceLeave

Raised when a slice is left by the pointer;

get sliceLeave(): EventEmitter<object>

Returns EventEmitter<object>

startAngle

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

get startAngle(): number

Returns number

set startAngle(v: number): void

Parameters

v: number

Returns void

sweepDirection

Gets or sets the rotational direction of the chart.

get sweepDirection(): SweepDirection

Returns SweepDirection

set sweepDirection(v: SweepDirection): void

Parameters

v: SweepDirection

Returns void

textStyle

Manually overrides the style to use for the labels.

get textStyle(): string

Returns string

set textStyle(v: string): void

Parameters

v: string

Returns void

Gets or sets the ToolTip for the chart.

get toolTip(): any

Returns any

set toolTip(v: any): void

Parameters

v: any

Returns void

valueMemberPath

Gets or Sets the property name that contains the values.

get valueMemberPath(): string

Returns string

set valueMemberPath(v: string): void

Parameters

v: string

Returns void

Methods

destroy

Invoked when the instance is being destroyed.

destroy(): void

Returns void

ensureOthersCategoryStyle

ensureOthersCategoryStyle(): void

Returns void

ensureSelectedStyle

ensureSelectedStyle(): void

Returns void

exportSerializedVisualData

Returns the chart visuals expressed as a serialized string.

exportSerializedVisualData(): string

Returns string

findByName

findByName(name: string): any

Parameters

name: string

Returns any

flush

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.

flush(): void

Returns void

ngOnInit

ngOnInit(): void

Returns void

notifyClearItems

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.

notifyClearItems(source_: any): void

Parameters

source_: any
- The data source.

Returns void

notifyContainerResized

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

notifyContainerResized(): void

Returns void

notifyInsertItem

notifyInsertItem(source_: any, index: number, newItem: any): void

Parameters

source_: any
index: number
newItem: any

Returns void

notifyRemoveItem

notifyRemoveItem(source_: any, index: number, oldItem: any): void

Parameters

source_: any
index: number
oldItem: any

Returns void

notifySetItem

notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void

Parameters

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

Returns void

provideContainer

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

provideContainer(container: any): void

Parameters

container: any
- Reference to the container.

Returns void

removeWidgetLevelDataSource

Resets items data source.

removeWidgetLevelDataSource(): void

Returns void

setWidgetLevelDataSource

Assigns data source for the items.

setWidgetLevelDataSource(source_: any): void

Parameters

source_: any
- Array of the data source items.

Returns void

simulateLeftClick

Simulates a mouse click action at the specified point.

simulateLeftClick(point: IgPoint): void

Parameters

point: IgPoint
- The point to click at.

Returns void

styleUpdated

Invoked when style is updated.

styleUpdated(): void

Returns void

_createFromInternal

_createFromInternal(internal: any): IgxPieChartBaseComponent

Parameters

internal: any