Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxFunnelChartComponent

Represents a funnel chart.

Hierarchy

Hierarchy

  • IgxFunnelChartComponent

Implements

  • AfterContentInit
  • OnDestroy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • renderer: Renderer2
    • _elRef: ViewContainerRef
    • ngZone: NgZone
    • injector: Injector
    • componentFactoryResolver: ComponentFactoryResolver

    Returns IgxFunnelChartComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

container

container: Element

Static ngAcceptInputType_allowSliceSelection

ngAcceptInputType_allowSliceSelection: string | boolean

Static ngAcceptInputType_bottomEdgeWidth

ngAcceptInputType_bottomEdgeWidth: string | number

Static ngAcceptInputType_brushes

ngAcceptInputType_brushes: string | string[]

Static ngAcceptInputType_funnelSliceDisplay

ngAcceptInputType_funnelSliceDisplay: string | FunnelSliceDisplay

Static ngAcceptInputType_innerLabelVisibility

ngAcceptInputType_innerLabelVisibility: string | Visibility

Static ngAcceptInputType_isInverted

ngAcceptInputType_isInverted: string | boolean

Static ngAcceptInputType_outerLabelAlignment

ngAcceptInputType_outerLabelAlignment: string | OuterLabelAlignment

Static ngAcceptInputType_outerLabelVisibility

ngAcceptInputType_outerLabelVisibility: string | Visibility

Static ngAcceptInputType_outlineThickness

ngAcceptInputType_outlineThickness: string | number

Static ngAcceptInputType_outlines

ngAcceptInputType_outlines: string | string[]

Static ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

Static ngAcceptInputType_selectedSliceOpacity

ngAcceptInputType_selectedSliceOpacity: string | number

Static ngAcceptInputType_selectedSliceStrokeThickness

ngAcceptInputType_selectedSliceStrokeThickness: string | number

Static ngAcceptInputType_transitionDuration

ngAcceptInputType_transitionDuration: string | number

Static ngAcceptInputType_unselectedSliceOpacity

ngAcceptInputType_unselectedSliceOpacity: string | number

Static ngAcceptInputType_unselectedSliceStrokeThickness

ngAcceptInputType_unselectedSliceStrokeThickness: string | number

Static ngAcceptInputType_useBezierCurve

ngAcceptInputType_useBezierCurve: string | boolean

Static ngAcceptInputType_useOuterLabelsForLegend

ngAcceptInputType_useOuterLabelsForLegend: string | boolean

Static ngAcceptInputType_useUnselectedStyle

ngAcceptInputType_useUnselectedStyle: string | boolean

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

allowSliceSelection

  • get allowSliceSelection(): boolean

  • Gets or sets whether to allow slices to be selected.

    Returns boolean

  • set allowSliceSelection(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

bottomEdgeWidth

  • get bottomEdgeWidth(): number

  • Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take.

    Returns number

  • set bottomEdgeWidth(v: number): void

  • Parameters

    • v: number

    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

dataSource

  • get dataSource(): any[]

  • Returns any[]

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

  • Parameters

    • value: any[]

    Returns void

formatInnerLabel

  • get formatInnerLabel(): ((arg1: any, arg2: number, arg3: any) => string)

  • Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.

    Returns ((arg1: any, arg2: number, arg3: any) => string)

      • (arg1: any, arg2: number, arg3: any): string

      • Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.

        Parameters

        • arg1: any
        • arg2: number
        • arg3: any

        Returns string

  • set formatInnerLabel(v: ((arg1: any, arg2: number, arg3: any) => string)): void

  • Parameters

    • v: ((arg1: any, arg2: number, arg3: any) => string)
        • (arg1: any, arg2: number, arg3: any): string

        • Parameters

          • arg1: any
          • arg2: number
          • arg3: any

          Returns string

    Returns void

formatOuterLabel

  • get formatOuterLabel(): ((arg1: any, arg2: number, arg3: any) => string)

  • Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.

    Returns ((arg1: any, arg2: number, arg3: any) => string)

      • (arg1: any, arg2: number, arg3: any): string

      • Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.

        Parameters

        • arg1: any
        • arg2: number
        • arg3: any

        Returns string

  • set formatOuterLabel(v: ((arg1: any, arg2: number, arg3: any) => string)): void

  • Parameters

    • v: ((arg1: any, arg2: number, arg3: any) => string)
        • (arg1: any, arg2: number, arg3: any): string

        • Parameters

          • arg1: any
          • arg2: number
          • arg3: any

          Returns string

    Returns void

funnelSliceDisplay

  • get funnelSliceDisplay(): FunnelSliceDisplay

  • Gets or sets how the heights of the funnel slices should be configured.

    Returns FunnelSliceDisplay

  • set funnelSliceDisplay(v: FunnelSliceDisplay): void

  • Parameters

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value: string): void

  • Parameters

    • value: string

    Returns void

innerLabelMemberPath

  • get innerLabelMemberPath(): string

  • Gets or sets the InnerLabel mapping property for the current series object.

    Returns string

  • set innerLabelMemberPath(v: string): void

  • Parameters

    • v: string

    Returns void

innerLabelVisibility

  • get innerLabelVisibility(): Visibility

  • Gets or sets whether the inner labels are visible.

    Returns Visibility

  • set innerLabelVisibility(v: Visibility): void

  • Parameters

    Returns void

isInverted

  • get isInverted(): boolean

  • Gets or sets if the funnel should be rendered inverted.

    Returns boolean

  • set isInverted(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

legend

  • get legend(): any

  • Gets or sets the legend used for the current chart.

    Returns any

  • set legend(v: any): void

  • Parameters

    • v: any

    Returns void

legendItemBadgeTemplate

  • get legendItemBadgeTemplate(): IgDataTemplate

  • Gets or sets the LegendItemBadgeTemplate to use for the legend items.

    Returns IgDataTemplate

  • set legendItemBadgeTemplate(v: IgDataTemplate): void

  • Parameters

    Returns void

outerLabelAlignment

  • get outerLabelAlignment(): OuterLabelAlignment

  • Gets or sets which side of the chart the outer labels should appear.

    Returns OuterLabelAlignment

  • set outerLabelAlignment(v: OuterLabelAlignment): void

  • Parameters

    Returns void

outerLabelMemberPath

  • get outerLabelMemberPath(): string

  • Gets or sets the OuterLabel mapping property for the current series object.

    Returns string

  • set outerLabelMemberPath(v: string): void

  • Parameters

    • v: string

    Returns void

outerLabelTextColor

  • get outerLabelTextColor(): string

  • Gets or sets the brush used for the outer labels.

    Returns string

  • set outerLabelTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

outerLabelTextStyle

  • get outerLabelTextStyle(): string

  • Gets or sets the text style for outer labels

    Returns string

  • set outerLabelTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

outerLabelVisibility

  • get outerLabelVisibility(): Visibility

  • Gets or sets whether the outer labels are visible.

    Returns Visibility

  • set outerLabelVisibility(v: Visibility): void

  • Parameters

    Returns void

outlineThickness

  • get outlineThickness(): number

  • Gets or sets the thickness of outline around slices.

    Returns number

  • set outlineThickness(v: number): void

  • Parameters

    • v: number

    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

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

sliceClicked

  • get sliceClicked(): EventEmitter<{
        args: IgxFunnelSliceClickedEventArgs;
        sender: any;
    }>

  • Event which is raised when a slice is clicked. Function takes first argument null and second argument ui. Use ui.owner to obtain reference to igFunnelChart. Use ui.index to obtain index of clicked slice. Use ui.item to obtain reference to clicked slice item. Use ui.selected to check if slice became selected.

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

sliceEnter

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

  • Raised when a funnel slice is entered.

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

sliceHover

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

  • Raised when a funnel slice is hovered.

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

sliceLeave

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

  • Raised when a funnel slice is left.

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

textColor

  • get textColor(): string

  • Gets or sets the brush used for the inner labels.

    Returns string

  • set textColor(v: string): void

  • Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string

  • Gets or sets the text style for inner labels

    Returns string

  • set textStyle(v: string): void

  • Parameters

    • v: string

    Returns void

transitionDuration

  • get transitionDuration(): number

  • Gets or sets how long the animations should take to run.

    Returns number

  • set transitionDuration(v: number): void

  • Parameters

    • v: number

    Returns void

unselectedSliceFill

  • get unselectedSliceFill(): string

  • Gets or sets the fill brush.

    Returns string

  • set unselectedSliceFill(v: string): void

  • Parameters

    • v: string

    Returns void

unselectedSliceOpacity

  • get unselectedSliceOpacity(): number

  • Gets or sets the opacity.

    Returns number

  • set unselectedSliceOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

unselectedSliceStroke

  • get unselectedSliceStroke(): string

  • Gets or sets the stroke brush.

    Returns string

  • set unselectedSliceStroke(v: string): void

  • Parameters

    • v: string

    Returns void

unselectedSliceStrokeThickness

  • get unselectedSliceStrokeThickness(): number

  • Gets or sets the stroke thickness.

    Returns number

  • set unselectedSliceStrokeThickness(v: number): void

  • Parameters

    • v: number

    Returns void

useBezierCurve

  • get useBezierCurve(): boolean

  • Gets or sets whether to use a Bezier curve to define the funnel.

    Returns boolean

  • set useBezierCurve(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

useOuterLabelsForLegend

  • get useOuterLabelsForLegend(): boolean

  • Gets or sets whether to use the outer labels to identify the legend items.

    Returns boolean

  • set useOuterLabelsForLegend(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

useUnselectedStyle

  • get useUnselectedStyle(): boolean

  • Gets or sets whether to use the unselected style on unselected slices.

    Returns boolean

  • set useUnselectedStyle(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

valueMemberPath

  • get valueMemberPath(): string

  • Gets or sets the value member path for the funnel chart.

    Returns string

  • set valueMemberPath(v: string): void

  • Parameters

    • v: string

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

bindData

  • Returns void

ensureSelectedSliceStyle

  • Returns void

ensureUnselectedSliceStyle

  • Returns void

exportSerializedVisualData

  • Exports and serializes the chart visuals.

    Returns string

findByName

  • Parameters

    • name: string

    Returns any

ngAfterContentInit

  • Returns void

ngOnDestroy

  • Returns void

notifyClearItems

  • Manually notifies the 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 chart is bound to is already observable.

    Parameters

    • source_: any

    Returns void

notifyInsertItem

  • Parameters

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

    Returns void

notifyRemoveItem

  • Parameters

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

    Returns void

notifyResized

  • Notifies the controller and view about a size change.

    Returns void

notifySetItem

  • Parameters

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

    Returns void

provideContainer

  • Provides container for funnel chart

    Parameters

    • container: any

    Returns void

toggleSelection

  • Toggle selection of item at index.

    Parameters

    • index: number

    Returns void

Static _createFromInternal