Class DefinitionSeries

Implements a series that is defined by one or more instances of the DefinitionSeries class.

Inheritance
System.Object
DependencyObject
UIElement
FrameworkElement
Control
DefinitionSeries
StackedAreaLineSeries
StackedBarColumnSeries
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Controls.DataVisualization.Charting
Assembly: OpenSilver.Controls.DataVisualization.Toolkit.dll
Syntax
[TemplatePart(Name = "SeriesArea", Type = typeof(Grid))]
[TemplatePart(Name = "ItemContainer", Type = typeof(DelegatingListBox))]
public abstract class DefinitionSeries : Control, IControl, IFrameworkElement, IUIElement, IDependencyObject, ISeries, IAxisListener, IRangeProvider, IValueMarginProvider, IDataProvider, ISeriesHost, IRequireSeriesHost, IResourceDictionaryDispenser

Constructors

| Improve this Doc View Source

DefinitionSeries()

Initializes a new instance of the DefinitionSeries class.

Declaration
protected DefinitionSeries()

Fields

| Improve this Doc View Source

ActualDependentAxisProperty

Identifies the ActualDependentAxis dependency property.

Declaration
public static readonly DependencyProperty ActualDependentAxisProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

ActualIndependentAxisProperty

Identifies the ActualIndependentAxis dependency property.

Declaration
public static readonly DependencyProperty ActualIndependentAxisProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

DependentAxisProperty

Identifies the DependentAxis dependency property.

Declaration
public static readonly DependencyProperty DependentAxisProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

IndependentAxisProperty

Identifies the IndependentAxis dependency property.

Declaration
public static readonly DependencyProperty IndependentAxisProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

SelectedIndexProperty

Identifies the SelectedIndex dependency property.

Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

SelectionModeProperty

Identifies the SelectionMode dependency property.

Declaration
public static readonly DependencyProperty SelectionModeProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

ActualDependentAxis

Gets the rendered dependent axis of the series.

Declaration
public IAxis ActualDependentAxis { get; protected set; }
Property Value
Type Description
IAxis
| Improve this Doc View Source

ActualDependentRangeAxis

Gets the ActualDependentAxis as an IRangeAxis instance.

Declaration
protected IRangeAxis ActualDependentRangeAxis { get; }
Property Value
Type Description
IRangeAxis
| Improve this Doc View Source

ActualIndependentAxis

Gets the rendered independent axis of the series.

Declaration
public IAxis ActualIndependentAxis { get; protected set; }
Property Value
Type Description
IAxis
| Improve this Doc View Source

DataItems

Gets the collection of DataItems representing the data of the series.

Declaration
protected ObservableCollection<DefinitionSeries.DataItem> DataItems { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<DefinitionSeries.DataItem>
| Improve this Doc View Source

DependentAxis

Gets or sets the dependent axis of the series.

Declaration
public IAxis DependentAxis { get; set; }
Property Value
Type Description
IAxis
| Improve this Doc View Source

IndependentAxis

Gets or sets the independent axis of the series.

Declaration
public IAxis IndependentAxis { get; set; }
Property Value
Type Description
IAxis
| Improve this Doc View Source

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>>
| Improve this Doc View Source

IndependentValueGroups

Gets a sequence of IndependentValueGroups.

Declaration
protected virtual IEnumerable<DefinitionSeries.IndependentValueGroup> IndependentValueGroups { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DefinitionSeries.IndependentValueGroup>
| Improve this Doc View Source

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>
| Improve this Doc View Source

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
| Improve this Doc View Source

LegendItems

Gets the collection of legend items for the series.

Declaration
public ObservableCollection<object> LegendItems { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<System.Object>
| Improve this Doc View Source

SelectedIndex

Gets or sets the SelectedIndex property.

Declaration
public int SelectedIndex { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SelectedItem

Gets or sets the SelectedItem property.

Declaration
public object SelectedItem { get; set; }
Property Value
Type Description
System.Object
| Improve this Doc View Source

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.

| Improve this Doc View Source

SelectionMode

Gets or sets the SelectionMode property.

Declaration
public SeriesSelectionMode SelectionMode { get; set; }
Property Value
Type Description
SeriesSelectionMode
| Improve this Doc View Source

SeriesArea

Gets the SeriesArea template part instance.

Declaration
protected Panel SeriesArea { get; }
Property Value
Type Description
Panel
| Improve this Doc View Source

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>
| Improve this Doc View Source

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 Source

AcquireDependentAxis()

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.

| Improve this Doc View Source

CreateDataPoint()

Creates a DataPoint for the series.

Declaration
protected abstract DataPoint CreateDataPoint()
Returns
Type Description
DataPoint

Series-appropriate DataPoint instance.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

OnApplyTemplate()

Builds the visual tree for the control when a new template is applied.

Declaration
public override void OnApplyTemplate()
Overrides
| Improve this Doc View Source

PrepareDataPoint(DataPoint)

Prepares a DataPoint for use.

Declaration
protected virtual void PrepareDataPoint(DataPoint dataPoint)
Parameters
Type Name Description
DataPoint dataPoint

DataPoint instance.
| Improve this Doc View Source

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
System.Collections.Specialized.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.
| Improve this Doc View Source

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 Source

SelectionChanged

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 Source

IAxisListener.AxisInvalidated(IAxis)

Handles notification of the invalidation of an axis.

Declaration
void IAxisListener.AxisInvalidated(IAxis axis)
Parameters
Type Name Description
IAxis axis

Invalidated axis.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

ISeriesHost.Axes

Gets the axes for the series as a series host.

Declaration
ObservableCollection<IAxis> ISeriesHost.Axes { get; }
Returns
Type Description
System.Collections.ObjectModel.ObservableCollection<IAxis>
| Improve this Doc View Source

ISeriesHost.BackgroundElements

Gets the background elements for the series as a series host.

Declaration
ObservableCollection<UIElement> ISeriesHost.BackgroundElements { get; }
Returns
Type Description
System.Collections.ObjectModel.ObservableCollection<UIElement>
| Improve this Doc View Source

ISeriesHost.ForegroundElements

Gets the foreground elements for the series as a series host.

Declaration
ObservableCollection<UIElement> ISeriesHost.ForegroundElements { get; }
Returns
Type Description
System.Collections.ObjectModel.ObservableCollection<UIElement>
| Improve this Doc View Source

ISeriesHost.Series

Gets the series for the series as a series host.

Declaration
ObservableCollection<ISeries> ISeriesHost.Series { get; }
Returns
Type Description
System.Collections.ObjectModel.ObservableCollection<ISeries>
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

IResourceDictionaryDispenser.ResourceDictionariesChanged

Event that is triggered when the available ResourceDictionaries change.

Declaration
event EventHandler IResourceDictionaryDispenser.ResourceDictionariesChanged
Returns
Type Description
System.EventHandler

Implements

Extension Methods