Class ChartAdornmentInfoBase

ChartAdornmentInfoBase represents the class used for configuring chart adornments for chart.

Inheritance

System.Object

ChartAdornmentInfoBase

ChartAdornmentInfo

ChartAdornmentInfo3D

Implements

ICloneable

Namespace: Syncfusion.UI.Xaml.Charts

Assembly: Syncfusion.SfChart.WPF.dll

Syntax

public abstract class ChartAdornmentInfoBase : DependencyObject, ICloneable

Constructors

ChartAdornmentInfoBase()

Called when instance created for ChartAdornmentInfoBase.

Declaration

public ChartAdornmentInfoBase()

Fields

AdornmentsPositionProperty

The DependencyProperty for AdornmentsPosition property.

Declaration

public static readonly DependencyProperty AdornmentsPositionProperty

Field Value

Type
System.Windows.DependencyProperty

BackgroundProperty

The DependencyProperty for Background property.

Declaration

public static readonly DependencyProperty BackgroundProperty

Field Value

Type
System.Windows.DependencyProperty

BorderBrushProperty

The DependencyProperty for BorderBrush property.

Declaration

public static readonly DependencyProperty BorderBrushProperty

Field Value

Type
System.Windows.DependencyProperty

BorderThicknessProperty

The DependencyProperty for BorderThickness property.

Declaration

public static readonly DependencyProperty BorderThicknessProperty

Field Value

Type
System.Windows.DependencyProperty

ConnectorHeightProperty

The DependencyProperty for ConnectorHeight property.

Declaration

public static readonly DependencyProperty ConnectorHeightProperty

Field Value

Type
System.Windows.DependencyProperty

ConnectorLineStyleProperty

The DependencyProperty for ConnectorLineStyle property.

Declaration

public static readonly DependencyProperty ConnectorLineStyleProperty

Field Value

Type
System.Windows.DependencyProperty

ConnectorRotationAngleProperty

The DependencyProperty for ConnectorRotationAngle property.

Declaration

public static readonly DependencyProperty ConnectorRotationAngleProperty

Field Value

Type
System.Windows.DependencyProperty

FontFamilyProperty

The DependencyProperty for FontFamily property.

Declaration

public static readonly DependencyProperty FontFamilyProperty

Field Value

Type
System.Windows.DependencyProperty

FontSizeProperty

The DependencyProperty for FontSize property.

Declaration

public static readonly DependencyProperty FontSizeProperty

Field Value

Type
System.Windows.DependencyProperty

FontStyleProperty

The DependencyProperty for FontStyle property.

Declaration

public static readonly DependencyProperty FontStyleProperty

Field Value

Type
System.Windows.DependencyProperty

ForegroundProperty

The DependencyProperty for Foreground property.

Declaration

public static readonly DependencyProperty ForegroundProperty

Field Value

Type
System.Windows.DependencyProperty

HighlightOnSelectionProperty

The DependencyProperty for HighlightOnSelection property.

Declaration

public static readonly DependencyProperty HighlightOnSelectionProperty

Field Value

Type
System.Windows.DependencyProperty

HorizontalAlignmentProperty

The DependencyProperty for HorizontalAlignment property.

Declaration

public static readonly DependencyProperty HorizontalAlignmentProperty

Field Value

Type
System.Windows.DependencyProperty

LabelPositionProperty

The DependencyProperty for LabelPosition property.

Declaration

public static readonly DependencyProperty LabelPositionProperty

Field Value

Type
System.Windows.DependencyProperty

LabelRotationAngleProperty

The DependencyProperty for LabelRotationAngle property.

Declaration

public static readonly DependencyProperty LabelRotationAngleProperty

Field Value

Type
System.Windows.DependencyProperty

LabelTemplateProperty

The DependencyProperty for LabelTemplate property.

Declaration

public static readonly DependencyProperty LabelTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

MarginProperty

The DependencyProperty for Margin property.

Declaration

public static readonly DependencyProperty MarginProperty

Field Value

Type
System.Windows.DependencyProperty

SegmentLabelContentProperty

The DependencyProperty for SegmentLabelContent property.

Declaration

public static readonly DependencyProperty SegmentLabelContentProperty

Field Value

Type
System.Windows.DependencyProperty

SegmentLabelFormatProperty

The DependencyProperty for SegmentLabelFormat property.

Declaration

public static readonly DependencyProperty SegmentLabelFormatProperty

Field Value

Type
System.Windows.DependencyProperty

ShowConnectorLineProperty

The DependencyProperty for ShowConnectorLine property.

Declaration

public static readonly DependencyProperty ShowConnectorLineProperty

Field Value

Type
System.Windows.DependencyProperty

ShowLabelProperty

The DependencyProperty for ShowLabel property.

Declaration

public static readonly DependencyProperty ShowLabelProperty

Field Value

Type
System.Windows.DependencyProperty

ShowMarkerProperty

The DependencyProperty for ShowMarker property.

Declaration

public static readonly DependencyProperty ShowMarkerProperty

Field Value

Type
System.Windows.DependencyProperty

SymbolHeightProperty

The DependencyProperty for SymbolHeight property.

Declaration

public static readonly DependencyProperty SymbolHeightProperty

Field Value

Type
System.Windows.DependencyProperty

SymbolInteriorProperty

The DependencyProperty for SymbolInterior property.

Declaration

public static readonly DependencyProperty SymbolInteriorProperty

Field Value

Type
System.Windows.DependencyProperty

SymbolProperty

The DependencyProperty for Symbol property.

Declaration

public static readonly DependencyProperty SymbolProperty

Field Value

Type
System.Windows.DependencyProperty

SymbolStrokeProperty

The DependencyProperty for SymbolStroke property.

Declaration

public static readonly DependencyProperty SymbolStrokeProperty

Field Value

Type
System.Windows.DependencyProperty

SymbolTemplateProperty

The DependencyProperty for SymbolTemplate property.

Declaration

public static readonly DependencyProperty SymbolTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

SymbolWidthProperty

The DependencyProperty for SymbolWidth property.

Declaration

public static readonly DependencyProperty SymbolWidthProperty

Field Value

Type
System.Windows.DependencyProperty

UseSeriesPaletteProperty

The DependencyProperty for UseSeriesPalette property.

Declaration

public static readonly DependencyProperty UseSeriesPaletteProperty

Field Value

Type
System.Windows.DependencyProperty

VerticalAlignmentProperty

The DependencyProperty for VerticalAlignment property.

Declaration

public static readonly DependencyProperty VerticalAlignmentProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

AdornmentsPosition

Gets or sets the position of the adornments.

Declaration

public AdornmentsPosition AdornmentsPosition { get; set; }

Property Value

Type	Description
AdornmentsPosition	`AdornmentsPosition.Top` `AdornmentsPosition.Bottom` `AdornmentsPosition.TopAndBottom`

Background

Gets or sets the background brush for the adornment label.

Declaration

public Brush Background { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The System.Windows.Media.Brush value.

BorderBrush

Gets or sets the brush that draws the outer border stroke brush.

Declaration

public Brush BorderBrush { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The System.Windows.Media.Brush value.

BorderThickness

Gets or sets the outer border thickness of the label.

Declaration

public Thickness BorderThickness { get; set; }

Property Value

Type
System.Windows.Thickness

ConnectorHeight

Gets or sets the connector line height of the adornment.

Declaration

public double ConnectorHeight { get; set; }

Property Value

Type
System.Double

ConnectorLineStyle

Gets or sets the connector line style.

Declaration

public Style ConnectorLineStyle { get; set; }

Property Value

Type
System.Windows.Style

Remarks

System.Windows.Style

ConnectorRotationAngle

Gets or sets the rotation angle for the connector line.

Declaration

public double ConnectorRotationAngle { get; set; }

Property Value

Type
System.Double

FontFamily

Gets or sets the adornment label font family.

Declaration

public FontFamily FontFamily { get; set; }

Property Value

Type	Description
System.Windows.Media.FontFamily	FontFamily

Remarks

Identifies font family that should be used to display adornment's text.

FontStyle

Gets or sets the top-level font style for the label.

Declaration

public FontStyle FontStyle { get; set; }

Property Value

Type	Description
System.Windows.FontStyle	FontStyle

Foreground

Gets or sets foreground brush to apply to the label content.

Declaration

public Brush Foreground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The System.Windows.Media.Brush value.

HighlightOnSelection

Gets or sets a value indicating whether to enable the selection for the adornments.

Declaration

public bool HighlightOnSelection { get; set; }

Property Value

Type	Description
System.Boolean	if its `true`, we can selected the data point by selecting adornments.

Remarks

This feature will be useful for the continuous series like FastLine, Area, etc.

HorizontalAlignment

Gets or sets the horizontal alignment for the label.

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
System.Windows.HorizontalAlignment	HorizontalAlignment

LabelPosition

Gets or sets the label position for the adornment.

Declaration

public AdornmentsLabelPosition LabelPosition { get; set; }

Property Value

Type	Description
AdornmentsLabelPosition	AdornmentsLabelPosition

Remarks

By defining its value as AdornmentsLabelPosition.Auto, the adornment label will position smartly based on type of the series.

LabelRotationAngle

Gets or sets the rotation angle to the adornment label content.

Declaration

public double LabelRotationAngle { get; set; }

Property Value

Type
System.Double

Remarks

The default value is 0 and the label will be rotated with center as origin.

LabelTemplate

Gets or sets the custom template for the adornment label.

Declaration

public DataTemplate LabelTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate	System.Windows.DataTemplate

Margin

Gets or sets the outer margin of a label.

Declaration

public Thickness Margin { get; set; }

Property Value

Type
System.Windows.Thickness

SegmentLabelContent

Gets or sets the actual label content to be displayed as adornment.

Declaration

public LabelContent SegmentLabelContent { get; set; }

Property Value

Type	Description
LabelContent	LabelContent

Remarks

This property is used to define the value to be displayed in adornment label like x value or any other value from underlying model object.

SegmentLabelFormat

Gets or sets the string formatting for the adornment labels.

Declaration

public string SegmentLabelFormat { get; set; }

Property Value

Type
System.String

Series

Gets the associated series of this adornment.

Declaration

public ChartSeriesBase Series { get; }

Property Value

Type
ChartSeriesBase

ShowConnectorLine

Gets or sets a value indicating whether to show or hide the connector line.

Declaration

public bool ShowConnectorLine { get; set; }

Property Value

Type
System.Boolean

ShowLabel

Gets or sets a value indicating whether to show or hide the adornment label.

Declaration

public bool ShowLabel { get; set; }

Property Value

Type
System.Boolean

ShowMarker

Gets or sets a value indicating whether to show or hide the marker symbol.

Declaration

public bool ShowMarker { get; set; }

Property Value

Type
System.Boolean

Symbol

Gets or sets the type of symbol to be displayed as adornment.

Declaration

public ChartSymbol Symbol { get; set; }

Property Value

Type	Description
ChartSymbol	The value can be Circle, Rectangle, etc. See ChartSymbol.

Remarks

By default, symbol will not be displayed. We need to define the required shape.

SymbolHeight

Gets or sets the height of the adornment symbol.

Declaration

public double SymbolHeight { get; set; }

Property Value

Type
System.Double

Remarks

The default value is 12.

SymbolInterior

Gets or sets the background of the adornment symbol.

Declaration

public Brush SymbolInterior { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The System.Windows.Media.Brush value.

SymbolStroke

Gets or sets the stroke of the adornment symbol.

Declaration

public Brush SymbolStroke { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The System.Windows.Media.Brush value.

SymbolTemplate

Gets or sets the custom template for the adornment symbol.

Declaration

public DataTemplate SymbolTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate	System.Windows.DataTemplate

SymbolWidth

Gets or sets the width of the adornment symbol.

Declaration

public double SymbolWidth { get; set; }

Property Value

Type
System.Double

Remarks

The default value is 12.

UseSeriesPalette

Gets or sets a value indicating whether the adornment should reflect the series interior.

Declaration

public bool UseSeriesPalette { get; set; }

Property Value

Type	Description
System.Boolean	if its `true`, the segment color will be applied for the respective adornments. By default, its `false`.

VerticalAlignment

Gets or sets the vertical alignment for the label.

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
System.Windows.VerticalAlignment	VerticalAlignment

Methods

Clone()

Returns the clone adornment info.

Declaration

public DependencyObject Clone()

Returns

Type
System.Windows.DependencyObject

DrawLineSegment(List<Point>, Path)

Draws the line segment.

Declaration

protected virtual void DrawLineSegment(List<Point> points, Path path)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Windows.Point>	points	The points.
System.Windows.Shapes.Path	path	The path.

GetChartAlignment(HorizontalAlignment)

Get equivalent ChartAlignment from HorizontalAlignment.

Declaration

protected ChartAlignment GetChartAlignment(HorizontalAlignment alignment)

Parameters

Type	Name	Description
System.Windows.HorizontalAlignment	alignment	which get type of HorizontalAlignment.

Returns

Type	Description
ChartAlignment	ChartAlignment

GetChartAlignment(VerticalAlignment)

Get equivalent ChartAlignment from VerticalAlignment.

Declaration

protected ChartAlignment GetChartAlignment(VerticalAlignment alignment)

Parameters

Type	Name	Description
System.Windows.VerticalAlignment	alignment	which get type of VerticalAlignment.

Returns

Type	Description
ChartAlignment	ChartAlignment

Implements

ICloneable