Class ChartSeries
Represents the chart series base, which is used to visualize the data graphically
Namespace: Syncfusion.UI.Xaml.SmithChart
Assembly: Syncfusion.SfSmithChart.WPF.dll
Syntax
public abstract class ChartSeries : Control
Constructors
ChartSeries()
Initializes a new instance of the ChartSeries class.
Declaration
public ChartSeries()
Fields
AnimationDurationProperty
The DependencyProperty for AnimationDuration property.
Declaration
public static readonly DependencyProperty AnimationDurationProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ArrangeByIndexProperty
The DependencyProperty for ArrangeByIndex property.
Declaration
public static readonly DependencyProperty ArrangeByIndexProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ColorModelProperty
The DependencyProperty for ColorModel property.
Declaration
public static readonly DependencyProperty ColorModelProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
DataLabelProperty
The DependencyProperty for DataLabel property.
Declaration
public static readonly DependencyProperty DataLabelProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
EnableAnimationProperty
The DependencyProperty for EnableAnimation property.
Declaration
public static readonly DependencyProperty EnableAnimationProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
InteriorProperty
The DependencyProperty for Interior property.
Declaration
public static readonly DependencyProperty InteriorProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
IsSeriesVisibleProperty
The DependencyProperty for IsSeriesVisible property.
Declaration
public static readonly DependencyProperty IsSeriesVisibleProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ItemsSourceProperty
The DependencyProperty for ItemsSource property.
Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
LabelProperty
The DependencyProperty for Label property.
Declaration
public static readonly DependencyProperty LabelProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MarkerHeightProperty
The DependencyProperty for MarkerHeight property.
Declaration
public static readonly DependencyProperty MarkerHeightProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MarkerInteriorProperty
The DependencyProperty for MarkerInterior property.
Declaration
public static readonly DependencyProperty MarkerInteriorProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MarkerStrokeProperty
The DependencyProperty for MarkerStroke property.
Declaration
public static readonly DependencyProperty MarkerStrokeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MarkerTemplateProperty
The DependencyProperty for MarkerTemplate property.
Declaration
public static readonly DependencyProperty MarkerTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MarkerTypeProperty
The DependencyProperty for MarkerType property.
Declaration
public static readonly DependencyProperty MarkerTypeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MarkerWidthProperty
The DependencyProperty for MarkerWidth property.
Declaration
public static readonly DependencyProperty MarkerWidthProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ReactancePathProperty
The DependencyProperty for ReactancePath property.
Declaration
public static readonly DependencyProperty ReactancePathProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ResistancePathProperty
The DependencyProperty for ResistancePath property.
Declaration
public static readonly DependencyProperty ResistancePathProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ShowMarkerProperty
The DependencyProperty for ShowMarker property.
Declaration
public static readonly DependencyProperty ShowMarkerProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ShowToolTipProperty
The DependencyProperty for ShowToolTip property.
Declaration
public static readonly DependencyProperty ShowToolTipProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeThicknessProperty
The DependencyProperty for StrokeThickness property.
Declaration
public static readonly DependencyProperty StrokeThicknessProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ToolTipDurationProperty
The DependencyProperty for ToolTipDuration property.
Declaration
public static readonly DependencyProperty ToolTipDurationProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ToolTipTemplateProperty
The DependencyProperty for ToolTipTemplate property.
Declaration
public static readonly DependencyProperty ToolTipTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
VisibilityOnLegendProperty
The DependencyProperty for VisibilityOnLegend property.
Declaration
public static readonly DependencyProperty VisibilityOnLegendProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
Properties
AnimationDuration
Gets or sets the duration of the animation.
Declaration
public TimeSpan AnimationDuration { get; set; }
Property Value
Type |
---|
System.TimeSpan |
ArrangeByIndex
Gets or sets a value indicating whether to render the data based on the provided index order.
Declaration
public bool ArrangeByIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The data points are rendered based on the provided index when it is true; otherwise, the data points are rendered by shorting based on its resistance value. The default value is false. |
ColorModel
Gets or sets the SmithChartColorModel for the series.
Declaration
public SmithChartColorModel ColorModel { get; set; }
Property Value
Type |
---|
SmithChartColorModel |
DataCount
Gets the number of points given as input.
Declaration
public int DataCount { get; }
Property Value
Type |
---|
System.Int32 |
DataLabel
Gets or sets a value to show dataLabel.
Declaration
public DataLabel DataLabel { get; set; }
Property Value
Type |
---|
DataLabel |
EnableAnimation
Gets or sets a value indicating whether to animate the series. It animates the series only on loading the chart, or change to another series.
Declaration
public bool EnableAnimation { get; set; }
Property Value
Type |
---|
System.Boolean |
Interior
Gets or sets a value to change the series fill color
Declaration
public Brush Interior { get; set; }
Property Value
Type |
---|
System.Windows.Media.Brush |
IsSeriesVisible
Gets or sets a value indicating whether the series is visible.
Declaration
public bool IsSeriesVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
ItemsSource
Gets or sets an IEnumerable source used to generate Chart.
Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.IEnumerable | The DataSource value. |
Label
Gets or sets the label that will be displayed in the associated legend item.
Declaration
public string Label { get; set; }
Property Value
Type |
---|
System.String |
MarkerHeight
Gets or sets a value to change the marker height
Declaration
public double MarkerHeight { get; set; }
Property Value
Type |
---|
System.Double |
MarkerInterior
Gets or sets a value to change the marker fill color
Declaration
public Brush MarkerInterior { get; set; }
Property Value
Type |
---|
System.Windows.Media.Brush |
MarkerStroke
Gets or sets a value to change the marker stroke color
Declaration
public Brush MarkerStroke { get; set; }
Property Value
Type |
---|
System.Windows.Media.Brush |
MarkerTemplate
Gets or sets the template for the marker.
Declaration
public DataTemplate MarkerTemplate { get; set; }
Property Value
Type |
---|
System.Windows.DataTemplate |
MarkerType
Gets or sets a value to change the marker shapes
Declaration
public MarkerType MarkerType { get; set; }
Property Value
Type |
---|
MarkerType |
MarkerWidth
Gets or sets a value to change the marker width
Declaration
public double MarkerWidth { get; set; }
Property Value
Type |
---|
System.Double |
ReactancePath
Gets or sets the property path of the Reactance data in ItemsSource.
Declaration
public string ReactancePath { get; set; }
Property Value
Type |
---|
System.String |
ResistancePath
Gets or sets the property path of the Resistance data in ItemsSource.
Declaration
public string ResistancePath { get; set; }
Property Value
Type |
---|
System.String |
Segments
Gets or sets the segments of the series.
Declaration
protected ObservableCollection<ChartSegment> Segments { get; set; }
Property Value
Type |
---|
System.Collections.ObjectModel.ObservableCollection<ChartSegment> |
ShowMarker
Gets or sets a value indicating whether to change the marker visibility
Declaration
public bool ShowMarker { get; set; }
Property Value
Type |
---|
System.Boolean |
ShowToolTip
Gets or sets a value indicating whether to change the tooltip visibility
Declaration
public bool ShowToolTip { get; set; }
Property Value
Type |
---|
System.Boolean |
StrokeThickness
Gets or sets a value to change the series stroke thickness
Declaration
public double StrokeThickness { get; set; }
Property Value
Type |
---|
System.Double |
ToolTipDuration
Gets or sets the duration of the Tooltip display on screen.
Declaration
public TimeSpan ToolTipDuration { get; set; }
Property Value
Type |
---|
System.TimeSpan |
ToolTipTemplate
Gets or sets the data template for the ToolTip.
Declaration
public DataTemplate ToolTipTemplate { get; set; }
Property Value
Type |
---|
System.Windows.DataTemplate |
VisibilityOnLegend
Gets or sets a value indicating whether whether to create a legend item for this series. By default, legend item will be visible for this series.
Declaration
public bool VisibilityOnLegend { get; set; }
Property Value
Type |
---|
System.Boolean |
Methods
AddToolTip()
Add ToolTip to the chart.
Declaration
protected void AddToolTip()
Animate()
Animate the chart segments.
Declaration
protected virtual void Animate()
AttachMarkerSegment(Int32)
Create Marker segment for series points and added to Series panel
Declaration
protected void AttachMarkerSegment(int count)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | count | Points count. |
ClearUnUsedSegments(Int32)
Method implementation for Clear unused segments
Declaration
protected void ClearUnUsedSegments(int startIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | startIndex | The Start Index |
CreateSegments()
Creates series segments.
Declaration
public virtual void CreateSegments()
Invalidate()
Invalidates the Series
Declaration
public void Invalidate()
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.
Declaration
public override void OnApplyTemplate()
OnSegmentsCollectionChanged(Object, NotifyCollectionChangedEventArgs)
Series segments collection changed.
Declaration
protected void OnSegmentsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The Sending Object |
System.Collections.Specialized.NotifyCollectionChangedEventArgs | e | The Event Arguments |
RemoveToolTip()
Remove the ToolTip from the chart.
Declaration
protected void RemoveToolTip()
UpdateArea()
Call ScheduleUpdate to refresh the chart
Declaration
protected void UpdateArea()
UpdateToolTipPosition(Point, ToolTipInfo)
Update the ToolTip rendering position.
Declaration
protected void UpdateToolTipPosition(Point pointPosition, ToolTipInfo toolTipInfo)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Point | pointPosition | The Point Position. |
ToolTipInfo | toolTipInfo | The Tooltip Information. |