Class DataLabels

Constructor Detail

• DataLabels

  public DataLabels()

• DataLabels

  public DataLabels(Boolean enabled)

Method Detail

• getAlign

  public HorizontalAlign getAlign()

  See Also:

  setAlign(HorizontalAlign)

• setAlign

  public void setAlign(HorizontalAlign align)

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

  Defaults to: center

• getAllowOverlap

  public Boolean getAllowOverlap()

  See Also:

  setAllowOverlap(Boolean)

• setAllowOverlap

  public void setAllowOverlap(Boolean allowOverlap)

  Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0.

  Defaults to: false

• getBackgroundColor

  public Color getBackgroundColor()

  Specified by:

  getBackgroundColor in class AbstractDataLabels

  See Also:

  setBackgroundColor(Color)

• setBackgroundColor

  public void setBackgroundColor(Color backgroundColor)

  The background color or gradient for the data label. Defaults to undefined.

  Specified by:

  setBackgroundColor in class AbstractDataLabels

• getBorderColor

  public Color getBorderColor()

  Specified by:

  getBorderColor in class AbstractDataLabels

  See Also:

  setBorderColor(Color)

• setBorderColor

  public void setBorderColor(Color borderColor)

  The border color for the data label. Defaults to undefined.

  Specified by:

  setBorderColor in class AbstractDataLabels

• getBorderRadius

  public Number getBorderRadius()

  Specified by:

  getBorderRadius in class AbstractDataLabels

  See Also:

  setBorderRadius(Number)

• setBorderRadius

  public void setBorderRadius(Number borderRadius)

  The border radius in pixels for the data label.

  Defaults to: 0

  Specified by:

  setBorderRadius in class AbstractDataLabels

• getBorderWidth

  public Number getBorderWidth()

  Specified by:

  getBorderWidth in class AbstractDataLabels

  See Also:

  setBorderWidth(Number)

• setBorderWidth

  public void setBorderWidth(Number borderWidth)

  The border width in pixels for the data label.

  Defaults to: 0

  Specified by:

  setBorderWidth in class AbstractDataLabels

• getClassName

  public String getClassName()

  Specified by:

  getClassName in class AbstractDataLabels

  See Also:

  setClassName(String)

• setClassName

  public void setClassName(String className)

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

  Specified by:

  setClassName in class AbstractDataLabels

• getColor

  public Color getColor()

  Specified by:

  getColor in class AbstractDataLabels

  See Also:

  setColor(Color)

• setColor

  public void setColor(Color color)

  The text color for the data labels. Defaults to null.

  Specified by:

  setColor in class AbstractDataLabels

• getCrop

  public Boolean getCrop()

  Specified by:

  getCrop in class AbstractDataLabels

  See Also:

  setCrop(Boolean)

• setCrop

  public void setCrop(Boolean crop)

  Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot area according to the overflow option.

  Defaults to: true

  Specified by:

  setCrop in class AbstractDataLabels

• getDefer

  public Boolean getDefer()

  Specified by:

  getDefer in class AbstractDataLabels

  See Also:

  setDefer(Boolean)

• setDefer

  public void setDefer(Boolean defer)

  Whether to defer displaying the data labels until the initial series animation has finished.

  Defaults to: true

  Specified by:

  setDefer in class AbstractDataLabels

• getEnabled

  public Boolean getEnabled()

  Specified by:

  getEnabled in class AbstractDataLabels

  See Also:

  setEnabled(Boolean)

• setEnabled

  public void setEnabled(Boolean enabled)

  Enable or disable the data labels.

  Defaults to: false

  Specified by:

  setEnabled in class AbstractDataLabels

• getFormat

  public String getFormat()

  Specified by:

  getFormat in class AbstractDataLabels

  See Also:

  setFormat(String)

• setFormat

  public void setFormat(String format)

  A format string for the data label. Available variables are the same as for formatter.

  Defaults to: {y}

  Specified by:

  setFormat in class AbstractDataLabels

• getFormatter

  public String getFormatter()

  Specified by:

  getFormatter in class AbstractDataLabels

  See Also:

  AbstractDataLabels.setFormatter(String)

• setFormatter

  public void setFormatter(String _fn_formatter)

  Description copied from class: AbstractDataLabels

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

  Specified by:

  setFormatter in class AbstractDataLabels

• getInside

  public Boolean getInside()

  Specified by:

  getInside in class AbstractDataLabels

  See Also:

  setInside(Boolean)

• setInside

  public void setInside(Boolean 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.

  Specified by:

  setInside in class AbstractDataLabels

• getOverflow

  public String getOverflow()

  Specified by:

  getOverflow in class AbstractDataLabels

  See Also:

  setOverflow(String)

• setOverflow

  public void setOverflow(String overflow)

  How to handle data labels that flow outside the plot area. The default 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 to false and overflow to "none".

  Defaults to: justify

  Specified by:

  setOverflow in class AbstractDataLabels

• getPadding

  public Number getPadding()

  Specified by:

  getPadding in class AbstractDataLabels

  See Also:

  setPadding(Number)

• setPadding

  public void setPadding(Number padding)

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

  Defaults to: 5

  Specified by:

  setPadding in class AbstractDataLabels

• getRotation

  public Number getRotation()

  Specified by:

  getRotation in class AbstractDataLabels

  See Also:

  setRotation(Number)

• setRotation

  public void setRotation(Number rotation)

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

  Defaults to: 0

  Specified by:

  setRotation in class AbstractDataLabels

• getShadow

  public Boolean getShadow()

  Specified by:

  getShadow in class AbstractDataLabels

  See Also:

  setShadow(Boolean)

• setShadow

  public void setShadow(Boolean 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.

  Defaults to: false

  Specified by:

  setShadow in class AbstractDataLabels

• getShape

  public Shape getShape()

  Specified by:

  getShape in class AbstractDataLabels

  See Also:

  setShape(Shape)

• setShape

  public void setShape(Shape shape)

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

  Defaults to: square

  Specified by:

  setShape in class AbstractDataLabels

• getStyle

  public Style getStyle()

  Specified by:

  getStyle in class AbstractDataLabels

  See Also:

  setStyle(Style)

• setStyle

  public void setStyle(Style style)

  Styles for the label. The default color setting is "contrast", which is a pseudo color that Highcharts picks up and 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 of the given width with the given color, which by default is the maximum contrast to the text. So a bright text color will result in a black text outline for maximum readability on a mixed background. In some cases, especially with grayscale text, the text outline doesn't work well, in which cases it can be disabled by setting it to "none".

  Defaults to: {"color": "contrast", "fontSize": "11px", "fontWeight": "bold", "textOutline": "1px contrast" }

  Specified by:

  setStyle in class AbstractDataLabels

• getUseHTML

  public Boolean getUseHTML()

  Specified by:

  getUseHTML in class AbstractDataLabels

  See Also:

  setUseHTML(Boolean)

• setUseHTML

  public void setUseHTML(Boolean useHTML)

  Whether to use HTML to render the labels.

  Defaults to: false

  Specified by:

  setUseHTML in class AbstractDataLabels

• getVerticalAlign

  public VerticalAlign getVerticalAlign()

  Specified by:

  getVerticalAlign in class AbstractDataLabels

  See Also:

  setVerticalAlign(VerticalAlign)

• setVerticalAlign

  public void setVerticalAlign(VerticalAlign 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.

  Specified by:

  setVerticalAlign in class AbstractDataLabels

• getX

  public Number getX()

  See Also:

  setX(Number)

• setX

  public void setX(Number x)

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

  Defaults to: 0

• getY

  public Number getY()

  See Also:

  setY(Number)

• setY

  public void setY(Number y)

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

  Defaults to: -6

• getZIndex

  public Number getZIndex()

  Specified by:

  getZIndex in class AbstractDataLabels

  See Also:

  setZIndex(Number)

• setZIndex

  public void setZIndex(Number 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.

  Defaults to: 6

  Specified by:

  setZIndex in class AbstractDataLabels

• getConnectorColor

  public Color getConnectorColor()

  See Also:

  setConnectorColor(Color)

• setConnectorColor

  public void setConnectorColor(Color 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.

  In styled mode, the connector stroke is given in the .highcharts-data-label-connector class.

  Defaults to: {point.color}

• getConnectorPadding

  public Number getConnectorPadding()

  See Also:

  setConnectorPadding(Number)

• setConnectorPadding

  public void setConnectorPadding(Number connectorPadding)

  The distance from the data label to the connector.

  Defaults to: 5

• getConnectorWidth

  public Number getConnectorWidth()

  See Also:

  setConnectorWidth(Number)

• setConnectorWidth

  public void setConnectorWidth(Number connectorWidth)

  The width of the line connecting the data label to the pie slice.

  In styled mode, the connector stroke width is given in the .highcharts-data-label-connector class.

  Defaults to: 1

• getDistance

  public Number getDistance()

  See Also:

  setDistance(Number)

• setDistance

  public void setDistance(Number 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.

  Defaults to: 30

• getSoftConnector

  public Boolean getSoftConnector()

  See Also:

  setSoftConnector(Boolean)

• setSoftConnector

  public void setSoftConnector(Boolean softConnector)

  Whether to render the connector as a soft arc or a line with sharp break.

  Defaults to: true