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

XYSeriesBase Class

In This Article
Namespace:
ActiproSoftware.Windows.Controls.Charts.Primitives
Assembly:
ActiproSoftware.Charts.Wpf.dll

Provides the base class for a series that uses an X/Y axis.

public abstract class XYSeriesBase : SeriesBase
Inheritance:
object Visual UIElement FrameworkElement Control SeriesBase object
Derived:
BarSeriesBase LineSeriesBase ScatterSeries

Constructors

XYSeriesBase()

Initializes an instance of the class.

protected XYSeriesBase()

Properties

AggregationFactor

Gets or sets a factor between 0 and 1 that indicates the number of data points generated based on the size of the chart. This is a dependency property.

public double AggregationFactor { get; set; }

Property Value

double:

A factor between 0 and 1 that indicates the number of data points generated based on the size of the chart. The default value is 0.2.

Chart

Gets the XYChart that owns this series.

public XYChart Chart { get; }

Property Value

XYChart

Description

Gets or sets a description of the series. This is a dependency property.

public string Description { get; set; }

Property Value

string:

A description of the series. The default value is null.

IsAggregationEnabled

Gets or sets a value indicating whether the data points will be an aggregation of the source data. This is a dependency property.

public bool IsAggregationEnabled { get; set; }

Property Value

bool:

true if the data points will be an aggregation of the source data; otherwise, false. The default value is true.

LegendMarkerStyle

Gets or sets a Style, which is applied to the ChartMarker element used when presenting a legend item for the series. This is a dependency property.

public Style LegendMarkerStyle { get; set; }

Property Value

Style:

A Style, which is applied to the ChartMarker used when presenting a legend item for the series. The default value is null.

LegendStringFormat

Gets or sets the string format used when presenting a legend item for the series. This is a dependency property.

public string LegendStringFormat { get; set; }

Property Value

string:

The string format used when presenting legend item for the series. The default value is "{0}".

Remarks

The format string will be passed the following parameters:

  • {0} - The value of the primary axis.
  • {1} - The value of the secondary axis.
  • {2} - The X value.
  • {3} - The Y value.
  • {4} - Reserved.
  • {5} - Description.

MarkerStyle

Gets or sets a Style, which is applied to the ChartMarker elements used to render the markers along the series. This is a dependency property.

public Style MarkerStyle { get; set; }

Property Value

Style:

A Style, which is applied to the ChartMarker used to render the markers along the series. The default value is null.

MinimumMargin

Gets the minimum margin around the plotted area required by the series.

protected virtual Thickness? MinimumMargin { get; }

Property Value

Thickness?:

The minimum margin around the plotted area required by the series.

PrimaryAggregationKind

Gets or sets a value indicating which kind of aggregation to perform along the primary axis. This is a dependency property.

public AggregationKind PrimaryAggregationKind { get; set; }

Property Value

AggregationKind:

A AggregationKind indicating which kind of aggregation to perform along the primary axis. The default value is AggregationKind.Average.

RequiresSlottedLayout

Gets a value indicating whether the series requires slotted layout.

public virtual bool RequiresSlottedLayout { get; }

Property Value

bool:

true if the series requires slotted layout; otherwise, false.

SecondaryAggregationKind

Gets or sets a value indicating which kind of aggregation to perform along the secondary axis. This is a dependency property.

public AggregationKind SecondaryAggregationKind { get; set; }

Property Value

AggregationKind:

A AggregationKind indicating which kind of aggregation to perform along the secondary axis. The default value is AggregationKind.First.

StackKind

Gets or sets a value indicating the kind of stacking applied to the series. This is a dependency property.

public XYSeriesStackKind StackKind { get; set; }

Property Value

XYSeriesStackKind:

The kind of stacking applied to the series. The default value is XYSeriesStackKind.None.

XAxis

Gets or sets the X axis to be used for this series. This is a dependency property.

public XYAxisBase XAxis { get; set; }

Property Value

XYAxisBase:

The X axis to be used for this series. The default value is null.

XPath

Gets or sets the path to the item property represented along the X-axis. This is a dependency property.

public string XPath { get; set; }

Property Value

string:

The path to the item property represented along the X-axis. The default value is null.

YAxis

Gets or sets the Y axis to be used for this series. This is a dependency property.

public XYAxisBase YAxis { get; set; }

Property Value

XYAxisBase:

The Y axis to be used for this series. The default value is null.

YPath

Gets or sets the path to the item property represented along the Y-axis. This is a dependency property.

public string YPath { get; set; }

Property Value

string:

The path to the item property represented along the Y-axis. The default value is null.

Methods

NormalizeValue(object, object)

Normalizes the value using the specified baseline

protected virtual object NormalizeValue(object value, object baselineValue)
Parameter Type Description
value object

The value to normalize.
baselineValue object

The baseline value.

Returns

object:

A normalized value.

Refresh()

Updates the series based on the current state.

public override void Refresh()

Events

Refreshed

Occurs when the series is refreshed.

public event EventHandler Refreshed

Event Type

EventHandler

Fields

AggregationFactorProperty

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

public static readonly DependencyProperty AggregationFactorProperty

DescriptionProperty

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

public static readonly DependencyProperty DescriptionProperty

IsAggregationEnabledProperty

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

public static readonly DependencyProperty IsAggregationEnabledProperty

LegendMarkerStyleProperty

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

public static readonly DependencyProperty LegendMarkerStyleProperty

LegendStringFormatProperty

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

public static readonly DependencyProperty LegendStringFormatProperty

MarkerStyleProperty

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

public static readonly DependencyProperty MarkerStyleProperty

PrimaryAggregationKindProperty

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

public static readonly DependencyProperty PrimaryAggregationKindProperty

SecondaryAggregationKindProperty

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

public static readonly DependencyProperty SecondaryAggregationKindProperty

StackKindProperty

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

public static readonly DependencyProperty StackKindProperty

XAxisProperty

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

public static readonly DependencyProperty XAxisProperty

XPathProperty

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

public static readonly DependencyProperty XPathProperty

YAxisProperty

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

public static readonly DependencyProperty YAxisProperty

YPathProperty

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

public static readonly DependencyProperty YPathProperty

Inherited Members