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

Inherits BaseObject.

Properties

ColumnrangeSeriesDataLabelsAlign Align [get, set]
 The alignment of the data label compared to the point. If right,the right side of the label should be touching the point. For pointswith an extent, like columns, the alignments also dictates how toalign it inside the box, as given with theinside option. Can be one ofleft, center or right. More...
 
bool AllowOverlap [get, set]
 Whether to allow data labels to overlap. To make the labels lesssensitive for overlapping, thedataLabels.paddingcan be set to 0. More...
 
Animation Animation [get, set]
 Enable or disable the initial animation when a series is displayedfor the dataLabels. The animation can also be set as aconfiguration object. Please note that this option only applies tothe initial animation.For other animations, see chart.animation and theanimation parameter under the API methods. The following propertiesare supported:- defer: The animation delay time in milliseconds. More...
 
bool AnimationBool [get, set]
 Enable or disable the initial animation when a series is displayedfor the dataLabels. The animation can also be set as aconfiguration object. Please note that this option only applies tothe initial animation.For other animations, see chart.animation and theanimation parameter under the API methods. The following propertiesare supported:- defer: The animation delay time in milliseconds. More...
 
string BackgroundColor [get, set]
 The background color or gradient for the data label. Setting it toauto will use the point's color. More...
 
string BorderColor [get, set]
 The border color for the data label. Setting it to auto will usethe point's color. Defaults to undefined. More...
 
double BorderRadius [get, set]
 The border radius in pixels for the data label. More...
 
double BorderWidth [get, set]
 The border width in pixels for the data label. More...
 
string ClassName [get, set]
 A class name for the data label. Particularly in styled mode,this can be used to give each series' or point's data labelunique styling. In addition to this option, a default color classname is added so that we can give the labels a contrast textshadow. More...
 
string Color [get, set]
 This options is deprecated.Use style.color instead.The text color for the data labels. Defaults to undefined. Forcertain series types, like column or map, the data labels can bedrawn inside the points. In this case the data label will bedrawn with maximum contrast by default. Additionally, it will begiven a text-outline style with the opposite color, to furtherincrease the contrast. This can be overridden by setting thetext-outline style to none in the dataLabels.style option. More...
 
bool Crop [get, set]
 Whether to hide data labels that are outside the plot area. Bydefault, the data label is moved inside the plot area accordingto theoverflowoption. More...
 
bool Defer [get, set]
 Whether to defer displaying the data labels until the initialseries animation has finished. Setting to false renders thedata label immediately. If set to true inherits the defertime set in plotOptions.series.animation. More...
 
bool Enabled [get, set]
 Enable or disable the data labels. More...
 
ColumnrangeSeriesDataLabelsFilter Filter [get, set]
 A declarative filter to control of which data labels to display.The declarative filter is designed for use when callbackfunctions are not available, like when the chart options requirea pure JSON structure or for use with graphical editors. Forprogrammatic control, use the formatter instead, and returnundefined to disable a single data label. More...
 
string Format [get, set]
 Aformat stringfor the data label. Available variables are the same as forformatter. More...
 
string Formatter [get, set]
 Callback JavaScript function to format the data label. Note that if aformat is defined, the format takes precedence and the formatter isignored. More...
 
bool Inside [get, set]
 For points with an extent, like columns or map areas, whether toalign the data label inside the box or to the actual value point.Defaults to false in most cases, true in stacked columns. More...
 
string NullFormat [get, set]
 Format for points with the value of null. Works analogously toformat. nullFormat canbe applied only to series which support displaying null pointsi.e heatmap or tilemap. Does not work with series that don'tdisplay null points, like line, column, bar or pie. More...
 
bool NullFormatBool [get, set]
 Format for points with the value of null. Works analogously toformat. nullFormat canbe applied only to series which support displaying null pointsi.e heatmap or tilemap. Does not work with series that don'tdisplay null points, like line, column, bar or pie. More...
 
string NullFormatter [get, set]
 Callback JavaScript function that defines formatting for pointswith the value of null. Works analogously toformatter.nullFormatter can be applied only to series which supportdisplaying null points i.e heatmap or tilemap. Does not workwith series that don't display null points, like line, column,bar or pie. More...
 
ColumnrangeSeriesDataLabelsOverflow Overflow [get, set]
 How to handle data labels that flow outside the plot area. Thedefault is "justify", which aligns them inside the plot area.For columns and bars, this means it will be moved inside the bar.To display data labels outside the plot area, set crop tofalse and overflow to "allow". More...
 
double Padding [get, set]
 When either the borderWidth or the backgroundColor is set,this is the padding within the box. More...
 
ColumnrangeSeriesDataLabelsPosition Position [get, set]
 Aligns data labels relative to points. If center alignment isnot possible, it defaults to right. More...
 
double Rotation [get, set]
 Text rotation in degrees. Note that due to a more complexstructure, backgrounds, borders and padding will be lost on arotated data label. More...
 
Shadow Shadow [get, set]
 The shadow of the box. Works best with borderWidth orbackgroundColor. Since 2.3 the shadow can be an objectconfiguration containing color, offsetX, offsetY, opacityand width. More...
 
bool ShadowBool [get, set]
 The shadow of the box. Works best with borderWidth orbackgroundColor. Since 2.3 the shadow can be an objectconfiguration containing color, offsetX, offsetY, opacityand width. More...
 
string Shape [get, set]
 The name of a symbol to use for the border around the label.Symbols are predefined functions on the Renderer object. More...
 
Hashtable Style [get, set]
 Styles for the label. The default color setting is"contrast", which is a pseudo color that Highcharts picks upand applies the maximum contrast to the underlying point item,for example the bar in a bar chart.The textOutline is a pseudo property that applies an outline ofthe given width with the given color, which by default is themaximum contrast to the text. So a bright text color will resultin a black text outline for maximum readability on a mixedbackground. In some cases, especially with grayscale text, thetext outline doesn't work well, in which cases it can be disabledby setting it to "none". When useHTML is true, thetextOutline will not be picked up. In this, case, the sameeffect can be acheived through the text-shadow CSS property.For some series types, where each point has an extent, like forexample tree maps, the data label may overflow the point. Thereare two strategies for handling overflow. By default, the textwill wrap to multiple lines. The other strategy is to setstyle.textOverflow to ellipsis, which will keep the text onone line plus it will break inside long words. More...
 
ColumnrangeSeriesDataLabelsTextPath TextPath [get, set]
 Options for a label text which should follow marker's shape.Border and background are disabled for a label that follows apath.**Note:** Only SVG-based renderer supports this option. SettinguseHTML to true will disable this option. More...
 
bool UseHTML [get, set]
 Whether touse HTMLto render the labels. More...
 
ColumnrangeSeriesDataLabelsVerticalAlign VerticalAlign [get, set]
 The vertical alignment of a data label. Can be one of top,middle or bottom. The default value depends on the data, forinstance in a column chart, the label is above positive valuesand below negative values. More...
 
double X [get, set]
 The x position offset of the label relative to the point inpixels. More...
 
double Y [get, set]
 The y position offset of the label relative to the point inpixels. More...
 
double ZIndex [get, set]
 The z index of the data labels. Use a zIndex of 6 to display it abovethe series, or use a zIndex of 2 to display it behind the series. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ Align

ColumnrangeSeriesDataLabelsAlign Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Align
getset

The alignment of the data label compared to the point. If right,the right side of the label should be touching the point. For pointswith an extent, like columns, the alignments also dictates how toalign it inside the box, as given with theinside option. Can be one ofleft, center or right.

◆ AllowOverlap

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.AllowOverlap
getset

Whether to allow data labels to overlap. To make the labels lesssensitive for overlapping, thedataLabels.paddingcan be set to 0.

◆ Animation

Animation Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Animation
getset

Enable or disable the initial animation when a series is displayedfor the dataLabels. The animation can also be set as aconfiguration object. Please note that this option only applies tothe initial animation.For other animations, see chart.animation and theanimation parameter under the API methods. The following propertiesare supported:- defer: The animation delay time in milliseconds.

◆ AnimationBool

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.AnimationBool
getset

Enable or disable the initial animation when a series is displayedfor the dataLabels. The animation can also be set as aconfiguration object. Please note that this option only applies tothe initial animation.For other animations, see chart.animation and theanimation parameter under the API methods. The following propertiesare supported:- defer: The animation delay time in milliseconds.

◆ BackgroundColor

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.BackgroundColor
getset

The background color or gradient for the data label. Setting it toauto will use the point's color.

◆ BorderColor

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.BorderColor
getset

The border color for the data label. Setting it to auto will usethe point's color. Defaults to undefined.

◆ BorderRadius

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.BorderRadius
getset

The border radius in pixels for the data label.

◆ BorderWidth

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.BorderWidth
getset

The border width in pixels for the data label.

◆ ClassName

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.ClassName
getset

A class name for the data label. Particularly in styled mode,this can be used to give each series' or point's data labelunique styling. In addition to this option, a default color classname is added so that we can give the labels a contrast textshadow.

◆ Color

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Color
getset

This options is deprecated.Use style.color instead.The text color for the data labels. Defaults to undefined. Forcertain series types, like column or map, the data labels can bedrawn inside the points. In this case the data label will bedrawn with maximum contrast by default. Additionally, it will begiven a text-outline style with the opposite color, to furtherincrease the contrast. This can be overridden by setting thetext-outline style to none in the dataLabels.style option.

◆ Crop

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Crop
getset

Whether to hide data labels that are outside the plot area. Bydefault, the data label is moved inside the plot area accordingto theoverflowoption.

◆ Defer

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Defer
getset

Whether to defer displaying the data labels until the initialseries animation has finished. Setting to false renders thedata label immediately. If set to true inherits the defertime set in plotOptions.series.animation.

◆ Enabled

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

Enable or disable the data labels.

◆ Filter

ColumnrangeSeriesDataLabelsFilter Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Filter
getset

A declarative filter to control of which data labels to display.The declarative filter is designed for use when callbackfunctions are not available, like when the chart options requirea pure JSON structure or for use with graphical editors. Forprogrammatic control, use the formatter instead, and returnundefined to disable a single data label.

◆ Format

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

Aformat stringfor the data label. Available variables are the same as forformatter.

◆ Formatter

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

Callback JavaScript function to format the data label. Note that if aformat is defined, the format takes precedence and the formatter isignored.

◆ Inside

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Inside
getset

For points with an extent, like columns or map areas, whether toalign the data label inside the box or to the actual value point.Defaults to false in most cases, true in stacked columns.

◆ NullFormat

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.NullFormat
getset

Format for points with the value of null. Works analogously toformat. nullFormat canbe applied only to series which support displaying null pointsi.e heatmap or tilemap. Does not work with series that don'tdisplay null points, like line, column, bar or pie.

◆ NullFormatBool

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.NullFormatBool
getset

Format for points with the value of null. Works analogously toformat. nullFormat canbe applied only to series which support displaying null pointsi.e heatmap or tilemap. Does not work with series that don'tdisplay null points, like line, column, bar or pie.

◆ NullFormatter

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.NullFormatter
getset

Callback JavaScript function that defines formatting for pointswith the value of null. Works analogously toformatter.nullFormatter can be applied only to series which supportdisplaying null points i.e heatmap or tilemap. Does not workwith series that don't display null points, like line, column,bar or pie.

◆ Overflow

ColumnrangeSeriesDataLabelsOverflow Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Overflow
getset

How to handle data labels that flow outside the plot area. Thedefault is "justify", which aligns them inside the plot area.For columns and bars, this means it will be moved inside the bar.To display data labels outside the plot area, set crop tofalse and overflow to "allow".

◆ Padding

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Padding
getset

When either the borderWidth or the backgroundColor is set,this is the padding within the box.

◆ Position

ColumnrangeSeriesDataLabelsPosition Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Position
getset

Aligns data labels relative to points. If center alignment isnot possible, it defaults to right.

◆ Rotation

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Rotation
getset

Text rotation in degrees. Note that due to a more complexstructure, backgrounds, borders and padding will be lost on arotated data label.

◆ Shadow

Shadow Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Shadow
getset

The shadow of the box. Works best with borderWidth orbackgroundColor. Since 2.3 the shadow can be an objectconfiguration containing color, offsetX, offsetY, opacityand width.

◆ ShadowBool

bool Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.ShadowBool
getset

The shadow of the box. Works best with borderWidth orbackgroundColor. Since 2.3 the shadow can be an objectconfiguration containing color, offsetX, offsetY, opacityand width.

◆ Shape

string Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Shape
getset

The name of a symbol to use for the border around the label.Symbols are predefined functions on the Renderer object.

◆ Style

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

Styles for the label. The default color setting is"contrast", which is a pseudo color that Highcharts picks upand applies the maximum contrast to the underlying point item,for example the bar in a bar chart.The textOutline is a pseudo property that applies an outline ofthe given width with the given color, which by default is themaximum contrast to the text. So a bright text color will resultin a black text outline for maximum readability on a mixedbackground. In some cases, especially with grayscale text, thetext outline doesn't work well, in which cases it can be disabledby setting it to "none". When useHTML is true, thetextOutline will not be picked up. In this, case, the sameeffect can be acheived through the text-shadow CSS property.For some series types, where each point has an extent, like forexample tree maps, the data label may overflow the point. Thereare two strategies for handling overflow. By default, the textwill wrap to multiple lines. The other strategy is to setstyle.textOverflow to ellipsis, which will keep the text onone line plus it will break inside long words.

◆ TextPath

ColumnrangeSeriesDataLabelsTextPath Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.TextPath
getset

Options for a label text which should follow marker's shape.Border and background are disabled for a label that follows apath.**Note:** Only SVG-based renderer supports this option. SettinguseHTML to true will disable this option.

◆ UseHTML

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

Whether touse HTMLto render the labels.

◆ VerticalAlign

ColumnrangeSeriesDataLabelsVerticalAlign Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.VerticalAlign
getset

The vertical alignment of a data label. Can be one of top,middle or bottom. The default value depends on the data, forinstance in a column chart, the label is above positive valuesand below negative values.

◆ X

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.X
getset

The x position offset of the label relative to the point inpixels.

◆ Y

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.Y
getset

The y position offset of the label relative to the point inpixels.

◆ ZIndex

double Highsoft.Web.Mvc.Charts.ColumnrangeSeriesDataLabels.ZIndex
getset

The z index of the data labels. Use a zIndex of 6 to display it abovethe series, or use a zIndex of 2 to display it behind the series.


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