Class DiagramAnnotation
Inheritance
Namespace: Syncfusion.EJ2.Diagrams
Assembly: Syncfusion.EJ2.dll
Syntax
public class DiagramAnnotation : EJTagHelperConstructors
DiagramAnnotation()
Declaration
public DiagramAnnotation()Properties
AddInfo
Allows the user to save custom information/data about an annotation
Declaration
public object AddInfo { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
AnnotationType
Defines the type of annotation template String - Defines annotation template to be in string Template - Defines annotation template to be in html content
Declaration
public AnnotationType AnnotationType { get; set; }Property Value
| Type | Description |
|---|---|
| AnnotationType | The default value is AnnotationType.String |
Constraints
Enables or disables the default behaviors of the label. ReadOnly - Enables/Disables the ReadOnly Constraints InheritReadOnly - Enables/Disables the InheritReadOnly Constraints
Declaration
public AnnotationConstraints Constraints { get; set; }Property Value
| Type | Description |
|---|---|
| AnnotationConstraints | The default value is AnnotationConstraints.InheritReadOnly |
Content
Sets the textual description of the node/connector
Declaration
public string Content { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }Property Value
| Type |
|---|
| Syncfusion.EJ2.MvcTemplate<System.Object> |
DragLimit
Sets the space to be left between an annotation and its parent node/connector
Declaration
public object DragLimit { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Height
Sets the height of the text
Declaration
public double Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is NaN |
HorizontalAlignment
Sets the horizontal alignment of the text with respect to the parent node/connector Stretch - Stretches the diagram element throughout its immediate parent Left - Aligns the diagram element at the left of its immediate parent Right - Aligns the diagram element at the right of its immediate parent Center - Aligns the diagram element at the center of its immediate parent Auto - Aligns the diagram element based on the characteristics of its immediate parent
Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| HorizontalAlignment | The default value is HorizontalAlignment.Center |
Hyperlink
Sets the hyperlink of the label
Declaration
public DiagramHyperlink Hyperlink { get; set; }Property Value
| Type | Description |
|---|---|
| DiagramHyperlink | The default value is null |
Id
Defines the unique id of the annotation
Declaration
public override string Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Overrides
Margin
Sets the space to be left between an annotation and its parent node/connector
Declaration
public DiagramMargin Margin { get; set; }Property Value
| Type | Description |
|---|---|
| DiagramMargin | The default value is null |
RotateAngle
Sets the rotate angle of the text
Declaration
public double RotateAngle { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
RotationReference
Gets or sets the reference mode for annotation rotation.
Declaration
public RotationReference RotationReference { get; set; }Property Value
| Type | Description |
|---|---|
| RotationReference | The default value is RotationReference.Parent |
Style
Defines the appearance of the text
Declaration
public DiagramTextStyle Style { get; set; }Property Value
| Type | Description |
|---|---|
| DiagramTextStyle | The default value is null |
Template
Sets the textual description of the node/connector
Declaration
public object Template { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Tooltip
This property is used to show tooltip for annotation on mouse over.
Declaration
public object Tooltip { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Type
Sets the type of the annotation Shape - Sets the annotation type as Shape Path - Sets the annotation type as Path
Declaration
public AnnotationTypes Type { get; set; }Property Value
| Type | Description |
|---|---|
| AnnotationTypes | The default value is AnnotationTypes.Shape |
VerticalAlignment
Sets the vertical alignment of the text with respect to the parent node/connector Stretch - Stretches the diagram element throughout its immediate parent Top - Aligns the diagram element at the top of its immediate parent Bottom - Aligns the diagram element at the bottom of its immediate parent Center - Aligns the diagram element at the center of its immediate parent Auto - Aligns the diagram element based on the characteristics of its immediate parent
Declaration
public VerticalAlignment VerticalAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| VerticalAlignment | The default value is VerticalAlignment.Center |
Visibility
Defines the visibility of the label
Declaration
public bool Visibility { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
Width
Sets the width of the text
Declaration
public double Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is NaN |