Highcharts .NET  11.3.0
Highsoft.Web.Mvc.Charts.AnnotationsShapes Class Reference

Inherits BaseObject.

Properties

AnnotationsShapesDashStyle DashStyle [get, set]
 Name of the dash style to use for the shape's stroke. More...
 
string Fill [get, set]
 The color of the shape's fill. More...
 
double Height [get, set]
 The height of the shape. More...
 
string MarkerEnd [get, set]
 Id of the marker which will be drawn at the final vertex ofthe path. Custom markers can be defined in defs property. More...
 
string MarkerStart [get, set]
 Id of the marker which will be drawn at the first vertex ofthe path. Custom markers can be defined in defs property. More...
 
AnnotationsShapesPoint Point [get, set]
 This option defines the point to which the shape will beconnected. It can be either the point which exists in theseries - it is referenced by the point's id - or a new pointwith defined x, y properties and optionally axes. More...
 
string PointString [get, set]
 This option defines the point to which the shape will beconnected. It can be either the point which exists in theseries - it is referenced by the point's id - or a new pointwith defined x, y properties and optionally axes. More...
 
List< AnnotationsShapesPointPoints [get, set]
 An array of points for the shapeor a callback function that returns that shape point.This option is availablefor shapes which can use multiple points such as path. Apoint can be either a point object or a point's id. More...
 
double R [get, set]
 The radius of the shape. More...
 
double Ry [get, set]
 The radius of the shape in y direction.Used for the ellipse. More...
 
double Snap [get, set]
 Defines additional snapping area around an annotationmaking this annotation to focus. Defined in pixels. More...
 
string Src [get, set]
 The URL for an image to use as the annotation shape. Note,type has to be set to ‘'image’`. More...
 
string Stroke [get, set]
 The color of the shape's stroke. More...
 
double StrokeWidth [get, set]
 The pixel stroke width of the shape. More...
 
string Type [get, set]
 The type of the shape.Avaliable options are circle, rect and ellipse. More...
 
double Width [get, set]
 The width of the shape. More...
 
string XAxis [get, set]
 The xAxis index to which the points should be attached.Used for the ellipse. More...
 
string YAxis [get, set]
 The yAxis index to which the points should be attached.Used for the ellipse. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ DashStyle

AnnotationsShapesDashStyle Highsoft.Web.Mvc.Charts.AnnotationsShapes.DashStyle
getset

Name of the dash style to use for the shape's stroke.

◆ Fill

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.Fill
getset

The color of the shape's fill.

◆ Height

double Highsoft.Web.Mvc.Charts.AnnotationsShapes.Height
getset

The height of the shape.

◆ MarkerEnd

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.MarkerEnd
getset

Id of the marker which will be drawn at the final vertex ofthe path. Custom markers can be defined in defs property.

◆ MarkerStart

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.MarkerStart
getset

Id of the marker which will be drawn at the first vertex ofthe path. Custom markers can be defined in defs property.

◆ Point

AnnotationsShapesPoint Highsoft.Web.Mvc.Charts.AnnotationsShapes.Point
getset

This option defines the point to which the shape will beconnected. It can be either the point which exists in theseries - it is referenced by the point's id - or a new pointwith defined x, y properties and optionally axes.

◆ Points

List<AnnotationsShapesPoint> Highsoft.Web.Mvc.Charts.AnnotationsShapes.Points
getset

An array of points for the shapeor a callback function that returns that shape point.This option is availablefor shapes which can use multiple points such as path. Apoint can be either a point object or a point's id.

◆ PointString

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.PointString
getset

This option defines the point to which the shape will beconnected. It can be either the point which exists in theseries - it is referenced by the point's id - or a new pointwith defined x, y properties and optionally axes.

◆ R

double Highsoft.Web.Mvc.Charts.AnnotationsShapes.R
getset

The radius of the shape.

◆ Ry

double Highsoft.Web.Mvc.Charts.AnnotationsShapes.Ry
getset

The radius of the shape in y direction.Used for the ellipse.

◆ Snap

double Highsoft.Web.Mvc.Charts.AnnotationsShapes.Snap
getset

Defines additional snapping area around an annotationmaking this annotation to focus. Defined in pixels.

◆ Src

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.Src
getset

The URL for an image to use as the annotation shape. Note,type has to be set to ‘'image’`.

◆ Stroke

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.Stroke
getset

The color of the shape's stroke.

◆ StrokeWidth

double Highsoft.Web.Mvc.Charts.AnnotationsShapes.StrokeWidth
getset

The pixel stroke width of the shape.

◆ Type

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.Type
getset

The type of the shape.Avaliable options are circle, rect and ellipse.

◆ Width

double Highsoft.Web.Mvc.Charts.AnnotationsShapes.Width
getset

The width of the shape.

◆ XAxis

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.XAxis
getset

The xAxis index to which the points should be attached.Used for the ellipse.

◆ YAxis

string Highsoft.Web.Mvc.Charts.AnnotationsShapes.YAxis
getset

The yAxis index to which the points should be attached.Used for the ellipse.


The documentation for this class was generated from the following file: