Documentation

Class ChartSeries

Base class for all series of data points, plotted on a RadChartBase instance.

Inheritance
System.Object
RadControlBase
PresenterBase
ChartElementPresenter
ChartSeries
FunnelSeries
IndicatorBase
PieSeries
PointTemplateSeries
Inherited Members
Namespace: Telerik.Windows.Controls.ChartView
Assembly: Telerik.Windows.Controls.Chart.dll

Syntax

public abstract class ChartSeries : ChartElementPresenter, IChartElementPresenterWithMargin, IChartSeries, IChartElementPresenter, ISeries

Constructors

ChartSeries()

Initializes a new instance of the ChartSeries class.

Declaration
protected ChartSeries()

Fields

AllowSelectProperty

Identifies the AllowSelect property.

Declaration
public static readonly DependencyProperty AllowSelectProperty
Field Value
System.Windows.DependencyProperty

ClipToPlotAreaProperty

Identifies the ClipToPlotArea property.

Declaration
public static readonly DependencyProperty ClipToPlotAreaProperty
Field Value
System.Windows.DependencyProperty

DisplayNameProperty

Identifies the DisplayName dependency property.

Declaration
public static readonly DependencyProperty DisplayNameProperty
Field Value
System.Windows.DependencyProperty

IsSelectedProperty

Identifies the IsSelected property.

Declaration
public static readonly DependencyProperty IsSelectedProperty
Field Value
System.Windows.DependencyProperty

ItemsSourceProperty

Identifies the ItemsSource property.

Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
System.Windows.DependencyProperty

LabelConnectorsSettingsProperty

Identifies the LabelConnectorsSettings dependency property.

Declaration
public static readonly DependencyProperty LabelConnectorsSettingsProperty
Field Value
System.Windows.DependencyProperty

PointAnimationProperty

Identifies the PointAnimation property.

Declaration
public static readonly DependencyProperty PointAnimationProperty
Field Value
System.Windows.DependencyProperty

SeriesAnimationProperty

Identifies the SeriesAnimation property.

Declaration
public static readonly DependencyProperty SeriesAnimationProperty
Field Value
System.Windows.DependencyProperty

ShowLabelsProperty

Identifies the ShowLabels property.

Declaration
public static readonly DependencyProperty ShowLabelsProperty
Field Value
System.Windows.DependencyProperty

TooltipTemplateProperty

Identifies the TooltipTemplate dependency property.

Declaration
public static readonly DependencyProperty TooltipTemplateProperty
Field Value
System.Windows.DependencyProperty

TrackBallInfoTemplateProperty

Identifies the TrackBallInfoTemplate property.

Declaration
public static readonly DependencyProperty TrackBallInfoTemplateProperty
Field Value
System.Windows.DependencyProperty

TrackBallTemplateProperty

Identifies the TrackBallTemplate property.

Declaration
public static readonly DependencyProperty TrackBallTemplateProperty
Field Value
System.Windows.DependencyProperty

Properties

AllowSelect

Determines whether the series might enter the IsSelected state.

Declaration
public bool AllowSelect { get; set; }
Property Value
System.Boolean

ClipToPlotArea

Gets or sets a value indicating whether this instance will be clipped to the bounds of the plot area.

Declaration
public bool ClipToPlotArea { get; set; }
Property Value
System.Boolean

DisplayName

Gets or sets the human-readable name of the series.

Declaration
public string DisplayName { get; set; }
Property Value
System.String

IsSelected

Gets or sets a value indicating whether the series is currently in a "Selected" state. Usually this state is indicated by a change in the visual representation of the series.

Declaration
public bool IsSelected { get; set; }
Property Value
System.Boolean

ItemsSource

Gets or sets the source items to generate data points from.

Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

LabelConnectorsSettings

Gets or sets the connectors settings. When the value of this property is null, label connectors are not drawn.

Declaration
public ChartSeriesLabelConnectorsSettings LabelConnectorsSettings { get; set; }
Property Value
ChartSeriesLabelConnectorsSettings

LabelDefinitions

Gets the collection that stores all the definitions that describe the appearance of each label per data point. When ShowLabels is true and no custom definition is present within the collection, a default one is used.

Declaration
public ObservableCollection<ChartSeriesLabelDefinition> LabelDefinitions { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<ChartSeriesLabelDefinition>

PointAnimation

Gets or sets the animation for this data points in this series instance.

Declaration
public ChartAnimationBase PointAnimation { get; set; }
Property Value
ChartAnimationBase

SeriesAnimation

Gets or sets the animation for this series instance.

Declaration
public ChartAnimationBase SeriesAnimation { get; set; }
Property Value
ChartAnimationBase

ShowLabels

Gets or sets a value indicating whether the series will display a label associated with each data point.

Declaration
public bool ShowLabels { get; set; }
Property Value
System.Boolean

TooltipTemplate

Gets or sets the ContentTemplate of the tooltip that is shown by the ChartTooltipBehavior. This property has a higher priority than the TooltipTemplate property of the chart.

Declaration
public DataTemplate TooltipTemplate { get; set; }
Property Value
System.Windows.DataTemplate

TrackBallInfoTemplate

Gets or sets the template used to visualize the information about this series in a ChartTrackBallBehavior TrackInfo control.

Declaration
public DataTemplate TrackBallInfoTemplate { get; set; }
Property Value
System.Windows.DataTemplate

TrackBallTemplate

Gets or sets the template used to visualize an intersection point between a ChartTrackBallBehavior line and a data point that is contained within this series.

Declaration
public DataTemplate TrackBallTemplate { get; set; }
Property Value
System.Windows.DataTemplate

Methods

GetDataPointLabels(DataPoint)

Gets all the System.Windows.FrameworkElement instances that represent labels, associated with the specified DataPoint instance.

Declaration
public IEnumerable<FrameworkElement> GetDataPointLabels(DataPoint point)
Parameters
DataPoint point

Returns
System.Collections.Generic.IEnumerable<System.Windows.FrameworkElement>

GetLabelConnector(ChartSeriesLabelPositionInfo)

Gets the points which build the label connector polyline.

Declaration
protected virtual List<Point> GetLabelConnector(ChartSeriesLabelPositionInfo info)
Parameters
ChartSeriesLabelPositionInfo info

Returns
System.Collections.Generic.List<System.Windows.Point>

HitTest(Rect)

Determines whether the provided touch System.Windows.Rect is within the series visual representation.

Declaration
public virtual bool HitTest(Rect touchRect)
Parameters
System.Windows.Rect touchRect

Returns
System.Boolean

HitTestDataPoints(Rect)

Finds all the data points which visual representations contain the specified touch System.Windows.Rect.

Declaration
public IEnumerable<DataPoint> HitTestDataPoints(Rect touchRect)
Parameters
System.Windows.Rect touchRect

Returns
System.Collections.Generic.IEnumerable<DataPoint>

HitTestDataPointsCore(Rect)

Performs the core logic behind the HitTestDataPoints(Rect) method.

Declaration
protected virtual IEnumerable<DataPoint> HitTestDataPointsCore(Rect touchRect)
Parameters
System.Windows.Rect touchRect

Returns
System.Collections.Generic.IEnumerable<DataPoint>

HitTestElements(Rect)

Finds all the visual representations that contain the specified touch System.Windows.Rect.

Declaration
public IEnumerable<FrameworkElement> HitTestElements(Rect touchRect)
Parameters
System.Windows.Rect touchRect

Returns
System.Collections.Generic.IEnumerable<System.Windows.FrameworkElement>

HitTestElementsCore(Rect)

Performs the core logic behind the HitTestElements(Rect) method.

Declaration
protected virtual IEnumerable<FrameworkElement> HitTestElementsCore(Rect touchRect)
Parameters
System.Windows.Rect touchRect

Returns
System.Collections.Generic.IEnumerable<System.Windows.FrameworkElement>

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks.

Declaration
public override void OnApplyTemplate()
Overrides

OnAttached()

Occurs when the presenter has been successfully attached to its owning RadChartBase instance.

Declaration
protected override void OnAttached()
Overrides

OnDetached(RadChartBase)

Occurs when the presenter has been successfully detached from its owning RadChartBase instance.

Declaration
protected override void OnDetached(RadChartBase oldChart)
Parameters
RadChartBase oldChart

Overrides

OnLoaded(Object, RoutedEventArgs)

Occurs when a System.Windows.FrameworkElement has been constructed and added to the object tree.

Declaration
protected override void OnLoaded(object sender, RoutedEventArgs e)
Parameters
System.Object sender

System.Windows.RoutedEventArgs e

Overrides

OnPlayPointAnimations(Boolean)

Occurs when the PointAnimation for every datapoint is about to be played.

Declaration
protected virtual void OnPlayPointAnimations(bool hidePointsOnLoad)
Parameters
System.Boolean hidePointsOnLoad

OnPlaySeriesAnimation(Boolean)

Occurs when the SeriesAnimation is about to be played.

Declaration
protected virtual void OnPlaySeriesAnimation(bool hideSeriesOnLoad)
Parameters
System.Boolean hideSeriesOnLoad

OnVisibilityChanged()

Occurs when the System.Windows.UIElement.Visibility has been changed.

Declaration
protected virtual void OnVisibilityChanged()

PlayPointAnimations()

Plays the PointAnimation for all data points in this series instance.

Declaration
public void PlayPointAnimations()

PlaySeriesAnimation()

Plays the SeriesAnimation for this series instance.

Declaration
public void PlaySeriesAnimation()

Events

DataBindingComplete

Occurs when a databinding operation has been successfully completed.

Declaration
public event EventHandler DataBindingComplete
Event Type
System.EventHandler

PointAnimationsCompleted

Occurs when the PointAnimation for every datapoint of this series has completed.

Declaration
public event EventHandler PointAnimationsCompleted
Event Type
System.EventHandler

SeriesAnimationCompleted

Occurs when the SeriesAnimation has completed.

Declaration
public event EventHandler SeriesAnimationCompleted
Event Type
System.EventHandler

Extension Methods