Class ShapeAnnotationBase

Base class for all shape annotations.

Inheritance
object
AnnotationBase
ShapeAnnotationBase
Ellipse
Line
Polygon
Polyline
Rectangle
Implements
Inherited Members
Namespace: PSPDFKit.Sdk.Models.Annotation.Shape
Assembly: Sdk.dll
Syntax
public abstract class ShapeAnnotationBase : AnnotationBase, IAnnotation

Properties

| Edit this page View Source

FillColor

A Color to fill the interior of closed shapes (ellipses, rectangles and polygons) or start and / or end line caps of open shapes (lines and polylines).

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(ColorJsonConverter))]
public Color? FillColor { get; set; }
Property Value
Type Description
Color?
| Edit this page View Source

MeasurementAttributes

Gets or sets measurement attributes if the shape annotation is used for measuremsnt.

Declaration
[JsonIgnore]
public MeasurementAttributes MeasurementAttributes { get; set; }
Property Value
Type Description
MeasurementAttributes
| Edit this page View Source

StrokeColor

A Color for the shape lines

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(ColorJsonConverter))]
public Color? StrokeColor { get; set; }
Property Value
Type Description
Color?
| Edit this page View Source

StrokeDashArray

Optional dash pattern used to draw the shape lines for dashed line style.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(StrokeDashArrayJsonConverter))]
public Tuple<int, int> StrokeDashArray { get; set; }
Property Value
Type Description
Tuple<int, int>
| Edit this page View Source

StrokeWidth

The width of the line in page size pixels. By default, we use values between 1 and 40 in the UI. The stroke width will scale when you zoom in.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public float StrokeWidth { get; set; }
Property Value
Type Description
float

Methods

| Edit this page View Source

ToJson(ref JObject)

Declaration
protected override void ToJson(ref JObject jObj)
Parameters
Type Name Description
JObject jObj
Overrides
AnnotationBase.ToJson(ref JObject)

Implements

IAnnotation