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

MicroXYSeriesBase Class

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

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

public abstract class MicroXYSeriesBase : MicroSeriesBase
Inheritance:
object Visual UIElement FrameworkElement Control MicroSeriesBase object
Derived:
MicroScatterSeries MicroBarSeriesBase MicroLineSeriesBase

Constructors

MicroXYSeriesBase()

Initializes an instance of the class.

protected MicroXYSeriesBase()

Properties

AggregationFactor

A factor between 0 and 1 that indicates the number of data points generated based on the size of the chart.

public double AggregationFactor { get; set; }

Property Value

double:

The default value is 0.2.

Chart

The MicroXYChart that owns this series.

public MicroXYChart? Chart { get; }

Property Value

MicroXYChart

DataPoints

The data points associated with this series.

public MicroXYDataPointCollectionView? DataPoints { get; }

Property Value

MicroXYDataPointCollectionView

Description

A description of the series.

public string? Description { get; set; }

Property Value

string

IsAggregationEnabled

Indicates whether the data points will be an aggregation of the source data.

public bool IsAggregationEnabled { get; set; }

Property Value

bool:

The default value is true.

LegendItemTemplate

The data template used when presenting a legend item for the series.

public DataTemplate? LegendItemTemplate { get; set; }

Property Value

DataTemplate

LegendMarkerStyle

A Style, which is applied to the MicroChartMarker element used when presenting a legend item for the series.

public Style? LegendMarkerStyle { get; set; }

Property Value

Style

LegendStringFormat

The string format used when presenting a legend item for the series.

public string LegendStringFormat { get; set; }

Property Value

string:

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.

MarkerFirstStyle

A Style, which is applied to the MicroChartMarker element used to render the first marker along the series.

public Style? MarkerFirstStyle { get; set; }

Property Value

Style

MarkerHighStyle

A Style, which is applied to the MicroChartMarker elements used to render the high markers along the series.

public Style? MarkerHighStyle { get; set; }

Property Value

Style

MarkerLastStyle

A Style, which is applied to the MicroChartMarker element used to render the last marker along the series.

public Style? MarkerLastStyle { get; set; }

Property Value

Style

MarkerLowStyle

A Style, which is applied to the MicroChartMarker elements used to render the low markers along the series.

public Style? MarkerLowStyle { get; set; }

Property Value

Style

MarkerNegativeStyle

A negative Style, which is applied to the MicroChartMarker elements used to render the markers along the series.

public Style? MarkerNegativeStyle { get; set; }

Property Value

Style

MarkerStyle

A Style, which is applied to the MicroChartMarker elements used to render the markers along the series.

public Style? MarkerStyle { get; set; }

Property Value

Style

MarkerStyleKinds

A MicroChartMarkerStyleKinds which indicates what style kinds are used for markers along the series.

public MicroChartMarkerStyleKinds MarkerStyleKinds { get; set; }

Property Value

MicroChartMarkerStyleKinds:

The default value is None.

PrimaryAggregationKind

A value indicating which kind of aggregation to perform along the primary axis.

public MicroAggregationKind PrimaryAggregationKind { get; set; }

Property Value

MicroAggregationKind:

The default value is Average.

RequiresNormalizedValues

A value indicating whether the values presented by this series must be normalized.

protected virtual bool RequiresNormalizedValues { get; }

Property Value

bool

RequiresSlottedLayout

A value indicating whether the series requires slotted layout.

protected virtual bool RequiresSlottedLayout { get; }

Property Value

bool

SecondaryAggregationKind

A value indicating which kind of aggregation to perform along the secondary axis.

public MicroAggregationKind SecondaryAggregationKind { get; set; }

Property Value

MicroAggregationKind:

The default value is First.

StackKind

A value indicating the kind of stacking applied to the series.

public MicroXYSeriesStackKind StackKind { get; set; }

Property Value

MicroXYSeriesStackKind:

The default value is None.

XPath

The path to the item property represented along the X-axis.

public string? XPath { get; set; }

Property Value

string

YPath

The path to the item property represented along the Y-axis.

public string? YPath { get; set; }

Property Value

string

Methods

GetMinimumMargin()

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

protected virtual Thickness? GetMinimumMargin()

Returns

Thickness?

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

PlotSeries(MicroXYChartPlotter)

Plots the series to the associated chart using the specified plotter.

protected virtual void PlotSeries(MicroXYChartPlotter plotter)
Parameter Type Description
plotter MicroXYChartPlotter

The plotter used to render shapes on the chart.

PrepareSeries(MicroXYChartPlotter)

Prepares the series to be plotted to the associated chart using the specified plotter.

protected virtual void PrepareSeries(MicroXYChartPlotter plotter)
Parameter Type Description
plotter MicroXYChartPlotter

The plotter.

Refresh()

Updates the series based on the current state.

public override void Refresh()

Fields

AggregationFactorProperty

Defines the AggregationFactor property.

public static readonly DependencyProperty AggregationFactorProperty

DescriptionProperty

Defines the Description property.

public static readonly DependencyProperty DescriptionProperty

IsAggregationEnabledProperty

Defines the IsAggregationEnabled property.

public static readonly DependencyProperty IsAggregationEnabledProperty

LegendItemTemplateProperty

Defines the LegendItemTemplate property.

public static readonly DependencyProperty LegendItemTemplateProperty

LegendMarkerStyleProperty

Defines the LegendMarkerStyle property.

public static readonly DependencyProperty LegendMarkerStyleProperty

LegendStringFormatProperty

Defines the LegendStringFormat property.

public static readonly DependencyProperty LegendStringFormatProperty

MarkerFirstStyleProperty

Defines the MarkerFirstStyle property.

public static readonly DependencyProperty MarkerFirstStyleProperty

MarkerHighStyleProperty

Defines the MarkerHighStyle property.

public static readonly DependencyProperty MarkerHighStyleProperty

MarkerLastStyleProperty

Defines the MarkerLastStyle property.

public static readonly DependencyProperty MarkerLastStyleProperty

MarkerLowStyleProperty

Defines the MarkerLowStyle property.

public static readonly DependencyProperty MarkerLowStyleProperty

MarkerNegativeStyleProperty

Defines the MarkerNegativeStyle property.

public static readonly DependencyProperty MarkerNegativeStyleProperty

MarkerStyleKindsProperty

Defines the MarkerStyleKinds property.

public static readonly DependencyProperty MarkerStyleKindsProperty

MarkerStyleProperty

Defines the MarkerStyle property.

public static readonly DependencyProperty MarkerStyleProperty

PrimaryAggregationKindProperty

Defines the PrimaryAggregationKind property.

public static readonly DependencyProperty PrimaryAggregationKindProperty

SecondaryAggregationKindProperty

Defines the SecondaryAggregationKind property.

public static readonly DependencyProperty SecondaryAggregationKindProperty

StackKindProperty

Defines the StackKind property.

public static readonly DependencyProperty StackKindProperty

XPathProperty

Defines the XPath property.

public static readonly DependencyProperty XPathProperty

YPathProperty

Defines the YPath property.

public static readonly DependencyProperty YPathProperty

Inherited Members

Extension Methods