Class BPMNAnnotation

Text annotation is one of the artifact, which is used to show additional information about a process to make it easier to understand.

Inheritance
System.Object
EJTagHelper
BPMNAnnotation
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.DataVisualization.Models.Diagram
Assembly: Syncfusion.EJ.dll
Syntax
public class BPMNAnnotation : EJTagHelper

Constructors

BPMNAnnotation()

Declaration
public BPMNAnnotation()

Properties

Angle

Gets or sets the angle between the bpmn shape and the annotation

Declaration
[JsonProperty("angle")]
public double Angle { get; set; }
Property Value
Type Description
System.Double

0
Examples
           BPMNNode Node = new BPMNNode()
           {
               Name = "bpmn",
               Width = 100, Height = 100,
               OffsetX = 100, OffsetY = 100,
               Shape = BPMNShapes.DataObject,
               Data = new BPMNDataObject() { Collection = true },
               Annotation = new BPMNAnnotation() {
                   Text = "Data Collection", Angle = 45, Width = 100,
                   Length = 150, Direction = BPMNAnnotationDirections.Left
               }
           };

Direction

Gets or sets the direction of the annotation

Declaration
[JsonProperty("direction")]
[JsonConverter(typeof(StringEnumConverter))]
public BPMNAnnotationDirections Direction { get; set; }
Property Value
Type Description
BPMNAnnotationDirections

BPMNAnnotationDirections.Left
Examples
           BPMNNode Node = new BPMNNode()
           {
               Name = "bpmn",
               Width = 100, Height = 100,
               OffsetX = 100, OffsetY = 100,
               Shape = BPMNShapes.DataObject,
               Data = new BPMNDataObject() { Collection = true },
               Annotation = new BPMNAnnotation() {
                   Text = "Data Collection", Angle = 45, Width = 100,
                   Length = 150, Direction = BPMNAnnotationDirections.Left
               }
           };

Height

Gets or sets the height of the text

Declaration
[JsonProperty("height")]
public double Height { get; set; }
Property Value
Type Description
System.Double

20
Examples
           BPMNNode Node = new BPMNNode()
           {
               Name = "bpmn",
               Width = 100, Height = 100,
               OffsetX = 100, OffsetY = 100,
               Shape = BPMNShapes.DataObject,
               Data = new BPMNDataObject() { Collection = true },
               Annotation = new BPMNAnnotation() {
                   Text = "Data Collection", Angle = 45, Width = 100,
                   Height = 50, Length = 150, 
               }
           };

Length

Gets or sets the distance between the bpmn shape and the annotation

Declaration
[JsonProperty("length")]
public double Length { get; set; }
Property Value
Type Description
System.Double

0
Examples
           BPMNNode Node = new BPMNNode()
           {
               Name = "bpmn",
               Width = 100, Height = 100,
               OffsetX = 100, OffsetY = 100,
               Shape = BPMNShapes.DataObject,
               Data = new BPMNDataObject() { Collection = true },
               Annotation = new BPMNAnnotation() {
                   Text = "Data Collection", Angle = 45, Width = 100,
                   Length = 150, Direction = BPMNAnnotationDirections.Left
               }
           };

Text

Gets or sets the text to annotate the bpmn shape

Declaration
[JsonProperty("text")]
public string Text { get; set; }
Property Value
Type Description
System.String

String.Empty
Examples
           BPMNNode Node = new BPMNNode()
           {
               Name = "bpmn",
               Width = 100, Height = 100,
               OffsetX = 100, OffsetY = 100,
               Shape = BPMNShapes.DataObject,
               Data = new BPMNDataObject() { Collection = true },
               Annotation = new BPMNAnnotation() {
                   Text = "Data Collection", Angle = 45, Width = 100,
                   Length = 150, Direction = BPMNAnnotationDirections.Left
               }
           };

Width

Gets or sets the width of the text

Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type Description
System.Double

20
Examples
           BPMNNode Node = new BPMNNode()
           {
               Name = "bpmn",
               Width = 100, Height = 100,
               OffsetX = 100, OffsetY = 100,
               Shape = BPMNShapes.DataObject,
               Data = new BPMNDataObject() { Collection = true },
               Annotation = new BPMNAnnotation() {
                   Text = "Data Collection", Angle = 45, Width = 100,
                   Length = 150, Direction = BPMNAnnotationDirections.Left
               }
           };