Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxPieChartBaseComponent

Represents the base class for the pie chart.

Hierarchy

Hierarchy

Implements

  • OnInit

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_actualBrushes

ngAcceptInputType_actualBrushes: string | string[]

Static ngAcceptInputType_actualOutlines

ngAcceptInputType_actualOutlines: string | string[]

Static ngAcceptInputType_actualPixelScalingRatio

ngAcceptInputType_actualPixelScalingRatio: string | number

Static ngAcceptInputType_allowSliceExplosion

ngAcceptInputType_allowSliceExplosion: string | boolean

Static ngAcceptInputType_allowSliceSelection

ngAcceptInputType_allowSliceSelection: string | boolean

Static ngAcceptInputType_brushes

ngAcceptInputType_brushes: string | string[]

Static ngAcceptInputType_explodedRadius

ngAcceptInputType_explodedRadius: string | number

Static ngAcceptInputType_explodedSlices

ngAcceptInputType_explodedSlices: string | IgxIndexCollection

Static ngAcceptInputType_innerExtent

ngAcceptInputType_innerExtent: string | number

Static ngAcceptInputType_isDragInteractionEnabled

ngAcceptInputType_isDragInteractionEnabled: string | boolean

Static ngAcceptInputType_isSurfaceInteractionDisabled

ngAcceptInputType_isSurfaceInteractionDisabled: string | boolean

Static ngAcceptInputType_labelExtent

ngAcceptInputType_labelExtent: string | number

Static ngAcceptInputType_labelFormatSpecifiers

ngAcceptInputType_labelFormatSpecifiers: string | any[]

Static ngAcceptInputType_labelsPosition

ngAcceptInputType_labelsPosition: string | LabelsPosition

Static ngAcceptInputType_leaderLineMargin

ngAcceptInputType_leaderLineMargin: string | number

Static ngAcceptInputType_leaderLineType

ngAcceptInputType_leaderLineType: string | LeaderLineType

Static ngAcceptInputType_leaderLineVisibility

ngAcceptInputType_leaderLineVisibility: string | Visibility

Static ngAcceptInputType_legendEmptyValuesMode

ngAcceptInputType_legendEmptyValuesMode: string | LegendEmptyValuesMode

Static ngAcceptInputType_legendLabelFormatSpecifiers

ngAcceptInputType_legendLabelFormatSpecifiers: string | any[]

Static ngAcceptInputType_legendOthersLabelFormatSpecifiers

ngAcceptInputType_legendOthersLabelFormatSpecifiers: string | any[]

Static ngAcceptInputType_othersCategoryOpacity

ngAcceptInputType_othersCategoryOpacity: string | number

Static ngAcceptInputType_othersCategoryStrokeThickness

ngAcceptInputType_othersCategoryStrokeThickness: string | number

Static ngAcceptInputType_othersCategoryThreshold

ngAcceptInputType_othersCategoryThreshold: string | number

Static ngAcceptInputType_othersCategoryType

ngAcceptInputType_othersCategoryType: string | OthersCategoryType

Static ngAcceptInputType_othersLabelFormatSpecifiers

ngAcceptInputType_othersLabelFormatSpecifiers: string | any[]

Static ngAcceptInputType_outlines

ngAcceptInputType_outlines: string | string[]

Static ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

Static ngAcceptInputType_radiusFactor

ngAcceptInputType_radiusFactor: string | number

Static ngAcceptInputType_selectedItems

ngAcceptInputType_selectedItems: string | IgxObjectCollection

Static ngAcceptInputType_selectedSliceOpacity

ngAcceptInputType_selectedSliceOpacity: string | number

Static ngAcceptInputType_selectedSliceStrokeThickness

ngAcceptInputType_selectedSliceStrokeThickness: string | number

Static ngAcceptInputType_selectionMode

ngAcceptInputType_selectionMode: string | SliceSelectionMode

Static ngAcceptInputType_shouldDisplayMockData

ngAcceptInputType_shouldDisplayMockData: string | boolean

Static ngAcceptInputType_shouldUseSkeletonStyleForMockData

ngAcceptInputType_shouldUseSkeletonStyleForMockData: string | boolean

Static ngAcceptInputType_startAngle

ngAcceptInputType_startAngle: string | number

Static ngAcceptInputType_sweepDirection

ngAcceptInputType_sweepDirection: string | SweepDirection

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

actualBrushes

  • 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

actualLabelInnerColor

  • 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

actualLabelOuterColor

  • 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

actualOutlines

  • 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

actualPixelScalingRatio

  • 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

allowSliceExplosion

  • get allowSliceExplosion(): boolean

  • Gets or sets whether the slices can be exploded.

    Returns boolean

  • set allowSliceExplosion(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

allowSliceSelection

  • get allowSliceSelection(): boolean

  • Gets or sets whether the slices can be selected.

    Returns boolean

  • set allowSliceSelection(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

brushes

  • 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

explodedRadius

  • 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

explodedSlices

  • get explodedSlices(): IgxIndexCollection

  • Gets or sets the collection of exploded slice indices.

    Returns IgxIndexCollection

  • set explodedSlices(v: IgxIndexCollection): void

  • Parameters

    Returns void

formatLabel

  • 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

formatLegendLabel

  • 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

innerExtent

  • 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

isDragInteractionEnabled

  • 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

isSurfaceInteractionDisabled

  • 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

labelClick

  • get labelClick(): EventEmitter<{
        args: IgxLabelClickEventArgs;
        sender: any;
    }>

  • Raised when the slice's label is clicked.

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

labelExtent

  • 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

labelFormat

  • 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

labelFormatSpecifiers

  • 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

labelInnerColor

  • 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

labelMemberPath

  • 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

labelOuterColor

  • 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

labelsPosition

  • get labelsPosition(): LabelsPosition

  • Gets or sets the position of chart labels.

    Returns LabelsPosition

  • set labelsPosition(v: LabelsPosition): void

  • Parameters

    Returns void

leaderLineMargin

  • 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

leaderLineType

  • 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

leaderLineVisibility

  • get leaderLineVisibility(): Visibility

  • Gets or sets whether the leader lines are visible.

    Returns Visibility

  • set leaderLineVisibility(v: Visibility): void

  • Parameters

    Returns void

legendEmptyValuesMode

  • 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

legendItemBadgeTemplate

  • 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

legendItemTemplate

  • 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

legendLabelFormat

  • 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

legendLabelFormatSpecifiers

  • 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

legendLabelMemberPath

  • 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

legendOthersLabelFormat

  • 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

legendOthersLabelFormatSpecifiers

  • 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

othersCategoryFill

  • get othersCategoryFill(): string

  • Gets or sets the fill brush.

    Returns string

  • set othersCategoryFill(v: string): void

  • Parameters

    • v: string

    Returns void

othersCategoryOpacity

  • get othersCategoryOpacity(): number

  • Gets or sets the opacity.

    Returns number

  • set othersCategoryOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

othersCategoryStroke

  • get othersCategoryStroke(): string

  • Gets or sets the stroke brush.

    Returns string

  • set othersCategoryStroke(v: string): void

  • Parameters

    • v: string

    Returns void

othersCategoryStrokeThickness

  • get othersCategoryStrokeThickness(): number

  • Gets or sets the stroke thickness.

    Returns number

  • set othersCategoryStrokeThickness(v: number): void

  • Parameters

    • v: number

    Returns void

othersCategoryText

  • get othersCategoryText(): string

  • Gets or sets the label of the Others slice.

    Returns string

  • set othersCategoryText(v: string): void

  • Parameters

    • v: string

    Returns void

othersCategoryThreshold

  • 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

othersCategoryType

  • 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

othersLabelFormat

  • 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

othersLabelFormatSpecifiers

  • 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

outlines

  • 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

pixelScalingRatio

  • 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

radiusFactor

  • 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

selectedItem

  • 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

selectedItemChanged

  • get selectedItemChanged(): EventEmitter<{
        args: IgxSelectedItemChangedEventArgs;
        sender: any;
    }>

  • Raised when the SelectedItem property has changed.

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

selectedItemChanging

  • get selectedItemChanging(): EventEmitter<{
        args: IgxSelectedItemChangingEventArgs;
        sender: any;
    }>

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

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

selectedItems

  • 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

selectedItemsChanged

  • get selectedItemsChanged(): EventEmitter<{
        args: IgxSelectedItemsChangedEventArgs;
        sender: any;
    }>

  • Raised when the SelectedItems collection has changed.

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

selectedItemsChanging

  • get selectedItemsChanging(): EventEmitter<{
        args: IgxSelectedItemsChangingEventArgs;
        sender: any;
    }>

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

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

selectedSliceFill

  • get selectedSliceFill(): string

  • Gets or sets the fill brush.

    Returns string

  • set selectedSliceFill(v: string): void

  • Parameters

    • v: string

    Returns void

selectedSliceOpacity

  • get selectedSliceOpacity(): number

  • Gets or sets the opacity.

    Returns number

  • set selectedSliceOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

selectedSliceStroke

  • get selectedSliceStroke(): string

  • Gets or sets the stroke brush.

    Returns string

  • set selectedSliceStroke(v: string): void

  • Parameters

    • v: string

    Returns void

selectedSliceStrokeThickness

  • get selectedSliceStrokeThickness(): number

  • Gets or sets the stroke thickness.

    Returns number

  • set selectedSliceStrokeThickness(v: number): void

  • Parameters

    • v: number

    Returns void

selectionMode

  • get selectionMode(): SliceSelectionMode

  • Gets or sets which mode to use for selecting slices.

    Returns SliceSelectionMode

  • set selectionMode(v: SliceSelectionMode): void

  • Parameters

    Returns void

shouldDisplayMockData

  • 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

shouldUseSkeletonStyleForMockData

  • 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

sliceClick

  • get sliceClick(): EventEmitter<{
        args: IgxSliceClickEventArgs;
        sender: any;
    }>

  • Raised when the slice is clicked.

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

sliceEnter

  • get sliceEnter(): EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>

  • Raised when a slice is entered by the pointer.

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

sliceHover

  • get sliceHover(): EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>

  • Raised when a pointer moves over a slice.

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

sliceLeave

  • get sliceLeave(): EventEmitter<{
        args: IgxSliceEventArgs;
        sender: any;
    }>

  • Raised when a slice is left by the pointer;

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

startAngle

  • 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

sweepDirection

  • get sweepDirection(): SweepDirection

  • Gets or sets the rotational direction of the chart.

    Returns SweepDirection

  • set sweepDirection(v: SweepDirection): void

  • Parameters

    Returns void

textStyle

  • get textStyle(): string

  • Manually overrides the style to use for the labels.

    Returns string

  • set textStyle(v: string): void

  • Parameters

    • v: string

    Returns void

toolTip

  • get toolTip(): any

  • Gets or sets the ToolTip for the chart.

    Returns any

  • set toolTip(v: any): void

  • Parameters

    • v: any

    Returns void

valueMemberPath

  • 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

destroy

  • Invoked when the instance is being destroyed.

    Returns void

ensureOthersCategoryStyle

  • Returns void

ensureSelectedStyle

  • Returns void

exportSerializedVisualData

  • Returns the chart visuals expressed as a serialized string.

    Returns string

findByName

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

    Returns void

ngOnInit

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

    Parameters

    • source_: any
      • The data source.

    Returns void

notifyContainerResized

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

    Returns void

notifyInsertItem

  • Parameters

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

    Returns void

notifyRemoveItem

  • Parameters

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

    Returns void

notifySetItem

  • Parameters

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

    Returns void

provideContainer

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

    Parameters

    • container: any
      • Reference to the container.

    Returns void

removeWidgetLevelDataSource

  • Resets items data source.

    Returns void

setWidgetLevelDataSource

  • Assigns data source for the items.

    Parameters

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

    Returns void

simulateLeftClick

  • Simulates a mouse click action at the specified point.

    Parameters

    • point: IgPoint
      • The point to click at.

    Returns void

styleUpdated

  • Invoked when style is updated.

    Returns void

Static _createFromInternal