MicroXYSeriesBase Class
Provides the base class for a micro series that uses an X/Y axis.
public abstract class MicroXYSeriesBase : MicroSeriesBase, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, INotifyPropertyChanged
- Inheritance:
- Object DispatcherObject DependencyObject Visual UIElement FrameworkElement Control MicroSeriesBase Object
Constructors
MicroXYSeriesBase()
protected MicroXYSeriesBase()
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 MicroXYChart that owns this series.
DataPoints
Gets the data points associated with this series.
public MicroXYDataPointCollectionView DataPoints { get; }
Property Value
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
- Boolean:
true
if the data points will be an aggregation of the source data; otherwise,false
. The default value istrue
.
LegendItemTemplate
Gets or sets the data template used when presenting a legend item for the series. This is a dependency property.
public DataTemplate LegendItemTemplate { get; set; }
Property Value
- DataTemplate:
The data template used when presenting a legend item for the series. The default value is null.
LegendMarkerStyle
Gets or sets a Style, which is applied to the MicroChartMarker 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 MicroChartMarker 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.
MarkerFirstStyle
Gets or sets a Style, which is applied to the MicroChartMarker element used to render the first marker along the series. This is a dependency property.
public Style MarkerFirstStyle { get; set; }
Property Value
- Style:
A Style, which is applied to the MicroChartMarker element used to render the first marker along the series. The default value is null.
MarkerHighStyle
Gets or sets a Style, which is applied to the MicroChartMarker elements used to render the high markers along the series. This is a dependency property.
public Style MarkerHighStyle { get; set; }
Property Value
- Style:
A Style, which is applied to the MicroChartMarker elements used to render the high markers along the series. The default value is null.
MarkerLastStyle
Gets or sets a Style, which is applied to the MicroChartMarker element used to render the last marker along the series. This is a dependency property.
public Style MarkerLastStyle { get; set; }
Property Value
- Style:
A Style, which is applied to the MicroChartMarker element used to render the last marker along the series. The default value is null.
MarkerLowStyle
Gets or sets a Style, which is applied to the MicroChartMarker elements used to render the low markers along the series. This is a dependency property.
public Style MarkerLowStyle { get; set; }
Property Value
- Style:
A Style, which is applied to the MicroChartMarker used to render the low markers along the series. The default value is null.
MarkerNegativeStyle
Gets or sets a negative Style, which is applied to the MicroChartMarker elements used to render the markers along the series. This is a dependency property.
public Style MarkerNegativeStyle { get; set; }
Property Value
- Style:
A negative Style, which is applied to the MicroChartMarker used to render the markers along the series. The default value is null.
MarkerStyle
Gets or sets a Style, which is applied to the MicroChartMarker 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 MicroChartMarker used to render the markers along the series. The default value is null.
MarkerStyleKinds
Gets or sets a MicroChartMarkerStyleKinds which indicates what style kinds are used for markers along the series. This is a dependency property.
public MicroChartMarkerStyleKinds MarkerStyleKinds { get; set; }
Property Value
- MicroChartMarkerStyleKinds:
A MicroChartMarkerStyleKinds which indicates what style kinds are used for markers along the series. The default value is
MicroChartMarkerStyleKinds.None
.
PrimaryAggregationKind
Gets or sets a value indicating which kind of aggregation to perform along the primary axis. This is a dependency property.
public MicroAggregationKind PrimaryAggregationKind { get; set; }
Property Value
- MicroAggregationKind:
A MicroAggregationKind indicating which kind of aggregation to perform along the primary axis. The default value is
MicroAggregationKind.Average
.
RequiresNormalizedValues
Gets a value indicating whether the values presented by this series must be normalized.
protected virtual bool RequiresNormalizedValues { get; }
Property Value
- Boolean:
true
if the values presented by this series must be normalized; otherwise,false
.
RequiresSlottedLayout
Gets a value indicating whether the series requires slotted layout.
protected virtual bool RequiresSlottedLayout { get; }
Property Value
- Boolean:
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 MicroAggregationKind SecondaryAggregationKind { get; set; }
Property Value
- MicroAggregationKind:
A MicroAggregationKind indicating which kind of aggregation to perform along the secondary axis. The default value is
MicroAggregationKind.First
.
StackKind
Gets or sets a value indicating the kind of stacking applied to the series. This is a dependency property.
public MicroXYSeriesStackKind StackKind { get; set; }
Property Value
- MicroXYSeriesStackKind:
The kind of stacking applied to the series. The default value is
MicroXYSeriesStackKind.None
.
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.
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
GetMinimumMargin()
Gets the minimum margin around the plotted area required by the series.
protected virtual Thickness? GetMinimumMargin()
Returns
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.
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
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
LegendItemTemplateProperty
Identifies the LegendItemTemplate dependency property. This field is read-only.
public static readonly DependencyProperty LegendItemTemplateProperty
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
MarkerFirstStyleProperty
Identifies the MarkerFirstStyle dependency property. This field is read-only.
public static readonly DependencyProperty MarkerFirstStyleProperty
MarkerHighStyleProperty
Identifies the MarkerHighStyle dependency property. This field is read-only.
public static readonly DependencyProperty MarkerHighStyleProperty
MarkerLastStyleProperty
Identifies the MarkerLastStyle dependency property. This field is read-only.
public static readonly DependencyProperty MarkerLastStyleProperty
MarkerLowStyleProperty
Identifies the MarkerLowStyle dependency property. This field is read-only.
public static readonly DependencyProperty MarkerLowStyleProperty
MarkerNegativeStyleProperty
Identifies the MarkerNegativeStyle dependency property. This field is read-only.
public static readonly DependencyProperty MarkerNegativeStyleProperty
MarkerStyleKindsProperty
Identifies the MarkerStyleKinds dependency property. This field is read-only.
public static readonly DependencyProperty MarkerStyleKindsProperty
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
XPathProperty
Identifies the XPath dependency property. This field is read-only.
public static readonly DependencyProperty XPathProperty
YPathProperty
Identifies the YPath dependency property. This field is read-only.
public static readonly DependencyProperty YPathProperty
Inherited Members
- MicroSeriesBase.IndexProperty
- MicroSeriesBase.ItemsSourceProperty
- MicroSeriesBase.NotifyPropertyChanged(String)
- MicroSeriesBase.OnItemsSourceChanged(IEnumerable, IEnumerable)
- MicroSeriesBase.OnItemsSourceCollectionChanged(Object, NotifyCollectionChangedEventArgs)
- MicroSeriesBase.OnPropertyChanged(PropertyChangedEventArgs)
- MicroSeriesBase.Index
- MicroSeriesBase.ItemsSource
- MicroSeriesBase.LogicalOrientation
- MicroSeriesBase.PropertyChanged
- Object.ToString()
- Object.Equals(Object)
- Object.Equals(Object, Object)
- Object.ReferenceEquals(Object, Object)
- Object.GetHashCode()
- Object.GetType()
- Object.MemberwiseClone()