Class BoxAndWhiskerSeries

BoxAndWhiskerSeries plots a combination of rectangle and lines to show the distribution of data set.

Inheritance
System.Object
ChartSeriesBase
ChartSeries
AdornmentSeries
CartesianSeries
XyDataSeries
BoxAndWhiskerSeries
Inherited Members
Namespace: Syncfusion.UI.Xaml.Charts
Assembly: Syncfusion.SfChart.WPF.dll
Syntax
public class BoxAndWhiskerSeries : XyDataSeries, ICloneable, ISupportAxes2D, ISupportAxes, ISegmentSpacing, ISegmentSelectable
Examples
      <syncfusion:BoxAndWhiskerSeries ItemsSource="{Binding Data}" XBindingPath="Year" YBindingPath="Value">
      </syncfusion:BoxAndWhiskerSeries>
      BoxAndWhiskerSeries series1 = new BoxAndWhiskerSeries();
      series1.ItemsSource = viewmodel.Data;
      series1.XBindingPath = "Year";
      series1.YBindingPath = "Value";
      chart.Series.Add(series1);

Constructors

BoxAndWhiskerSeries()

Declaration
public BoxAndWhiskerSeries()

Fields

BoxPlotModeProperty

Declaration
public static readonly DependencyProperty BoxPlotModeProperty
Field Value
Type
System.Windows.DependencyProperty

OutlierTemplateProperty

The DependencyProperty for OutlierTemplate property.

Declaration
public static readonly DependencyProperty OutlierTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

SegmentSelectionBrushProperty

The DependencyProperty for SegmentSelectionBrush property.

Declaration
public static readonly DependencyProperty SegmentSelectionBrushProperty
Field Value
Type
System.Windows.DependencyProperty

SegmentSpacingProperty

The DependencyProperty for SegmentSpacing property.

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

SelectedIndexProperty

The DependencyProperty for SelectedIndex property.

Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
Type
System.Windows.DependencyProperty

ShowMedianProperty

Declaration
public static readonly DependencyProperty ShowMedianProperty
Field Value
Type
System.Windows.DependencyProperty

ShowOutlierProperty

The DependencyProperty for ShowOutlier property.

Declaration
public static readonly DependencyProperty ShowOutlierProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

BoxPlotMode

Gets or sets the plotting mode for drawing the series.

Declaration
public BoxPlotMode BoxPlotMode { get; set; }
Property Value
Type
BoxPlotMode

IsSideBySide

Gets a value indicating whether this series is placed side by side.

Declaration
protected override bool IsSideBySide { get; }
Property Value
Type Description
System.Boolean

It returns true, if the series is placed side by side [cluster mode].
Overrides

OutlierTemplate

Gets or sets the template for outliers.

Declaration
public DataTemplate OutlierTemplate { get; set; }
Property Value
Type Description
System.Windows.DataTemplate

System.Windows.DataTemplate

SegmentSelectionBrush

Gets or sets the interior for the selected segment.

Declaration
public Brush SegmentSelectionBrush { get; set; }
Property Value
Type Description
System.Windows.Media.Brush

The System.Windows.Media.Brush value.

SegmentSpacing

Gets or sets the spacing between the segments across the series in cluster mode.

Declaration
public double SegmentSpacing { get; set; }
Property Value
Type Description
System.Double

The value ranges from 0 to 1.

SelectedIndex

Gets or sets the index of the selected segment.

Declaration
public int SelectedIndex { get; set; }
Property Value
Type Description
System.Int32

Int value represents the index of the data point(or segment) to be selected and its default value is -1.

ShowMedian

Gets or sets a value indicating whether to enable the median symbol.

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

ShowOutlier

Gets or sets the value that indicates whether to show or hide the outlier symbol that is displayed outside the whiskers of the box plot.

Declaration
public bool ShowOutlier { get; set; }
Property Value
Type Description
System.Boolean

The default value is True.
See Also

WhiskerWidth

Gets or sets the whisker width.

Declaration
protected double? WhiskerWidth { get; set; }
Property Value
Type
System.Nullable<System.Double>

YCollection

Gets or sets the y values collection.

Declaration
protected List<IList<double>> YCollection { get; set; }
Property Value
Type
System.Collections.Generic.List<System.Collections.Generic.IList<System.Double>>

Methods

CalculateSegmentSpacing(Double, Double, Double)

Method used to calculate the segment spacing.

Declaration
protected double CalculateSegmentSpacing(double spacing, double Right, double Left)
Parameters
Type Name Description
System.Double spacing

Spacing
System.Double Right

Right
System.Double Left

Left
Returns
Type
System.Double

ClearUnUsedSegments(Int32)

Method used to clear the unused adornments.

Declaration
protected override void ClearUnUsedSegments(int startIndex)
Parameters
Type Name Description
System.Int32 startIndex

index
Overrides

CloneSeries(DependencyObject)

Returns the instance of BoxAndWhiskerSeries series.

Declaration
protected override DependencyObject CloneSeries(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

object
Returns
Type
System.Windows.DependencyObject
Overrides

CreateSegment()

Creates an instance of series segment.

Declaration
protected override ChartSegment CreateSegment()
Returns
Type Description
ChartSegment

Returns the instance of corresponding series segment.
Overrides
Remarks

This customization is not supported for fast type series and technical indicators.

Examples

This sample shows how to call the CreateSegment() method to customize the line series segments.

public class LineSeriesExt : LineSeries
{​ 
    protected override ChartSegment CreateSegment()
    {​
        return new LineSegmentExt();
    }​
}​

public class LineSegmentExt : LineSegment
{​
    public override UIElement CreateVisual(Size size)
    {​
        // Write your customization code here.
    }​

    public override void Update(IChartTransformer transformer)
    {​
        // Write your customization code here.
    }​
}

CreateSegments()

Creates the segments of Box and Whisker Series.

Declaration
public override void CreateSegments()
Overrides

FindNearestChartPoint(Point, out Double, out Double, out Double)

Finds the nearest point in ChartSeries relative to the mouse point/touch position.

Declaration
public override void FindNearestChartPoint(Point point, out double x, out double y, out double stackedYValue)
Parameters
Type Name Description
System.Windows.Point point

The co-ordinate point representing the current mouse point /touch position.
System.Double x

x-value of the nearest point.
System.Double y

y-value of the nearest point
System.Double stackedYValue
Overrides

GeneratePoints()

Method used to generate points for BoxAndWhisker series.

Declaration
protected override void GeneratePoints()
Overrides

OnBindingPathChanged(DependencyPropertyChangedEventArgs)

Called when binding path changed.

Declaration
protected override void OnBindingPathChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

args
Overrides

OnDataSourceChanged(IEnumerable, IEnumerable)

Called when ItemsSource property changed.

Declaration
protected override void OnDataSourceChanged(IEnumerable oldValue, IEnumerable newValue)
Parameters
Type Name Description
System.Collections.IEnumerable oldValue

new value
System.Collections.IEnumerable newValue

old value
Overrides

Explicit Interface Implementations

ISegmentSpacing.CalculateSegmentSpacing(Double, Double, Double)

Declaration
double ISegmentSpacing.CalculateSegmentSpacing(double spacing, double Right, double Left)
Parameters
Type Name Description
System.Double spacing
System.Double Right
System.Double Left
Returns
Type
System.Double

Implements