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

Inherits BaseObject.

Properties

List< object > BoxesToAvoid [get, set]
 An array of boxes to avoid when laying out the labels. Eachitem has a left, right, top and bottom property. More...
 
bool ConnectorAllowed [get, set]
 Allow labels to be placed distant to the graph if necessary,and draw a connector line to the graph. Setting this optionto true may decrease the performance significantly, since thealgorithm with systematically search for open spaces in thewhole plot area. Visually, it may also result in a morecluttered chart, though more of the series will be labeled. More...
 
double ConnectorNeighbourDistance [get, set]
 If the label is closer than this to a neighbour graph, draw aconnector. More...
 
bool Enabled [get, set]
 Enable the series label per series. More...
 
string Format [get, set]
 A format string for the label, with support for a subset ofHTML. Variables are enclosed by curly brackets. Availablevariables are name, options.xxx, color and othermembers from the series object. Use this option also to seta static text for the label. More...
 
string Formatter [get, set]
 Callback function to format each of the series' labels. Thethis keyword refers to the series object. By default theformatter is undefined and the series.name is rendered. More...
 
double MaxFontSize [get, set]
 For area-like series, allow the font size to vary so thatsmall areas get a smaller font size. The default applies thiseffect to area-like series but not line-like series. More...
 
double MinFontSize [get, set]
 For area-like series, allow the font size to vary so thatsmall areas get a smaller font size. The default applies thiseffect to area-like series but not line-like series. More...
 
bool OnArea [get, set]
 Draw the label on the area of an area series. By default itis drawn on the area. Set it to false to draw it next tothe graph instead. More...
 
Hashtable Style [get, set]
 Styles for the series label. The color defaults to the seriescolor, or a contrast color if onArea. More...
 
bool UseHTML [get, set]
 Whether to use HTML to render the series label. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ BoxesToAvoid

List<object> Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.BoxesToAvoid
getset

An array of boxes to avoid when laying out the labels. Eachitem has a left, right, top and bottom property.

◆ ConnectorAllowed

bool Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.ConnectorAllowed
getset

Allow labels to be placed distant to the graph if necessary,and draw a connector line to the graph. Setting this optionto true may decrease the performance significantly, since thealgorithm with systematically search for open spaces in thewhole plot area. Visually, it may also result in a morecluttered chart, though more of the series will be labeled.

◆ ConnectorNeighbourDistance

double Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.ConnectorNeighbourDistance
getset

If the label is closer than this to a neighbour graph, draw aconnector.

◆ Enabled

bool Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.Enabled
getset

Enable the series label per series.

◆ Format

string Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.Format
getset

A format string for the label, with support for a subset ofHTML. Variables are enclosed by curly brackets. Availablevariables are name, options.xxx, color and othermembers from the series object. Use this option also to seta static text for the label.

◆ Formatter

string Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.Formatter
getset

Callback function to format each of the series' labels. Thethis keyword refers to the series object. By default theformatter is undefined and the series.name is rendered.

◆ MaxFontSize

double Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.MaxFontSize
getset

For area-like series, allow the font size to vary so thatsmall areas get a smaller font size. The default applies thiseffect to area-like series but not line-like series.

◆ MinFontSize

double Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.MinFontSize
getset

For area-like series, allow the font size to vary so thatsmall areas get a smaller font size. The default applies thiseffect to area-like series but not line-like series.

◆ OnArea

bool Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.OnArea
getset

Draw the label on the area of an area series. By default itis drawn on the area. Set it to false to draw it next tothe graph instead.

◆ Style

Hashtable Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.Style
getset

Styles for the series label. The color defaults to the seriescolor, or a contrast color if onArea.

◆ UseHTML

bool Highsoft.Web.Mvc.Charts.PlotOptionsAreaLabel.UseHTML
getset

Whether to use HTML to render the series label.


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