WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartSegment

    Show / Hide Table of Contents

    Class ChartSegment

    This is base class for all chart segments.

    Inheritance
    System.Object
    ChartSegment
    ChartAdornment
    ChartAreaSegment
    ChartBoxAndWhiskerSegment
    ChartBubbleSegment
    ChartColumnSegment
    ChartEmptySymbolSegment
    ChartFastColumnSegment
    ChartFastHiLoOpenCloseSegment
    ChartFastLineSegment
    ChartFastScatterSegment
    ChartFastSplineSegment
    ChartFastStackingColumnSegment
    ChartFunnelSegment
    ChartHiLoSegment
    ChartHistogramDistributionSegment
    ChartHistogramSegment
    ChartKagiSegment
    ChartLineBreakSegment
    ChartLineSegment
    ChartPieSegment
    ChartPointAndFigureSegment
    ChartPyramidSegment
    ChartRenkoSegment
    ChartSplineSegment
    ChartStepLineSegment
    ChartSurfaceSegment
    ChartSymbolSegment
    Implements
    System.IDisposable
    Namespace: Syncfusion.Windows.Chart
    Assembly: Syncfusion.Chart.Wpf.dll
    Syntax
    public abstract class ChartSegment : DependencyObject, IDisposable
    Remarks

    Segment is a building block for any chart series. Depending on chart type, segments on series may change. For detailed information about segments on series see inherited segments documentation. Use chart segments templates to customize series look.

    Constructors

    ChartSegment(ChartSeries, ChartIndexedDataPoint[])

    Initializes a new instance of the ChartSegment class.

    Declaration
    protected ChartSegment(ChartSeries series, ChartIndexedDataPoint[] correspondingPoints)
    Parameters
    Type Name Description
    ChartSeries series

    The series.

    Syncfusion.Windows.Chart.ChartIndexedDataPoint[] correspondingPoints

    The corresponding points.

    ChartSegment(ChartSeries, ChartIndexedDataPoint[], ChartAdornmentInfo)

    Initializes a new instance of the ChartSegment class.

    Declaration
    protected ChartSegment(ChartSeries series, ChartIndexedDataPoint[] correspondingPoints, ChartAdornmentInfo adornment)
    Parameters
    Type Name Description
    ChartSeries series

    The series.

    Syncfusion.Windows.Chart.ChartIndexedDataPoint[] correspondingPoints

    The corresponding points.

    ChartAdornmentInfo adornment

    Fields

    CenterOfViewportProperty

    Identifies CenterOfViewport dependency property.

    Declaration
    public static readonly DependencyProperty CenterOfViewportProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    CenterOfViewportPropertyKey

    Identifies CenterOfViewport attached readonly dependency property key.

    Declaration
    protected static readonly DependencyPropertyKey CenterOfViewportPropertyKey
    Field Value
    Type Description
    System.Windows.DependencyPropertyKey

    DefaultTemplatePropertyKey

    Identifies the Template dependency property.

    Declaration
    protected static readonly DependencyPropertyKey DefaultTemplatePropertyKey
    Field Value
    Type Description
    System.Windows.DependencyPropertyKey

    HighlightedProperty

    Identifies the IsHighlighted property.

    Declaration
    public static readonly DependencyProperty HighlightedProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    InteriorProperty

    Identifies the Interior dependency property.

    Declaration
    public static readonly DependencyProperty InteriorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IsSelectedProperty

    Identifies IsSelected dependency property.

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

    ItemProperty

    Identifies the Item dependency property.

    Declaration
    public static readonly DependencyProperty ItemProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SeriesProperty

    Identifies Series dependency property.

    Declaration
    public static readonly DependencyProperty SeriesProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    SeriesPropertyKey

    Represents Series property key.

    Declaration
    protected static readonly DependencyPropertyKey SeriesPropertyKey
    Field Value
    Type Description
    System.Windows.DependencyPropertyKey

    StrokeProperty

    Identifies the Stroke dependency property.

    Declaration
    public static readonly DependencyProperty StrokeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    StrokeThicknessProperty

    Identifies the StrokeThickness dependency property.

    Declaration
    public static readonly DependencyProperty StrokeThicknessProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ToolTipProperty

    Identifies the ToolTip dependency property.

    Declaration
    public static readonly DependencyProperty ToolTipProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    zRange

    Represents Z-axis range of segment.

    Declaration
    protected DoubleRange zRange
    Field Value
    Type Description
    DoubleRange

    Properties

    CorrespondingPoints

    Gets the corresponding points.

    Declaration
    public ChartIndexedDataPoint[] CorrespondingPoints { get; }
    Property Value
    Type Description
    Syncfusion.Windows.Chart.ChartIndexedDataPoint[]

    The Syncfusion.Windows.Chart.ChartIndexedDataPoint points array.

    Remarks

    Represents points that segments should be built on.

    DefaultTemplate

    Gets the default segment template. This is a dependency property.

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

    The System.Windows.DataTemplate.

    Geometry3D

    Gets or sets the geometry.

    Declaration
    public GeometryModel3D Geometry3D { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Media3D.GeometryModel3D

    The geometry.

    Geometry3DGroup

    Gets or sets the geometry 3D group.

    Declaration
    public Model3DGroup Geometry3DGroup { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Media3D.Model3DGroup

    The geometry 3D group.

    Highlighted

    Gets or sets a value indicating whether this segment is highlighted.

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

    true if this segment is highlighted; otherwise, false.

    Interior

    Gets or sets the interior brush. This is a dependency property.

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

    This property is being set automatically by the chart building system. This property in bound with similar property on series that segment belongs to.

    IsSelected

    Gets a value indicating whether IsSelected. This is a dependency property.

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

    Item

    Gets or sets the Item. This is a dependency property.

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

    The Item value.

    Series

    Gets a value indicating the parent Series. This is a dependency property.

    Declaration
    public ChartSeries Series { get; }
    Property Value
    Type Description
    ChartSeries

    Stroke

    Gets or sets the stroke brush. This is a dependency property.

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

    The stroke System.Windows.Media.Brush.

    Remarks

    This property in bound with similar property on series that segment belongs to.

    StrokeThickness

    Gets or sets the stroke thickness. This is a dependency property.

    Declaration
    public double StrokeThickness { get; set; }
    Property Value
    Type Description
    System.Double

    The stroke thickness.

    Remarks

    This property in bound with similar property on series that segment belongs to.

    ToolTip

    Gets or sets the tooltip.

    Declaration
    public ToolTip ToolTip { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.ToolTip

    The tool tip.

    XDataMeasure

    Gets the X data measure of series.

    Declaration
    public DoubleRange XDataMeasure { get; }
    Property Value
    Type Description
    DoubleRange

    The X data measure.

    Remarks

    Used to determine X data range that segment represents.

    YDataMeasure

    Gets the Y data measure of series.

    Declaration
    public DoubleRange YDataMeasure { get; }
    Property Value
    Type Description
    DoubleRange

    The Y data measure.

    Remarks

    Used to determine Y data range that segment represents.

    ZDataMeasure

    Get the CLR property ZDataMeasure from the internal variable zRange

    Declaration
    public DoubleRange ZDataMeasure { get; }
    Property Value
    Type Description
    DoubleRange

    Methods

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public virtual void Dispose()

    DisposeSegment()

    Method is used to Clear the all segments in the Chart

    Declaration
    protected virtual void DisposeSegment()

    Draw3DSegment(IChartTransformer)

    Draw3s the D segment.

    Declaration
    public virtual void Draw3DSegment(IChartTransformer transformer)
    Parameters
    Type Name Description
    Syncfusion.Windows.Chart.IChartTransformer transformer

    The transformer.

    GetCenterOfViewport(DependencyObject)

    Gets the value of the CenterOfViewport dependency property.

    Declaration
    public static Point GetCenterOfViewport(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The obj value.

    Returns
    Type Description
    System.Windows.Point

    the CenterOfViewport point

    OnPropertyChanged(DependencyPropertyChangedEventArgs)

    Invoked whenever the effective value of any dependency property on this System.Windows.DependencyObject has been updated. The specific dependency property that changed is reported in the event data.

    Declaration
    protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Event data that will contain the dependency property identifier of interest, the property metadata for the type, and old and new values.

    SetPointsForAllSeries(ChartSeries, ChartAxis)

    Declaration
    protected virtual void SetPointsForAllSeries(ChartSeries series, ChartAxis axis)
    Parameters
    Type Name Description
    ChartSeries series
    ChartAxis axis

    SetXRange(Double[])

    Sets the X range for segment.

    Declaration
    protected void SetXRange(params double[] values)
    Parameters
    Type Name Description
    System.Double[] values

    The values.

    SetYRange(Double[])

    Sets the Y range for segment.

    Declaration
    protected void SetYRange(params double[] values)
    Parameters
    Type Name Description
    System.Double[] values

    The values.

    SetZRange(Double[])

    Sets the Z range for segment.

    Declaration
    protected void SetZRange(params double[] values)
    Parameters
    Type Name Description
    System.Double[] values

    The values.

    Update(IChartTransformer)

    Updates the real coordinates of segment with respect to chart type.

    Declaration
    public virtual void Update(IChartTransformer transformer)
    Parameters
    Type Name Description
    Syncfusion.Windows.Chart.IChartTransformer transformer

    Instance of class that implements Syncfusion.Windows.Chart.IChartTransformer interface.

    Implements

    System.IDisposable

    See Also

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