menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartSeriesBase - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ChartSeriesBase

    Represents a base class for all the series types in chart.

    Inheritance
    System.Object
    ChartSeriesBase
    ChartSeries
    ChartSeries3D
    Implements
    ICloneable
    Namespace: Syncfusion.UI.Xaml.Charts
    Assembly: Syncfusion.SfChart.WPF.dll
    Syntax
    public abstract class ChartSeriesBase : Control, ICloneable
    Remarks

    Data points for ChartSeries would be populated ChartSeriesBase from ItemsSourceproperty. Specify the binding paths for X-Values and Y-Values. The number of Y-Values may vary depending on the type of series. For e.g LineSeries requires only one y-value, whereas CandleSeries requires four y-values to plot a point.

    Constructors

    ChartSeriesBase()

    Called when instance created for ChartSeries

    Declaration
    public ChartSeriesBase()

    Fields

    AnimationDurationProperty

    The DependencyProperty for AnimationDuration property.

    Declaration
    public static readonly DependencyProperty AnimationDurationProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ChartTransformer

    ChartTransformer variable declarations

    Declaration
    protected IChartTransformer ChartTransformer
    Field Value
    Type
    Syncfusion.UI.Xaml.Charts.IChartTransformer

    ColorModelProperty

    The DependencyProperty for ColorModel property.

    Declaration
    public static readonly DependencyProperty ColorModelProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    EmptyPointInteriorProperty

    The DependencyProperty for EmptyPointInterior property.

    Declaration
    public static readonly DependencyProperty EmptyPointInteriorProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    EmptyPointStyleProperty

    The DependencyProperty for EmptyPointStyle property.

    Declaration
    public static readonly DependencyProperty EmptyPointStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    EmptyPointSymbolTemplateProperty

    The DependencyProperty for EmptyPointSymbolTemplate property.

    Declaration
    public static readonly DependencyProperty EmptyPointSymbolTemplateProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    EmptyPointValueProperty

    The DependencyProperty for EmptyPointValue property.

    Declaration
    public static readonly DependencyProperty EmptyPointValueProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    EnableAnimationProperty

    The DependencyProperty for EnableAnimation property.

    Declaration
    public static readonly DependencyProperty EnableAnimationProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    InitialDelayTimer

    Timer to handle the initial delay of showing the tooltip.

    Declaration
    protected DispatcherTimer InitialDelayTimer
    Field Value
    Type
    System.Windows.Threading.DispatcherTimer

    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

    IsSortDataProperty

    The DependencyProperty for IsSortData property.

    Declaration
    public static readonly DependencyProperty IsSortDataProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemsSourceProperty

    Identifies the ItemsSource dependency property. 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

    LegendIconProperty

    The DependencyProperty for LegendIcon property.

    Declaration
    public static readonly DependencyProperty LegendIconProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    LegendIconTemplateProperty

    The DependencyProperty for LegendIconTemplate property.

    Declaration
    public static readonly DependencyProperty LegendIconTemplateProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ListenPropertyChangeProperty

    The DependencyProperty for ListenPropertyChange property.

    Declaration
    public static readonly DependencyProperty ListenPropertyChangeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PaletteProperty

    The DependencyProperty for Palette property.

    Declaration
    public static readonly DependencyProperty PaletteProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SegmentColorPathProperty

    The DependencyProperty for SegmentColorPath property.

    Declaration
    public static readonly DependencyProperty SegmentColorPathProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    Segments

    segments variable declarations

    Declaration
    protected ObservableCollection<ChartSegment> Segments
    Field Value
    Type
    System.Collections.ObjectModel.ObservableCollection<ChartSegment>

    SeriesSelectionBrushProperty

    The DependencyProperty for SeriesSelectionBrush property.

    Declaration
    public static readonly DependencyProperty SeriesSelectionBrushProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ShowEmptyPointsProperty

    The DependencyProperty for ShowEmptyPoints property.

    Declaration
    public static readonly DependencyProperty ShowEmptyPointsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ShowTooltipProperty

    The DependencyProperty for ShowTooltip property.

    Declaration
    public static readonly DependencyProperty ShowTooltipProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SortByProperty

    The DependencyProperty for SortBy property.

    Declaration
    public static readonly DependencyProperty SortByProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SortDirectionProperty

    The DependencyProperty for SortDirection property.

    Declaration
    public static readonly DependencyProperty SortDirectionProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SpacingProperty

    Gets the value for width of a segment and value ranges from 0 to 1. This is attached property

    Declaration
    public static readonly DependencyProperty SpacingProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    Timer

    Timer to handle the show duration of the tooltip.

    Declaration
    protected DispatcherTimer Timer
    Field Value
    Type
    System.Windows.Threading.DispatcherTimer

    TooltipTemplateProperty

    The DependencyProperty for TooltipTemplate property.

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

    TrackBallLabelTemplateProperty

    The DependencyProperty for TrackBallLabelTemplate property.

    Declaration
    public static readonly DependencyProperty TrackBallLabelTemplateProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    VisibilityOnLegendProperty

    The DependencyProperty for VisibilityOnLegend property.

    Declaration
    public static readonly DependencyProperty VisibilityOnLegendProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    XBindingPathProperty

    The DependencyProperty for XBindingPath property.

    Declaration
    public static readonly DependencyProperty XBindingPathProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    YPaths

    YPaths variable declarations

    Declaration
    protected string[] YPaths
    Field Value
    Type
    System.String[]

    Properties

    ActualXAxis

    Gets actual series X-axis.

    Declaration
    protected ChartAxis ActualXAxis { get; }
    Property Value
    Type
    ChartAxis
    Remarks

    Gets actual XAxis for series with respect to chart type and Syncfusion.UI.Xaml.Charts.ChartSeriesBase.IsActualTransposed value.

    ActualXValues

    Gets or sets the sorted values, if the IsSortData is true.

    Declaration
    protected IEnumerable ActualXValues { get; set; }
    Property Value
    Type
    System.Collections.IEnumerable

    ActualYAxis

    Gets actual series Y-axis.

    Declaration
    protected ChartAxis ActualYAxis { get; }
    Property Value
    Type
    ChartAxis

    Adornments

    Gets the adornments collection.

    Declaration
    public ObservableCollection<ChartAdornment> Adornments { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<ChartAdornment>

    The adornments.

    AnimationDuration

    Gets or sets the duration of the animation.

    Declaration
    public TimeSpan AnimationDuration { get; set; }
    Property Value
    Type Description
    System.TimeSpan

    System.TimeSpan

    Examples
      <syncfusion:ColumnSeries ItemsSource="{Binding Demands} AnimationDuration="00:00:03" XBindingPath="Demand" YBindingPath="Year2010">
      </syncfusion:ColumnSeries>

    ColorModel

    Gets or sets the color models for all series in the chart.

    Declaration
    public ChartColorModel ColorModel { get; set; }
    Property Value
    Type Description
    ChartColorModel

    ChartColorModel

    ColorValues

    Gets or sets a series color values.

    Declaration
    protected IList<Brush> ColorValues { get; set; }
    Property Value
    Type
    System.Collections.Generic.IList<System.Windows.Media.Brush>

    DataCount

    Gets the number of points given as input.

    Declaration
    public int DataCount { get; }
    Property Value
    Type
    System.Int32

    EmptyPointInterior

    Gets or sets interior color for empty point.

    Declaration
    public Brush EmptyPointInterior { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    The System.Windows.Media.Brush value.

    EmptyPointStyle

    Gets or sets EmptyPointStyle for an empty point. It determines how to differentiate empty point from other data points.

    Declaration
    public EmptyPointStyle EmptyPointStyle { get; set; }
    Property Value
    Type
    EmptyPointStyle

    EmptyPointSymbolTemplate

    Gets or sets DataTemplate to be used when EmptyPointStyle is set to Symbol/ SymbolAndInterior. By default, an ellipse will be displayed as symbol.

    Declaration
    public DataTemplate EmptyPointSymbolTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    System.Windows.DataTemplate

    EmptyPointValue

    Gets or sets a value that determines how to calculate value for empty point.

    Declaration
    public EmptyPointValue EmptyPointValue { get; set; }
    Property Value
    Type
    EmptyPointValue

    EnableAnimation

    Gets or sets a value indicating whether to animate the chart series on loading and whenever ItemsSource change.

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

    Interior

    Gets or sets the brush to paint the interior of the series.

    Declaration
    public Brush Interior { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    The System.Windows.Media.Brush value.

    IsAreaTypeSeries

    Gets the value which confirms whether it is area typed series.

    Declaration
    protected virtual bool IsAreaTypeSeries { get; }
    Property Value
    Type
    System.Boolean
    Remarks

    Returns true if its linear, otherwise it returns false.

    IsBitmapSeries

    Gets whether this series is a bitmap series or not.

    Declaration
    protected virtual bool IsBitmapSeries { get; }
    Property Value
    Type Description
    System.Boolean

    Returns the bool value.

    IsColorPathSeries

    This indicates whether its a colorpath series or not.

    Declaration
    protected bool IsColorPathSeries { get; }
    Property Value
    Type
    System.Boolean

    IsIndexed

    Gets or sets a value indicating whether to treat x values as categories.

    Declaration
    protected bool IsIndexed { get; }
    Property Value
    Type
    System.Boolean

    IsLinear

    Gets the value which confirms whether this series in linearity.

    Declaration
    protected virtual bool IsLinear { get; }
    Property Value
    Type Description
    System.Boolean

    Returns the bool value.

    Remarks

    Returns true if its linear, otherwise it returns false.

    IsSeriesVisible

    Gets or sets a value indicating whether is series visible.

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

    IsSideBySide

    Gets a value indicating whether this series is placed side by side.

    Declaration
    protected virtual bool IsSideBySide { get; }
    Property Value
    Type Description
    System.Boolean

    It returns true, if the series is placed side by side [cluster mode].

    IsSortData

    Gets or sets a value indicating whether to sort the datas.

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

    IsStacked

    Gets a value indicating whether this series is a stacked series.

    Declaration
    protected virtual bool IsStacked { get; }
    Property Value
    Type Description
    System.Boolean

    true if the series is one of stacked series; otherwise, false. The default value is true.

    ItemsSource

    Gets or sets a collection of data points used to generate Chart.

    Declaration
    public object ItemsSource { get; set; }
    Property Value
    Type Description
    System.Object

    The ItemsSource 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

    LegendIcon

    Gets or sets ChartLegendIcon to be displayed in associated legend item.

    Declaration
    public ChartLegendIcon LegendIcon { get; set; }
    Property Value
    Type Description
    ChartLegendIcon

    ChartLegendIcon

    LegendIconTemplate

    Gets or sets DataTemplate for legend icon.

    Declaration
    public DataTemplate LegendIconTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    System.Windows.DataTemplate

    ListenPropertyChange

    Gets or sets a value that indicates whether to listen property change or not. This is a bindable property.

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

    Palette

    Gets or sets ChartPalette for series.

    Declaration
    public ChartColorPalette Palette { get; set; }
    Property Value
    Type
    ChartColorPalette

    SegmentColorPath

    Gets or sets the property binding path for segment color.

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

    SelectedSegment

    Returns the corresponding series selected segment.

    Declaration
    protected virtual ChartSegment SelectedSegment { get; }
    Property Value
    Type
    ChartSegment

    SelectedSegments

    Gets the selected segments in this series, when we enable the multiple selection.

    Declaration
    protected virtual List<ChartSegment> SelectedSegments { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<ChartSegment>

    It returns list of ChartSegment.

    SelectedSegmentsIndexes

    Gets or sets the selected segments indexes.

    Declaration
    protected ObservableCollection<int> SelectedSegmentsIndexes { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<System.Int32>

    SeriesSelectionBrush

    Gets or sets the brush to select the series.

    Declaration
    public Brush SeriesSelectionBrush { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    The System.Windows.Media.Brush value.

    ShowEmptyPoints

    Gets or sets a value indicating whether to show empty points.

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

    ShowTooltip

    Gets or sets a value indicating whether to show or hide the tooltip for series.

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

    SortBy

    Gets or sets SortingAxis.

    Declaration
    public SortingAxis SortBy { get; set; }
    Property Value
    Type
    SortingAxis

    SortDirection

    Gets or sets the Sorting Direction.

    Declaration
    public Direction SortDirection { get; set; }
    Property Value
    Type
    Direction

    TooltipTemplate

    Gets or sets the custom template for Tooltip.

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

    This accepts a System.Windows.DataTemplate.

    Examples
      <syncfusion:ColumnSeries ShowTooltip="True" ItemsSource="{Binding Demands} syncfusion:ChartTooltip.VerticalAlignment="Top" XBindingPath="Demand" YBindingPath="Year2010">
         <syncfusion:ColumnSeries.TooltipTemplate>
           <DataTemplate>
               <Border Background = "DarkGreen" CornerRadius="5" BorderThickness="2" BorderBrush="Black" Width="50" Height="30">
                   <TextBlock Text = "{Binding Item.Year2010}" Foreground="White" FontWeight="Bold"  HorizontalAlignment="Center" VerticalAlignment="Center"/>
               </Border>
           </DataTemplate>
         </syncfusion:ColumnSeries.TooltipTemplate>
      </syncfusion:ColumnSeries>

    TrackBallLabelTemplate

    Gets or sets DataTemplate used to display label, when ChartTrackballBehavior is used.

    Declaration
    public DataTemplate TrackBallLabelTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    System.Windows.DataTemplate

    Examples
      <syncfusion:ColumnSeries ItemsSource="{Binding Demands} XBindingPath="Demand" YBindingPath="Year2010">
         <syncfusion:ColumnSeries.TrackBallLabelTemplate>
           <DataTemplate>
               <Border Background = "DarkGreen" CornerRadius="5" BorderThickness="2" BorderBrush="Black" Width="50" Height="30">
                   <TextBlock Text = "{Binding Item.Year2010}" Foreground="White" FontWeight="Bold"  HorizontalAlignment="Center" VerticalAlignment="Center"/>
               </Border>
           </DataTemplate>
         </syncfusion:ColumnSeries.TrackBallLabelTemplate>
      </syncfusion:ColumnSeries>

    VisibilityOnLegend

    Gets or sets a value that determines whether to create a legend item for this series. By default, legend item will be visible for this series.

    Declaration
    public Visibility VisibilityOnLegend { get; set; }
    Property Value
    Type Description
    System.Windows.Visibility

    System.Windows.Visibility

    XBindingPath

    Gets or sets the property path of x-data in ItemsSource to render the chart series. This is a bindable property.

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

    Methods

    ClearUnUsedSegments(Int32)

    Method implementation for clear unused segments.

    Declaration
    protected virtual void ClearUnUsedSegments(int startIndex)
    Parameters
    Type Name Description
    System.Int32 startIndex

    Clone()

    Returns the instance of this series.

    Declaration
    public DependencyObject Clone()
    Returns
    Type
    System.Windows.DependencyObject

    CloneSeries(DependencyObject)

    Returns the instance of this series.

    Declaration
    protected virtual DependencyObject CloneSeries(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    object

    Returns
    Type
    System.Windows.DependencyObject

    CreateEmptyPointSegments(IList<Double>, out List<List<Double>>, out List<List<Double>>)

    Method called when creating emptypoint segments for series.

    Declaration
    public virtual void CreateEmptyPointSegments(IList<double> YValues, out List<List<double>> yValList, out List<List<double>> xValList)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<System.Double> YValues

    YValues

    System.Collections.Generic.List<System.Collections.Generic.List<System.Double>> yValList

    YValues list

    System.Collections.Generic.List<System.Collections.Generic.List<System.Double>> xValList

    XValues list

    CreateSegments()

    An abstract method which will be called over to create segments.

    Declaration
    public abstract void CreateSegments()

    CreateTransformer(Size, Boolean)

    Return IChartTranform value based upon the given size.

    Declaration
    protected virtual IChartTransformer CreateTransformer(Size size, bool create)
    Parameters
    Type Name Description
    System.Windows.Size size

    Size of the panel.

    System.Boolean create

    Used to specify whether to create the charttransform for not.

    Returns
    Type Description
    Syncfusion.UI.Xaml.Charts.IChartTransformer

    returns IChartTransformer

    FindNearestChartPoint(Point, out Double, out Double, out Double)

    Finds the nearest point in ChartSeries relative to the mouse point/touch position.

    Declaration
    public virtual void FindNearestChartPoint(Point point, out double x, out double y, out double stackedYValue)
    Parameters
    Type Name Description
    System.Windows.Point point

    The co-ordinate point representing the current mouse point /touch position.

    System.Double x

    x-value of the nearest point.

    System.Double y

    y-value of the nearest point

    System.Double stackedYValue

    GeneratePoints()

    method declaration for generatepoints in Chartseries

    Declaration
    protected abstract void GeneratePoints()

    GeneratePoints(String[], IList<Double>[])

    Method used to generate data points for ChartSeries.

    Declaration
    protected void GeneratePoints(string[] yPaths, params IList<double>[] yValueLists)
    Parameters
    Type Name Description
    System.String[] yPaths

    Y paths

    System.Collections.Generic.IList<System.Double>[] yValueLists

    YValues list

    GetAvailableSize()

    Gets the available size of Chart.

    Declaration
    public Size GetAvailableSize()
    Returns
    Type Description
    System.Windows.Size

    returns size

    GetPreviousSeries(ChartSeriesBase)

    Return the previous series.

    Declaration
    protected ChartSeriesBase GetPreviousSeries(ChartSeriesBase series)
    Parameters
    Type Name Description
    ChartSeriesBase series

    ChartSeriesBase

    Returns
    Type
    ChartSeriesBase

    GetSideBySideInfo(ChartSeriesBase)

    Returns the value of side by side position for a series.

    Declaration
    public DoubleRange GetSideBySideInfo(ChartSeriesBase currentseries)
    Parameters
    Type Name Description
    ChartSeriesBase currentseries

    ChartSeries.

    Returns
    Type Description
    DoubleRange

    The DoubleRange side by side Info

    GetSpacing(DependencyObject)

    Gets the Spacing for the SideBySide segments.

    Declaration
    public static double GetSpacing(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    ChartSeries object

    Returns
    Type Description
    System.Double

    returns a double value.

    GetXValues()

    Return collection of double values

    Declaration
    protected List<double> GetXValues()
    Returns
    Type
    System.Collections.Generic.List<System.Double>

    Invalidate()

    Invalidates the Series.

    Declaration
    public void Invalidate()

    IsTooltipAvailable(Canvas)

    Returns the tooltip is available or not in this series.

    Declaration
    protected virtual bool IsTooltipAvailable(Canvas canvas)
    Parameters
    Type Name Description
    System.Windows.Controls.Canvas canvas

    canvas

    Returns
    Type
    System.Boolean

    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()

    OnBindingPathChanged(DependencyPropertyChangedEventArgs)

    Invoked when XBindingPath or YBindingPath properties changed.

    Declaration
    protected virtual void OnBindingPathChanged(DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs args

    The System.Windows.DependencyPropertyChangedEventArgs that contains the event data

    OnDataSourceChanged(IEnumerable, IEnumerable)

    Invoked when ItemsSource property changed.

    Declaration
    protected virtual void OnDataSourceChanged(IEnumerable oldValue, IEnumerable newValue)
    Parameters
    Type Name Description
    System.Collections.IEnumerable oldValue

    Old itemssource collection.

    System.Collections.IEnumerable newValue

    New itemssource collection.

    See Also
    XBindingPath
    YBindingPath

    OnDataSourceChanged(DependencyPropertyChangedEventArgs)

    Called when ItemsSource property changed.

    Declaration
    protected void OnDataSourceChanged(DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs args

    OnMouseLeave(MouseEventArgs)

    Called when pointer leave from segment.

    Declaration
    protected override void OnMouseLeave(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    MouseEventArgs

    OnMouseLeftButtonDown(MouseButtonEventArgs)

    Called when pointer or mouse down.

    Declaration
    protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    EventArgs

    OnMouseLeftButtonUp(MouseButtonEventArgs)

    Called when pointer or mouse pressed.

    Declaration
    protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    EventArgs

    OnMouseMove(MouseEventArgs)

    Called when mouse or pointer move to show the tooltip for series.

    Declaration
    protected override void OnMouseMove(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    Event Arguments

    OnSeriesMouseDown(Object, Point)

    Called when the chart mouse down.

    Declaration
    protected virtual void OnSeriesMouseDown(object source, Point position)
    Parameters
    Type Name Description
    System.Object source

    source

    System.Windows.Point position

    position

    OnSeriesMouseUp(Object, Point)

    Called when the chart mouse up.

    Declaration
    protected virtual void OnSeriesMouseUp(object source, Point position)
    Parameters
    Type Name Description
    System.Object source

    source

    System.Windows.Point position

    position

    Position(Point, ref ChartTooltip)

    Set the Horizontal and Vertical Alignment for Tooltip.

    Declaration
    protected Point Position(Point mousePos, ref ChartTooltip tooltip)
    Parameters
    Type Name Description
    System.Windows.Point mousePos

    Current Position

    ChartTooltip tooltip

    Tooltip instance

    Returns
    Type
    System.Windows.Point

    ResumeNotification()

    Processes the data that is added to data source after SuspendNotification.

    Declaration
    public void ResumeNotification()

    SelectedIndexChanged(Int32, Int32)

    Method used to set SegmentSelectionBrush to selectedindex chartsegment.

    Declaration
    protected virtual void SelectedIndexChanged(int newIndex, int oldIndex)
    Parameters
    Type Name Description
    System.Int32 newIndex

    new index

    System.Int32 oldIndex

    old index

    SetDoubleAnimation(ChartTooltip)

    Set animation for tooltip.

    Declaration
    protected virtual void SetDoubleAnimation(ChartTooltip chartTooltip)
    Parameters
    Type Name Description
    ChartTooltip chartTooltip

    ChartTooltip

    SetIndividualDataTablePoint(Int32, Object, Boolean)

    Method implementation for Set points to given index for data table.

    Declaration
    protected virtual void SetIndividualDataTablePoint(int index, object obj, bool replace)
    Parameters
    Type Name Description
    System.Int32 index

    index

    System.Object obj

    object

    System.Boolean replace

    replace the data point or not

    SetIndividualPoint(Int32, Object, Boolean)

    Method implementation for generate points to given index.

    Declaration
    protected virtual void SetIndividualPoint(int index, object obj, bool replace)
    Parameters
    Type Name Description
    System.Int32 index

    index

    System.Object obj

    object

    System.Boolean replace

    replace the data or not

    SetSpacing(DependencyObject, Double)

    Sets the Spacing for the SideBySide segments.

    Declaration
    public static void SetSpacing(DependencyObject obj, double value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    ChartSeries object

    System.Double value

    The value to set for calcaulting the segment width

    SetTooltipDuration()

    Set ToolTip duration.

    Declaration
    protected virtual void SetTooltipDuration()

    SuspendNotification()

    Suspends the series from updating the series data till ResumeNotification is called. This is specifically used when we need to append collection of datas.

    Declaration
    public void SuspendNotification()

    UpdateArea()

    Method implementation for UpdateArea.

    Declaration
    protected void UpdateArea()

    UpdateSegments(Int32, NotifyCollectionChangedAction)

    An abstract method which will called over each time in its child class to update an segment.

    Declaration
    public virtual void UpdateSegments(int index, NotifyCollectionChangedAction action)
    Parameters
    Type Name Description
    System.Int32 index

    The index of the segment

    System.Collections.Specialized.NotifyCollectionChangedAction action

    The collection changed action which raises the notification

    Events

    PropertyChanged

    Event correspond to property value changed. It invokes when the ChartSeriesBase properties changed.

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type
    System.ComponentModel.PropertyChangedEventHandler

    Implements

    ICloneable

    See Also

    ChartSegment
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved