Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxRingSeriesComponent

Represents one ring in IgxDoughnutChartComponent series.

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_brushes

ngAcceptInputType_brushes: string | string[]

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_leaderLineOpacity

ngAcceptInputType_leaderLineOpacity: string | number

Static ngAcceptInputType_leaderLineStrokeThickness

ngAcceptInputType_leaderLineStrokeThickness: string | number

Static ngAcceptInputType_leaderLineType

ngAcceptInputType_leaderLineType: string | LeaderLineType

Static ngAcceptInputType_leaderLineVisibility

ngAcceptInputType_leaderLineVisibility: string | Visibility

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_radiusFactor

ngAcceptInputType_radiusFactor: string | number

Static ngAcceptInputType_selectedSliceOpacity

ngAcceptInputType_selectedSliceOpacity: string | number

Static ngAcceptInputType_selectedSliceStrokeThickness

ngAcceptInputType_selectedSliceStrokeThickness: string | number

Static ngAcceptInputType_startAngle

ngAcceptInputType_startAngle: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

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

dataSource

  • get dataSource(): any[]

  • Returns any[]

  • set dataSource(value: any[]): void

  • Parameters

    • value: any[]

    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

i

  • get i(): RingSeries

  • Returns RingSeries

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

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

leaderLineFill

  • get leaderLineFill(): string

  • Gets or sets the fill brush.

    Returns string

  • set leaderLineFill(v: string): void

  • Parameters

    • v: string

    Returns void

leaderLineMargin

  • get leaderLineMargin(): number

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

    Returns number

  • set leaderLineMargin(v: number): void

  • Parameters

    • v: number

    Returns void

leaderLineOpacity

  • get leaderLineOpacity(): number

  • Gets or sets the opacity.

    Returns number

  • set leaderLineOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

leaderLineStroke

  • get leaderLineStroke(): string

  • Gets or sets the stroke brush.

    Returns string

  • set leaderLineStroke(v: string): void

  • Parameters

    • v: string

    Returns void

leaderLineStrokeThickness

  • get leaderLineStrokeThickness(): number

  • Gets or sets the stroke thickness.

    Returns number

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

legend

  • get legend(): any

  • Returns any

  • set legend(v: any): void

  • Parameters

    • v: any

    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

propertyUpdated

  • get propertyUpdated(): EventEmitter<{
        args: IgxPropertyUpdatedEventArgs;
        sender: any;
    }>

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

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

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

ring

  • get ring(): IgxRing

  • Gets reference to the ring data.

    Returns IgxRing

  • set ring(v: IgxRing): void

  • Parameters

    Returns void

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

selectedSlices

  • get selectedSlices(): IgxIndexCollection

  • Gets or sets the collection of selected slice indices.

    Returns IgxIndexCollection

  • set selectedSlices(v: IgxIndexCollection): void

  • Parameters

    Returns void

showDefaultTooltip

  • get showDefaultTooltip(): boolean

  • Gets or sets whether default tooltip will be shown.

    Returns boolean

  • set showDefaultTooltip(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

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

tooltipContainerTemplate

  • get tooltipContainerTemplate(): TemplateRef<any>

  • Returns TemplateRef<any>

  • set tooltipContainerTemplate(value: TemplateRef<any>): void

  • Parameters

    • value: TemplateRef<any>

    Returns void

tooltipTemplate

  • get tooltipTemplate(): TemplateRef<any>

  • Returns TemplateRef<any>

  • set tooltipTemplate(value: TemplateRef<any>): void

  • Parameters

    • value: TemplateRef<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

bindData

ensureLeaderLineStyle

ensureOthersCategoryStyle

ensureSelectedStyle

findByName

  • Parameters

    • name: string

    Returns any

ngOnInit

provideContainer

  • Called by the UI framework to provide a UI container for rendering this control.

    Parameters

    • container: any
      • The UI container element.

    Returns void

sychronizeCollections

Static _createFromInternal