Class DefinitionSeries
Implements a series that is defined by one or more instances of the DefinitionSeries class.
Inheritance
Implements
Inherited Members
Namespace: System.Windows.Controls.DataVisualization.Charting
Assembly: Controls.DataVisualization.OpenSilver.dll
Syntax
public abstract class DefinitionSeries : Control, ISeries, IAxisListener, IRangeProvider, IValueMarginProvider, IDataProvider, ISeriesHost, IRequireSeriesHost, IResourceDictionaryDispenser
Constructors
| Improve this Doc View SourceDefinitionSeries()
Initializes a new instance of the DefinitionSeries class.
Declaration
protected DefinitionSeries()
Fields
| Improve this Doc View SourceActualDependentAxisProperty
Identifies the ActualDependentAxis dependency property.
Declaration
public static readonly DependencyProperty ActualDependentAxisProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
ActualIndependentAxisProperty
Identifies the ActualIndependentAxis dependency property.
Declaration
public static readonly DependencyProperty ActualIndependentAxisProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
DependentAxisProperty
Identifies the DependentAxis dependency property.
Declaration
public static readonly DependencyProperty DependentAxisProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
IndependentAxisProperty
Identifies the IndependentAxis dependency property.
Declaration
public static readonly DependencyProperty IndependentAxisProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
SelectedIndexProperty
Identifies the SelectedIndex dependency property.
Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
SelectedItemProperty
Identifies the SelectedItem dependency property.
Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
SelectionModeProperty
Identifies the SelectionMode dependency property.
Declaration
public static readonly DependencyProperty SelectionModeProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
Properties
| Improve this Doc View SourceActualDependentAxis
Gets the rendered dependent axis of the series.
Declaration
public IAxis ActualDependentAxis { get; protected set; }
Property Value
Type | Description |
---|---|
IAxis |
ActualDependentRangeAxis
Gets the ActualDependentAxis as an IRangeAxis instance.
Declaration
protected IRangeAxis ActualDependentRangeAxis { get; }
Property Value
Type | Description |
---|---|
IRangeAxis |
ActualIndependentAxis
Gets the rendered independent axis of the series.
Declaration
public IAxis ActualIndependentAxis { get; protected set; }
Property Value
Type | Description |
---|---|
IAxis |
DataItems
Gets the collection of DataItems representing the data of the series.
Declaration
protected ObservableCollection<DefinitionSeries.DataItem> DataItems { get; }
Property Value
Type | Description |
---|---|
ObservableCollection<DefinitionSeries.DataItem> |
DependentAxis
Gets or sets the dependent axis of the series.
Declaration
public IAxis DependentAxis { get; set; }
Property Value
Type | Description |
---|---|
IAxis |
IndependentAxis
Gets or sets the independent axis of the series.
Declaration
public IAxis IndependentAxis { get; set; }
Property Value
Type | Description |
---|---|
IAxis |
IndependentValueDependentValues
Gets a sequence of sequences of the dependent values associated with each independent value.
Declaration
protected IEnumerable<IEnumerable<double>> IndependentValueDependentValues { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.Collections.Generic.IEnumerable<System.Double>> |
IndependentValueGroups
Gets a sequence of IndependentValueGroups.
Declaration
protected virtual IEnumerable<DefinitionSeries.IndependentValueGroup> IndependentValueGroups { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<DefinitionSeries.IndependentValueGroup> |
IndependentValueGroupsOrderedByIndependentValue
Gets a sequence of IndependentValueGroups ordered by independent value.
Declaration
protected IEnumerable<DefinitionSeries.IndependentValueGroup> IndependentValueGroupsOrderedByIndependentValue { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<DefinitionSeries.IndependentValueGroup> |
IsStacked100
Gets or sets a value indicating whether the series is 100% stacked (versus normally stacked).
Declaration
protected bool IsStacked100 { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LegendItems
Gets the collection of legend items for the series.
Declaration
public ObservableCollection<object> LegendItems { get; }
Property Value
Type | Description |
---|---|
ObservableCollection<System.Object> |
SelectedIndex
Gets or sets the SelectedIndex property.
Declaration
public int SelectedIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
SelectedItem
Gets or sets the SelectedItem property.
Declaration
public object SelectedItem { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
SelectedItems
Gets the currently selected items.
Declaration
public IList SelectedItems { get; }
Property Value
Type | Description |
---|---|
System.Collections.IList |
Remarks
This property is meant to be used when SelectionMode is Multiple. If the selection mode is Single the correct property to use is SelectedItem.
SelectionMode
Gets or sets the SelectionMode property.
Declaration
public SeriesSelectionMode SelectionMode { get; set; }
Property Value
Type | Description |
---|---|
SeriesSelectionMode |
SeriesArea
Gets the SeriesArea template part instance.
Declaration
protected Panel SeriesArea { get; }
Property Value
Type | Description |
---|---|
Panel |
SeriesDefinitions
Gets or sets the collection of SeriesDefinitions that define the series.
Declaration
public Collection<SeriesDefinition> SeriesDefinitions { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.Collection<SeriesDefinition> |
SeriesHost
Gets or sets the SeriesHost for the series.
Declaration
public ISeriesHost SeriesHost { get; set; }
Property Value
Type | Description |
---|---|
ISeriesHost |
Methods
| Improve this Doc View SourceAcquireDependentAxis()
Acquires a dependent axis suitable for use with the data values of the series.
Declaration
protected abstract IAxis AcquireDependentAxis()
Returns
Type | Description |
---|---|
IAxis | Axis instance. |
AcquireIndependentAxis()
Acquires an independent axis suitable for use with the data values of the series.
Declaration
protected abstract IAxis AcquireIndependentAxis()
Returns
Type | Description |
---|---|
IAxis | Axis instance. |
ArrangeOverride(Size)
Called when the control needs to arrange its children.
Declaration
protected override Size ArrangeOverride(Size arrangeBounds)
Parameters
Type | Name | Description |
---|---|---|
Size | arrangeBounds | Bounds to arrange within. |
Returns
Type | Description |
---|---|
Size | Arranged size. |
Overrides
Remarks
Used as a good place to dequeue queued work.
CreateDataPoint()
Creates a DataPoint for the series.
Declaration
protected abstract DataPoint CreateDataPoint()
Returns
Type | Description |
---|---|
DataPoint | Series-appropriate DataPoint instance. |
DataItemFromDataPoint(DataPoint)
Returns the DataItem corresponding to the specified DataPoint.
Declaration
protected DefinitionSeries.DataItem DataItemFromDataPoint(DataPoint dataPoint)
Parameters
Type | Name | Description |
---|---|---|
DataPoint | dataPoint | Specified DataPoint. |
Returns
Type | Description |
---|---|
DefinitionSeries.DataItem | Corresponding DataItem. |
IDataProviderGetData(IDataConsumer)
Returns the data for the data points of the series.
Declaration
protected virtual IEnumerable<object> IDataProviderGetData(IDataConsumer dataConsumer)
Parameters
Type | Name | Description |
---|---|---|
IDataConsumer | dataConsumer | Consumer of the data. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.Object> | Sequence of data. |
IRangeProviderGetRange(IRangeConsumer)
Returns the range for the data points of the series.
Declaration
protected virtual Range<IComparable> IRangeProviderGetRange(IRangeConsumer rangeConsumer)
Parameters
Type | Name | Description |
---|---|---|
IRangeConsumer | rangeConsumer | Consumer of the range. |
Returns
Type | Description |
---|---|
Range<System.IComparable> | Range of values. |
IValueMarginProviderGetValueMargins(IValueMarginConsumer)
Returns the value margins for the data points of the series.
Declaration
protected virtual IEnumerable<ValueMargin> IValueMarginProviderGetValueMargins(IValueMarginConsumer valueMarginConsumer)
Parameters
Type | Name | Description |
---|---|---|
IValueMarginConsumer | valueMarginConsumer | Consumer of the value margins. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ValueMargin> | Sequence of value margins. |
NotifyAxisValuesChanged(IAxis)
Notifies the specified axis of changes to values plotting against it.
Declaration
protected void NotifyAxisValuesChanged(IAxis axis)
Parameters
Type | Name | Description |
---|---|---|
IAxis | axis | Specified axis. |
NotifyValueMarginsChanged(IAxis, IEnumerable<ValueMargin>)
Notifies the specified axis of changes to value margins plotting against it.
Declaration
protected void NotifyValueMarginsChanged(IAxis axis, IEnumerable<ValueMargin> valueMargins)
Parameters
Type | Name | Description |
---|---|---|
IAxis | axis | Specified axis. |
System.Collections.Generic.IEnumerable<ValueMargin> | valueMargins | Sequence of value margins that have changed. |
OnApplyTemplate()
Builds the visual tree for the control when a new template is applied.
Declaration
public override void OnApplyTemplate()
Overrides
| Improve this Doc View SourcePrepareDataPoint(DataPoint)
Prepares a DataPoint for use.
Declaration
protected virtual void PrepareDataPoint(DataPoint dataPoint)
Parameters
Type | Name | Description |
---|---|---|
DataPoint | dataPoint | DataPoint instance. |
SeriesDefinitionsCollectionChanged(NotifyCollectionChangedAction, IList, Int32, IList, Int32)
Handles the CollectionChanged event of the SeriesDefinitions collection.
Declaration
protected virtual void SeriesDefinitionsCollectionChanged(NotifyCollectionChangedAction action, IList oldItems, int oldStartingIndex, IList newItems, int newStartingIndex)
Parameters
Type | Name | Description |
---|---|---|
NotifyCollectionChangedAction | action | Type of change. |
System.Collections.IList | oldItems | Sequence of old items. |
System.Int32 | oldStartingIndex | Starting index of old items. |
System.Collections.IList | newItems | Sequence of new items. |
System.Int32 | newStartingIndex | Starting index of new items. |
UpdateDataItemPlacement(IEnumerable<DefinitionSeries.DataItem>)
Updates the placement of the DataItems (data points) of the series.
Declaration
protected abstract void UpdateDataItemPlacement(IEnumerable<DefinitionSeries.DataItem> dataItems)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<DefinitionSeries.DataItem> | dataItems | DataItems in need of an update. |
Events
| Improve this Doc View SourceSelectionChanged
Occurs when the selection of a DefinitionSeries changes.
Declaration
public event SelectionChangedEventHandler SelectionChanged
Event Type
Type | Description |
---|---|
SelectionChangedEventHandler |
Explicit Interface Implementations
| Improve this Doc View SourceIAxisListener.AxisInvalidated(IAxis)
Handles notification of the invalidation of an axis.
Declaration
void IAxisListener.AxisInvalidated(IAxis axis)
Parameters
Type | Name | Description |
---|---|---|
IAxis | axis | Invalidated axis. |
IDataProvider.GetData(IDataConsumer)
Returns the data for the data points of the series.
Declaration
IEnumerable<object> IDataProvider.GetData(IDataConsumer dataConsumer)
Parameters
Type | Name | Description |
---|---|---|
IDataConsumer | dataConsumer | Consumer of the data. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.Object> | Sequence of data. |
IRangeProvider.GetRange(IRangeConsumer)
Returns the range for the data points of the series.
Declaration
Range<IComparable> IRangeProvider.GetRange(IRangeConsumer rangeConsumer)
Parameters
Type | Name | Description |
---|---|---|
IRangeConsumer | rangeConsumer | Consumer of the range. |
Returns
Type | Description |
---|---|
Range<System.IComparable> | Range of values. |
ISeriesHost.Axes
Gets the axes for the series as a series host.
Declaration
ObservableCollection<IAxis> ISeriesHost.Axes { get; }
Returns
Type | Description |
---|---|
ObservableCollection<IAxis> |
ISeriesHost.BackgroundElements
Gets the background elements for the series as a series host.
Declaration
ObservableCollection<UIElement> ISeriesHost.BackgroundElements { get; }
Returns
Type | Description |
---|---|
ObservableCollection<UIElement> |
ISeriesHost.ForegroundElements
Gets the foreground elements for the series as a series host.
Declaration
ObservableCollection<UIElement> ISeriesHost.ForegroundElements { get; }
Returns
Type | Description |
---|---|
ObservableCollection<UIElement> |
ISeriesHost.Series
Gets the series for the series as a series host.
Declaration
ObservableCollection<ISeries> ISeriesHost.Series { get; }
Returns
Type | Description |
---|---|
ObservableCollection<ISeries> |
IValueMarginProvider.GetValueMargins(IValueMarginConsumer)
Returns the value margins for the data points of the series.
Declaration
IEnumerable<ValueMargin> IValueMarginProvider.GetValueMargins(IValueMarginConsumer valueMarginConsumer)
Parameters
Type | Name | Description |
---|---|---|
IValueMarginConsumer | valueMarginConsumer | Consumer of the value margins. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ValueMargin> | Sequence of value margins. |
IResourceDictionaryDispenser.GetResourceDictionariesWhere(Func<ResourceDictionary, Boolean>)
Gets a IResourceDictionaryDispenser for the series as a series host.
Declaration
IEnumerator<ResourceDictionary> IResourceDictionaryDispenser.GetResourceDictionariesWhere(Func<ResourceDictionary, bool> predicate)
Parameters
Type | Name | Description |
---|---|---|
System.Func<ResourceDictionary, System.Boolean> | predicate | Predicate function. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<ResourceDictionary> | Sequence of ResourceDictionaries. |
IResourceDictionaryDispenser.ResourceDictionariesChanged
Event that is triggered when the available ResourceDictionaries change.
Declaration
event EventHandler IResourceDictionaryDispenser.ResourceDictionariesChanged
Returns
Type | Description |
---|---|
System.EventHandler |