Class ShapeAnnotation

ShapeAnnotation allows you to add annotations in the form of different shapes such as rectangles, ellipses, lines, horizontal lines, and vertical lines at specific areas of interest within the chart area.

Inheritance

System.Object

Annotation

SingleAnnotation

ShapeAnnotation

LineAnnotation

SolidShapeAnnotation

Implements

ICloneable

Inherited Members

Annotation.AnnotationElement

Annotation.CanUpdateRange(Object, Object)

Annotation.Clone()

Annotation.ContentTemplate

Annotation.ContentTemplateProperty

Annotation.CoordinateUnit

Annotation.CoordinateUnitProperty

Annotation.EnableClipping

Annotation.EnableClippingProperty

Annotation.EnableEditing

Annotation.EnableEditingProperty

Annotation.EnsurePoint(Point, Point)

Annotation.FontFamily

Annotation.FontFamilyProperty

Annotation.FontSize

Annotation.FontSizeProperty

Annotation.FontStretch

Annotation.FontStretchProperty

Annotation.FontStyle

Annotation.FontStyleProperty

Annotation.FontWeight

Annotation.FontWeightProperty

Annotation.Foreground

Annotation.ForegroundProperty

Annotation.GetClippingValues(Double, ChartAxis)

Annotation.GetElementPosition(FrameworkElement, Point)

Annotation.GetElementPosition(Size, Point)

Annotation.GetRenderedAnnotation()

Annotation.GetRotatePoint(Double, FrameworkElement, Point)

Annotation.IntersectsWith(Rect, Rect)

Annotation.IsUiCleared

Annotation.OnSelected(EventArgs)

Annotation.OnUnSelected(EventArgs)

Annotation.PointerMoved

Annotation.PointerPressed

Annotation.PointerReleased

Annotation.RotatedTextRect

Annotation.RotateElement(Double, FrameworkElement)

Annotation.RotateElement(Double, FrameworkElement, Size)

Annotation.Selected

Annotation.SetData()

Annotation.ShowToolTip

Annotation.ShowToolTipProperty

Annotation.Text

Annotation.TextElement

Annotation.TextElementCanvas

Annotation.TextProperty

Annotation.ToolTipContent

Annotation.ToolTipContentProperty

Annotation.ToolTipPlacement

Annotation.ToolTipPlacementProperty

Annotation.ToolTipShowDuration

Annotation.ToolTipShowDurationProperty

Annotation.ToolTipTemplate

Annotation.ToolTipTemplateProperty

Annotation.UnSelected

Annotation.x1

Annotation.X1

Annotation.X1Property

Annotation.XAxisName

Annotation.XAxisNameProperty

Annotation.y1

Annotation.Y1

Annotation.Y1Property

Annotation.YAxisName

Annotation.YAxisNameProperty

Namespace: Syncfusion.UI.Xaml.Charts

Assembly: Syncfusion.SfChart.UWP.dll

Syntax

public abstract class ShapeAnnotation : SingleAnnotation, ICloneable

Constructors

ShapeAnnotation()

Constructor

Declaration

public ShapeAnnotation()

Fields

CanDragProperty

The DependencyProperty for CanDrag property.

Declaration

public static readonly DependencyProperty CanDragProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CanResizeProperty

The DependencyProperty for CanResize property.

Declaration

public static readonly DependencyProperty CanResizeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DraggingModeProperty

The DependencyProperty for DraggingMode property.

Declaration

public static readonly DependencyProperty DraggingModeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

FillProperty

The DependencyProperty for Fill property.

Declaration

public static readonly DependencyProperty FillProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HorizontalTextAlignmentProperty

The DependencyProperty for HorizontalTextAlignment property.

Declaration

public static readonly DependencyProperty HorizontalTextAlignmentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeDashArrayProperty

The DependencyProperty for StrokeDashArray property.

Declaration

public static readonly DependencyProperty StrokeDashArrayProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeDashCapProperty

The DependencyProperty for StrokeDashCap property.

Declaration

public static readonly DependencyProperty StrokeDashCapProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeDashOffsetProperty

The DependencyProperty for StrokeDashOffset property.

Declaration

public static readonly DependencyProperty StrokeDashOffsetProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeEndLineCapProperty

The DependencyProperty for StrokeEndLineCap property.

Declaration

public static readonly DependencyProperty StrokeEndLineCapProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeLineJoinProperty

The DependencyProperty for StrokeLineJoin property.

Declaration

public static readonly DependencyProperty StrokeLineJoinProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeMiterLimitProperty

The DependencyProperty for StrokeMiterLimit property.

Declaration

public static readonly DependencyProperty StrokeMiterLimitProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeProperty

The DependencyProperty for Stroke property.

Declaration

public static readonly DependencyProperty StrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeStartLineCapProperty

The DependencyProperty for StrokeStartLineCap property.

Declaration

public static readonly DependencyProperty StrokeStartLineCapProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StrokeThicknessProperty

The DependencyProperty for StrokeThickness property.

Declaration

public static readonly DependencyProperty StrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

VerticalTextAlignmentProperty

The DependencyProperty for VerticalTextAlignment property.

Declaration

public static readonly DependencyProperty VerticalTextAlignmentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

x2

Represents the x-coordinate value.

Declaration

protected double x2

Field Value

Type
System.Double

X2Property

The DependencyProperty for X2 property.

Declaration

public static readonly DependencyProperty X2Property

Field Value

Type
Windows.UI.Xaml.DependencyProperty

y2

Represents the y-coordinate value.

Declaration

protected double y2

Field Value

Type
System.Double

Y2Property

The DependencyProperty for Y2 property.

Declaration

public static readonly DependencyProperty Y2Property

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

CanDrag

Gets or sets a value indicating whether dragging is enabled for the annotation.

Declaration

public bool CanDrag { get; set; }

Property Value

Type	Description
System.Boolean	If true, we can drag the annotation.

CanResize

Gets or sets a value indicating whether resizing is enabled for the annotation.

Declaration

public bool CanResize { get; set; }

Property Value

Type	Description
System.Boolean	If true, we can resize the annotation.

DraggingMode

Gets or sets the dragging direction for the annotation.

Declaration

public AxisMode DraggingMode { get; set; }

Property Value

Type	Description
AxisMode	AxisMode.Horizontal AxisMode.Vertical AxisMode.All

Fill

Gets or sets the fill color of the ShapeAnnotation.

Declaration

public Brush Fill { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	The Windows.UI.Xaml.Media.Brush value.

HorizontalTextAlignment

Gets or sets the horizontal text alignment.

Declaration

public HorizontalAlignment HorizontalTextAlignment { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.HorizontalAlignment	The Windows.UI.Xaml.HorizontalAlignment value.

Stroke

Gets or sets the stroke for the annotation.

Declaration

public Brush Stroke { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	The Windows.UI.Xaml.Media.Brush value.

StrokeDashArray

Gets or sets the stroke dash array for the annotation stroke.

Declaration

public DoubleCollection StrokeDashArray { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.DoubleCollection	Windows.UI.Xaml.Media.DoubleCollection.

StrokeDashCap

Gets or sets the stroke dash cap for the stroke.

Declaration

public PenLineCap StrokeDashCap { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.PenLineCap	Windows.UI.Xaml.Media.PenLineCap.

StrokeDashOffset

Gets or sets the stroke dash offset for the annotation.

Declaration

public double StrokeDashOffset { get; set; }

Property Value

Type	Description
System.Double	The double value.

StrokeEndLineCap

Gets or sets the end line cap for the stroke.

Declaration

public PenLineCap StrokeEndLineCap { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.PenLineCap	Windows.UI.Xaml.Media.PenLineCap.

StrokeLineJoin

Gets or sets the stroke line join for the stroke of the shape.

Declaration

public PenLineJoin StrokeLineJoin { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.PenLineJoin	Windows.UI.Xaml.Media.PenLineJoin

StrokeMiterLimit

Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of the shape.

Declaration

public double StrokeMiterLimit { get; set; }

Property Value

Type
System.Double

StrokeStartLineCap

Gets or sets the start line cap for the stroke.

Declaration

public PenLineCap StrokeStartLineCap { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.PenLineCap	Windows.UI.Xaml.Media.PenLineCap.

StrokeThickness

Gets or sets the stroke thickness.

Declaration

public double StrokeThickness { get; set; }

Property Value

Type
System.Double

VerticalTextAlignment

Gets or sets the vertical alignment of the text description in ShapeAnnotation.

Declaration

public VerticalAlignment VerticalTextAlignment { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.VerticalAlignment	The Windows.UI.Xaml.VerticalAlignment property.

X2

Gets or sets the X2 value for the ShapeAnnotation.

Declaration

public object X2 { get; set; }

Property Value

Type
System.Object

Y2

Gets or sets the Y2 value for the ShapeAnnotation.

Declaration

public object Y2 { get; set; }

Property Value

Type
System.Object

Methods

CloneAnnotation(Annotation)

Clones the annotation.

Declaration

protected override DependencyObject CloneAnnotation(Annotation annotation)

Parameters

Type	Name	Description
Annotation	annotation	The annotation cloned is updated.

Returns

Type	Description
Windows.UI.Xaml.DependencyObject	Returns the cloned annotation.

Overrides

Annotation.CloneAnnotation(Annotation)

GetTextPosition(Size, Point)

Calculates the adjusted position for rendering text based on the desired size and alignment settings.

Declaration

protected Point GetTextPosition(Size desiredSize, Point originalPosition)

Parameters

Type	Name	Description
Windows.Foundation.Size	desiredSize
Windows.Foundation.Point	originalPosition

Returns

Type
Windows.Foundation.Point

GetTextPosition(Size, Point, Size)

Calculates the adjusted position for rendering text based on the desired container size, original position, and the actual size of the text.

Declaration

protected virtual Point GetTextPosition(Size desiredSize, Point originalPosition, Size textSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	desiredSize
Windows.Foundation.Point	originalPosition
Windows.Foundation.Size	textSize

Returns

Type
Windows.Foundation.Point

OnDragCompleted(AnnotationDragCompletedEventArgs)

Invoked when an unhandled DragCompleted routed event reaches an element in its route that is derived from this class.

Declaration

protected virtual void OnDragCompleted(AnnotationDragCompletedEventArgs args)

Parameters

Type	Name	Description
AnnotationDragCompletedEventArgs	args	The AnnotationDragCompletedEventArgs that contains the event data.

Remarks

Implement this method to provide class level handling for this event.

OnDragDelta(AnnotationDragDeltaEventArgs)

Invoked when an unhandled DragDelta routed event reaches an element in its route that is derived from this class.

Declaration

protected virtual void OnDragDelta(AnnotationDragDeltaEventArgs args)

Parameters

Type	Name	Description
AnnotationDragDeltaEventArgs	args	The AnnotationDragDeltaEventArgs that contains the event data.

Remarks

Implement this method to add class handling for this event.

OnDragStarted(EventArgs)

Invoked when an unhandled DragStarted routed event reaches an element in its route that is derived from this class.

Declaration

protected virtual void OnDragStarted(EventArgs args)

Parameters

Type	Name	Description
System.EventArgs	args	The System.EventArgs that contains the event data.

Remarks

Implement this method to add class handling for this event.

SetBindings()

Sets the annotation bindings to the required elements.

Declaration

protected override void SetBindings()

Overrides

Annotation.SetBindings()

UpdateAnnotation()

Updates the annotation.

Declaration

public override void UpdateAnnotation()

Overrides

Annotation.UpdateAnnotation()

Events

DragCompleted

Occurs when annotation drag is completed.

Declaration

public event EventHandler<AnnotationDragCompletedEventArgs> DragCompleted

Event Type

Type
System.EventHandler<AnnotationDragCompletedEventArgs>

DragDelta

Occurs when annotation dragging.

Declaration

public event EventHandler<AnnotationDragDeltaEventArgs> DragDelta

Event Type

Type
System.EventHandler<AnnotationDragDeltaEventArgs>

DragStarted

Occurs when annotation drag is started.

Declaration

public event EventHandler DragStarted

Event Type

Type
System.EventHandler

Implements

ICloneable

Extension Methods

DateTimeExtension.ToDateTime(Object)