Class
ChartSeriesDescriptor

Represents an abstract definition of a ChartSeries instance. Used together with a ChartSeriesProvider instance to provide dynamic chart series generation, depending on the data specified. The descriptors form a neat hierarchy based on the type of data visualized - e.g. Categorical, Scatter, Financial, etc. This is the base class which encapsulates all the common functionality for all concrete descriptors.

Definition

Namespace:Telerik.UI.Xaml.Controls.Chart

Assembly:Telerik.WinUI.Controls.dll

Syntax:

cs-api-definition
public abstract class ChartSeriesDescriptor : DependencyObject

Inheritance: objectChartSeriesDescriptor

Derived Classes: CategoricalSeriesDescriptorBaseScatterSeriesDescriptor

Constructors

ChartSeriesDescriptor()

Declaration

cs-api-definition
protected ChartSeriesDescriptor()

Fields

CollectionIndexProperty

Identifies the CollectionIndex dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CollectionIndexProperty

Field Value

DependencyProperty

ItemsSourcePathProperty

Identifies the ItemsSourcePath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemsSourcePathProperty

Field Value

DependencyProperty

LegendTitlePathProperty

Identifies the LegendTitlePath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LegendTitlePathProperty

Field Value

DependencyProperty

StyleProperty

Identifies the Style dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty StyleProperty

Field Value

DependencyProperty

TypePathProperty

Identifies the TypePath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TypePathProperty

Field Value

DependencyProperty

Properties

CollectionIndex

Gets or sets the index within the Source collection of data (view models) for which the current descriptor should be used. This property is useful when for example a BarSeries needs to be generated for the first data entry and LineSeries for the rest of the entries.

Declaration

cs-api-definition
public int CollectionIndex { get; set; }

Property Value

int

DefaultType

Gets the default type of series that are to be created if no TypePath and no Style properties are specified.

Declaration

cs-api-definition
public abstract Type DefaultType { get; }

Property Value

Type

ItemsSourcePath

Gets or sets the name of the property that points to the items source that will feed the generated series.

Declaration

cs-api-definition
public string ItemsSourcePath { get; set; }

Property Value

string

LegendTitlePath

Gets or sets the name of the property that defines the LegendTitle for each series created.

Declaration

cs-api-definition
public string LegendTitlePath { get; set; }

Property Value

string

Style

Gets or sets the Style that describes the appearance of the series that are to be created. If no TypePath is specified, the TargetType property of this style object is used to generate the desired series.

Declaration

cs-api-definition
public Style Style { get; set; }

Property Value

Style

TypePath

Gets or sets the name of the property that points to the series type that needs to be created.

Declaration

cs-api-definition
public string TypePath { get; set; }

Property Value

string

Methods

CreateDefaultInstance(object)

Provides the default implementation for the routine.

Declaration

cs-api-definition
protected ChartSeries CreateDefaultInstance(object context)

Parameters

context

object

Returns

ChartSeries

CreateInstance(object)

Creates an instance of the ChartSeries type, defined by this descriptor.

Declaration

cs-api-definition
public ChartSeries CreateInstance(object context)

Parameters

context

object

The context (this is the raw data collection or the data view model) for which a ChartSeries needs to be created.

Returns

ChartSeries

CreateInstanceCore(object)

Core entry point for creating the ChartSeries type defined by this descriptor. Allows inheritors to provide custom implementation.

Declaration

cs-api-definition
protected virtual ChartSeries CreateInstanceCore(object context)

Parameters

context

object

The context (this is the raw data collection or the data view model) for which a ChartSeries needs to be created.

Returns

ChartSeries