Documentation

Class FunnelSeries

Represents a chart series that visualize data points using trapezoid segments that form a funnel form.

Inheritance
System.Object
RadControlBase
PresenterBase
ChartElementPresenter
ChartSeries
FunnelSeries
Inherited Members
Namespace: Telerik.Windows.Controls.ChartView
Assembly: Telerik.Windows.Controls.Chart.dll

Syntax

public class FunnelSeries : ChartSeries, IChartElementPresenterWithMargin, IChartSeries, IChartElementPresenter, ISeries

Constructors

FunnelSeries()

Initializes a new instance of the FunnelSeries class.

Declaration
public FunnelSeries()

Fields

DefaultSegmentStyleProperty

Identifies the DefaultSegmentStyle property.

Declaration
public static readonly DependencyProperty DefaultSegmentStyleProperty
Field Value
System.Windows.DependencyProperty

IsDynamicHeightProperty

Identifies the IsDynamicHeight property.

Declaration
public static readonly DependencyProperty IsDynamicHeightProperty
Field Value
System.Windows.DependencyProperty

IsDynamicSlopeProperty

Identifies the IsDynamicSlope property.

Declaration
public static readonly DependencyProperty IsDynamicSlopeProperty
Field Value
System.Windows.DependencyProperty

LegendSettingsProperty

Identifies the LegendSettings property.

Declaration
public static readonly DependencyProperty LegendSettingsProperty
Field Value
System.Windows.DependencyProperty

NeckRatioProperty

Identifies the NeckRatio property.

Declaration
public static readonly DependencyProperty NeckRatioProperty
Field Value
System.Windows.DependencyProperty

SegmentSpacingProperty

Identifies the SegmentSpacing property.

Declaration
public static readonly DependencyProperty SegmentSpacingProperty
Field Value
System.Windows.DependencyProperty

SegmentStyleSelectorProperty

Identifies the SegmentStyleSelector property.

Declaration
public static readonly DependencyProperty SegmentStyleSelectorProperty
Field Value
System.Windows.DependencyProperty

ValueBindingProperty

Identifies the ValueBinding property.

Declaration
public static readonly DependencyProperty ValueBindingProperty
Field Value
System.Windows.DependencyProperty

Properties

DataPoints

Gets the collection of data points associated with the series.

Declaration
public ElementCollection<FunnelDataPoint> DataPoints { get; }
Property Value
ElementCollection<FunnelDataPoint>

DefaultSegmentStyle

Gets or sets the System.Windows.Style instance that defines the default appearance of each System.Windows.Shapes.Path presenting a funnel segment.

Declaration
public Style DefaultSegmentStyle { get; set; }
Property Value
System.Windows.Style

IsDynamicHeight

Gets or sets a value indicating whether all the segments will share the same height (when False) or the height of each segment is determined according to its value (when True). Default value is true.

Declaration
public bool IsDynamicHeight { get; set; }
Property Value
System.Boolean

IsDynamicSlope

Gets or sets a value indicating whether the form of each segment will be based on the ratio between the value from the current and the next segment. Default value is false.

Declaration
public bool IsDynamicSlope { get; set; }
Property Value
System.Boolean

LabelFormat

Gets or sets the string used to format the default label of the Segments which is the Label of the FunnelDataPoint. Defaults to 'p0'.

Declaration
public string LabelFormat { get; set; }
Property Value
System.String

LegendSettings

Gets or sets the legend settings.

Declaration
public DataPointLegendSettings LegendSettings { get; set; }
Property Value
DataPointLegendSettings

NeckRatio

Gets or sets a value indicating the ratio between the top and the bottom bases of the whole funnel series. The property can take effect only if the IsDynamicSlope property is set to false.

Declaration
public float NeckRatio { get; set; }
Property Value
System.Single

SegmentSpacing

Gets or sets a value indicating the space between the funnel segments in pixels.

Declaration
public int SegmentSpacing { get; set; }
Property Value
System.Int32

SegmentStyles

Gets the collection storing a Style instance for each segment present on the chart.

Declaration
public ObservableCollection<Style> SegmentStyles { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<System.Windows.Style>

SegmentStyleSelector

Gets or sets the System.Windows.Controls.StyleSelector instance used to select the appropriate style for a FunnelDataPoint.

Declaration
public StyleSelector SegmentStyleSelector { get; set; }
Property Value
System.Windows.Controls.StyleSelector

ValueBinding

Gets or sets the binding that will be used to fill the Value member of the contained data points.

Declaration
public DataPointBinding ValueBinding { get; set; }
Property Value
DataPointBinding

Methods

GetLabelConnector(ChartSeriesLabelPositionInfo)

Gets the points which build the label connector polyline.

Declaration
protected override List<Point> GetLabelConnector(ChartSeriesLabelPositionInfo info)
Parameters
ChartSeriesLabelPositionInfo info

Returns
System.Collections.Generic.List<System.Windows.Point>

Overrides

GetValueAggregateFunction()

When overridden in a derived class, this method returns the function used to calculate the aggregate values for the Value property.

Declaration
protected virtual ChartAggregateFunction GetValueAggregateFunction()
Returns
ChartAggregateFunction

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks.

Declaration
public override void OnApplyTemplate()
Overrides

OnAttached()

Occurs when the presenter has been successfully attached to its owning RadChartBase instance.

Declaration
protected override void OnAttached()
Overrides

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnLoaded(Object, RoutedEventArgs)

Occurs when a System.Windows.FrameworkElement has been constructed and added to the object tree.

Declaration
protected override void OnLoaded(object sender, RoutedEventArgs e)
Parameters
System.Object sender

System.Windows.RoutedEventArgs e

Overrides

OnMouseLeave(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseLeave attached event is raised on this element. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs that contains the event data.

OnPlayPointAnimations(Boolean)

Fired when Point animations are about to be played.

Declaration
protected override void OnPlayPointAnimations(bool hidePointsOnLoad)
Parameters
System.Boolean hidePointsOnLoad

When true, the animated element is collapsed until the start of the animation.
Overrides

Extension Methods