Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

MicroBoxPlot Class

Namespace:
ActiproSoftware.Windows.Controls.MicroCharts
Assembly:
ActiproSoftware.MicroCharts.Wpf.dll

Represents a box plot control.

[TemplatePart(Name = "PART_Canvas", Type = typeof(Canvas))]
public class MicroBoxPlot : Control
Inheritance:
object Visual UIElement FrameworkElement Control object

Constructors

MicroBoxPlot()

Initializes a new instance of the MicroBoxPlot class.

public MicroBoxPlot()

Properties

AreOutliersVisible

Gets or sets a boolean value indicating whether or not outliers should be rendered. This is a dependency property.

public bool AreOutliersVisible { get; set; }

Property Value

bool:

true if outlier values are visible; otherwise, false. The default value is false.

BoxStyle

Gets or sets the Style used to render the box. This is a dependency property.

public Style BoxStyle { get; set; }

Property Value

Style:

The Style used to render the box. The default value is null.

IqrMultiplier

Gets or sets a value indicating the amount to multiply the IQR by to find the range of the whiskers. This is a dependency property.

public double IqrMultiplier { get; set; }

Property Value

double:

A value indicating the amount to multiply the IQR by to find the range of the whiskers. The default value is 1.5.

Remarks

IQR stands for interquartile range, which is equal to the difference of the upper and lower quartiles.

IsMeanVisible

Gets or sets a boolean value indicating whether or not the mean value bar should be rendered. This is a dependency property.

public bool IsMeanVisible { get; set; }

Property Value

bool:

true if the mean value is visible; otherwise, false. The default value is false.

IsMedianVisible

Gets or sets a boolean value indicating whether or not the median value bar should be rendered. This is a dependency property.

public bool IsMedianVisible { get; set; }

Property Value

bool:

true if the median value is visible; otherwise, false. The default value is true.

LegendStringFormat

Gets or sets the format that the MicroBoxPlot control will display in a tool tip. This is a dependency property.

public string LegendStringFormat { get; set; }

Property Value

string:

The string format that determines how to display a tool tip. The default value is null.

Remarks

The format string will be passed the following parameters:

  • {0} - The minimum value.
  • {1} - The lower whisker value.
  • {2} - The first quartile value.
  • {3} - The median value.
  • {4} - The third quartile value.
  • {5} - The upper whisker value.
  • {6} - The maximum value.
  • {7} - The mean value.
  • {8} - The number of values.

Maximum

Gets or sets the maximum value of the chart. This is a dependency property.

public double Maximum { get; set; }

Property Value

double:

The maximum value of the chart. The default value is NaN.

MeanStyle

Gets or sets the style of the mean value bar. This is a dependency property.

public Style MeanStyle { get; set; }

Property Value

Style:

The style of the mean value bar. The default value is null.

MedianStyle

Gets or sets the style of the median value bar. This is a dependency property.

public Style MedianStyle { get; set; }

Property Value

Style:

The style of the median value bar. The default value is null.

Minimum

Gets or sets the minimum value of the chart. This is a dependency property.

public double Minimum { get; set; }

Property Value

double:

The minimum value of the chart. The default value is NaN.

Orientation

Gets or sets the orientation of the MicroBoxPlot. This is a dependency property.

public Orientation Orientation { get; set; }

Property Value

Orientation:

The orientation of the MicroBoxPlot. The default value is Horizontal.

OutlierStyle

Gets or sets the style of the outlier marker. This is a dependency property.

public Style OutlierStyle { get; set; }

Property Value

Style:

The style of the outlier marker. The default value is null.

Values

Gets or sets the list of data values to be represented by the chart. This is a dependency property.

[TypeConverter(typeof(MicroSeriesItemsSourceConverter))]
public IEnumerable<double> Values { get; set; }

Property Value

IEnumerable<double>:

The the list of data values. The default value is null.

WhiskerAscent

Gets or sets a Unit indicating the ascent of the whisker endline. This is a dependency property.

public Unit WhiskerAscent { get; set; }

Property Value

Unit:

A Unit indicating the ascent of the whisker endline. The default value is 50%.

Remarks

Ascent is height when in a horizontal graph, and width when in a vertical graph.

WhiskerStyle

Gets or sets the style of the whisker line. This is a dependency property.

public Style WhiskerStyle { get; set; }

Property Value

Style:

The style of the whisker line. The default value is null.

Methods

OnApplyTemplate()

Invoked whenever application code or internal processes call ApplyTemplate.

public override void OnApplyTemplate()

OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The class-specific AutomationPeer subclass to return.

OnSizeChanged(object, SizeChangedEventArgs)

Handles the SizeChanged event of the control.

protected virtual void OnSizeChanged(object sender, SizeChangedEventArgs e)
Parameter Type Description
sender object

The source of the event.
e SizeChangedEventArgs

The SizeChangedEventArgs instance containing the event data.

Refresh()

Updates the chart based on the current state.

public void Refresh()

Fields

AreOutliersVisibleProperty

Identifies the AreOutliersVisible dependency property. This field is read-only.

public static readonly DependencyProperty AreOutliersVisibleProperty

BoxStyleProperty

Identifies the BoxStyle dependency property. This field is read-only.

public static readonly DependencyProperty BoxStyleProperty

IqrMultiplierProperty

Identifies the IqrMultiplier dependency property. This field is read-only.

public static readonly DependencyProperty IqrMultiplierProperty

IsMeanVisibleProperty

Identifies the IsMeanVisible dependency property. This field is read-only.

public static readonly DependencyProperty IsMeanVisibleProperty

IsMedianVisibleProperty

Identifies the IsMedianVisible dependency property. This field is read-only.

public static readonly DependencyProperty IsMedianVisibleProperty

LegendStringFormatProperty

Identifies the LegendStringFormat dependency property. This field is read-only.

public static readonly DependencyProperty LegendStringFormatProperty

MaximumProperty

Identifies the Maximum dependency property. This field is read-only.

public static readonly DependencyProperty MaximumProperty

MeanStyleProperty

Identifies the MeanStyle dependency property. This field is read-only.

public static readonly DependencyProperty MeanStyleProperty

MedianStyleProperty

Identifies the MedianStyle dependency property. This field is read-only.

public static readonly DependencyProperty MedianStyleProperty

MinimumProperty

Identifies the Minimum dependency property. This field is read-only.

public static readonly DependencyProperty MinimumProperty

OrientationProperty

Identifies the Orientation dependency property. This field is read-only.

public static readonly DependencyProperty OrientationProperty

OutlierStyleProperty

Identifies the OutlierStyle dependency property. This field is read-only.

public static readonly DependencyProperty OutlierStyleProperty

ValuesProperty

Identifies the Values dependency property. This field is read-only.

public static readonly DependencyProperty ValuesProperty

WhiskerAscentProperty

Identifies the WhiskerAscent dependency property. This field is read-only.

public static readonly DependencyProperty WhiskerAscentProperty

WhiskerStyleProperty

Identifies the WhiskerStyle dependency property. This field is read-only.

public static readonly DependencyProperty WhiskerStyleProperty