#PlotOptionsFunnelDataLabels

##Properties

Datatype Property name Property description Default Value
BackColorOrGradient BackgroundColor The background color or gradient for the data label. Defaults to undefined. null
Nullable BorderColor The border color for the data label. Defaults to undefined. null
Nullable BorderRadius The border radius in pixels for the data label. Defaults to 0. Default: 0 null
Nullable BorderWidth The border width in pixels for the data label. Defaults to 0. Default: 0 null
Nullable Color The text color for the data labels. Defaults to null. null
Nullable ConnectorColor The color of the line connecting the data label to the pie slice. The default color is the same as the point's color. Default: {point.color} null
Nullable ConnectorPadding The distance from the data label to the connector. Default: 5 null
Nullable ConnectorWidth The width of the line connecting the data label to the pie slice. Default: 1 null
Nullable Crop Whether to hide data labels that are outside the plot area. By default, a data label only shows if the point or the data label is within the plot area. Default: true null
Nullable Distance The distance of the data label from the pie's edge. Negative numbers put the data label on top of the pie slices. Connectors are only shown for data labels outside the pie. Default: 30 null
Nullable Enabled Enable or disable the data labels. Default: true null
String Format A format string for the data label. Available variables are the same as for formatter. Default: {y} null
String Formatter Callback JavaScript function to format the data label. Available data are:<table><tbody><tr><td>this.percentage</td><td>Stacked series and pies only. The point's percentage of the total.</td></tr><tr><td>this.point</td><td>The point object. The point name, if defined, is available through this.point.name.</td></tr><tr><td>this.series:</td><td>The series object. The series name is available through this.series.name.</td></tr><tr><td>this.total</td><td>Stacked series only. The total value at this point's x value.</td></tr><tr><td>this.x:</td><td>The y value.</td></tr><tr><td>this.y:</td><td>The y value.</td></tr></tbody></table> null
Nullable Inside For points with an extent, like columns, whether to align the data label inside the box or to the actual value point. Defaults to false in most cases, true in stacked columns. null
Nullable Padding When either the borderWidth or the backgroundColor is set, this is the padding within the box. Defaults to 2. Default: 2 null
Nullable Rotation Text rotation in degrees. Defaults to 0. Default: 0 null
Nullable Shadow The shadow of the box. Works best with borderWidth or backgroundColor. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width. Default: false null
Nullable SoftConnector Whether to render the connector as a soft arc or a line with sharp break. Default: true null
String Style Styles for the label. null
Nullable UseHTML Whether to use HTML to render the labels. Using HTML allows advanced formatting, images and reliable bi-directional text rendering. Note that exported images won't respect the HTML, and that HTML won't respect Z-index settings. Default: false null
Nullable VerticalAlign The vertical alignment of a data label. Can be one of top, middle or bottom. The default value depends on the data, for instance in a column chart, the label is above positive values and below negative values. null
Nullable X The x position offset of the label relative to the point. Defaults to 0. Default: 0 null
Nullable Y The y position offset of the label relative to the point. Defaults to -6. Default: -6 null
Nullable ZIndex The Z index of the data labels. The default Z index puts it above the series. Use a Z index of 2 to display it behind the series. Default: 6 null

##Methods

###Equals(System.Object) Determines whether the specified System.Object is equal to the current System.Object.

Parameters:

Returns:

true if the specified System.Object is equal to the current System.Object; otherwise, false.

###GetHashCode() Serves as a hash function for a particular type.

Returns:

A hash code for the current System.Object.

###GetType() Gets the System.Type of the current instance.

Returns:

The System.Type instance that represents the exact runtime type of the current instance.

###ToString() Returns a System.String that represents the current System.Object.

Returns:

A System.String that represents the current System.Object.

Izenda Logo