Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrFunnelChartProps

Hierarchy

Hierarchy

  • IIgrFunnelChartProps

Properties

Properties

Optional actualHighlightValueDisplayMode

actualHighlightValueDisplayMode?: string | HighlightedValueDisplayMode

Gets whether and how to display the highlighted value.

Optional actualHighlightValueOpacity

actualHighlightValueOpacity?: string | number

Gets the actual opacity of the primary needle while highlighting

Optional allowSliceSelection

allowSliceSelection?: string | boolean

Gets or sets whether to allow slices to be selected.

Optional bottomEdgeWidth

bottomEdgeWidth?: string | number

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

Optional brushes

brushes?: string | string[]

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

Optional children

children?: ReactNode

Optional dataSource

dataSource?: any[]

Gets or sets the data for the chart to use. This can be overriden at the series and axis level.

Optional formatInnerLabel

formatInnerLabel?: ((arg1, arg2, arg3) => string)

Type declaration

    • (arg1, arg2, arg3): 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

Optional formatOuterLabel

formatOuterLabel?: ((arg1, arg2, arg3) => string)

Type declaration

    • (arg1, arg2, arg3): 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

Optional funnelSliceDisplay

funnelSliceDisplay?: string | FunnelSliceDisplay

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

Optional height

height?: string

Optional highlightValueDisplayMode

highlightValueDisplayMode?: string | HighlightedValueDisplayMode

Gets or sets whether and how to display the highlighted value.

Optional highlightValueOpacity

highlightValueOpacity?: string | number

Gets or sets the opacity while highlighting

Optional highlightedValueMemberPath

highlightedValueMemberPath?: string

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

Optional innerLabelMemberPath

innerLabelMemberPath?: string

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

Optional innerLabelVisibility

innerLabelVisibility?: string | Visibility

Gets or sets whether the inner labels are visible.

Optional isInverted

isInverted?: string | boolean

Gets or sets if the funnel should be rendered inverted.

Optional legend

legend?: any

Optional legendItemBadgeTemplate

legendItemBadgeTemplate?: IgDataTemplate

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

Optional outerLabelAlignment

outerLabelAlignment?: string | OuterLabelAlignment

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

Optional outerLabelMemberPath

outerLabelMemberPath?: string

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

Optional outerLabelTextColor

outerLabelTextColor?: string

Gets or sets the brush used for the outer labels.

Optional outerLabelTextStyle

outerLabelTextStyle?: string

Gets or sets the text style for outer labels

Optional outerLabelVisibility

outerLabelVisibility?: string | Visibility

Gets or sets whether the outer labels are visible.

Optional outlineThickness

outlineThickness?: string | number

Gets or sets the thickness of outline around slices.

Optional outlines

outlines?: string | string[]

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

Optional pixelScalingRatio

pixelScalingRatio?: string | 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.

Optional selectedSliceFill

selectedSliceFill?: string

Gets or sets the fill brush.

Optional selectedSliceOpacity

selectedSliceOpacity?: string | number

Gets or sets the opacity.

Optional selectedSliceStroke

selectedSliceStroke?: string

Gets or sets the stroke brush.

Optional selectedSliceStrokeThickness

selectedSliceStrokeThickness?: string | number

Gets or sets the stroke thickness.

Optional sliceClicked

sliceClicked?: ((s, e) => void)

Type declaration

    • (s, e): void

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

      Parameters

      Returns void

Optional sliceEnter

sliceEnter?: ((s, e) => void)

Type declaration

Optional sliceHover

sliceHover?: ((s, e) => void)

Type declaration

Optional sliceLeave

sliceLeave?: ((s, e) => void)

Type declaration

Optional textColor

textColor?: string

Gets or sets the brush used for the inner labels.

Optional textStyle

textStyle?: string

Gets or sets the text style for inner labels

Optional transitionDuration

transitionDuration?: string | number

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

Optional unselectedSliceFill

unselectedSliceFill?: string

Gets or sets the fill brush.

Optional unselectedSliceOpacity

unselectedSliceOpacity?: string | number

Gets or sets the opacity.

Optional unselectedSliceStroke

unselectedSliceStroke?: string

Gets or sets the stroke brush.

Optional unselectedSliceStrokeThickness

unselectedSliceStrokeThickness?: string | number

Gets or sets the stroke thickness.

Optional useBezierCurve

useBezierCurve?: string | boolean

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

Optional useOuterLabelsForLegend

useOuterLabelsForLegend?: string | boolean

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

Optional useUnselectedStyle

useUnselectedStyle?: string | boolean

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

Optional valueMemberPath

valueMemberPath?: string

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

Optional width

width?: string