HILabels

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HILabels

public class HILabels
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HILabels()

Constructors
Constructor and Description
`HILabels()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIAccessibility`	`getAccessibility()`
`java.lang.String`	`getAlign()`
`java.lang.Boolean`	`getAllowOverlap()`
`java.util.ArrayList<java.lang.Number>`	`getAutoRotation()`
`java.lang.Number`	`getAutoRotationLimit()`
`HIColor`	`getBackgroundColor()`
`HIColor`	`getBorderColor()`
`java.lang.Number`	`getBorderRadius()`
`java.lang.Number`	`getBorderWidth()`
`java.lang.String`	`getClassName()`
`java.lang.Boolean`	`getClip()`
`java.lang.Boolean`	`getCrop()`
`java.lang.Object`	`getDistance()`
`java.lang.Boolean`	`getEnabled()`
`java.lang.String`	`getFormat()`
`HIFunction`	`getFormatter()`
`java.lang.Boolean`	`getIncludeInDataExport()`
`java.lang.String`	`getOverflow()`
`java.lang.Number`	`getPadding()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`HIAnnotationMockPointOptionsObject`	`getPoint()`
`java.lang.String`	`getPosition3d()`
`java.lang.Boolean`	`getReserveSpace()`
`java.lang.Number`	`getRotation()`
`HIShadowOptionsObject`	`getShadow()`
`java.lang.String`	`getShape()`
`java.lang.Boolean`	`getSkew3d()`
`java.lang.Number`	`getStaggerLines()`
`java.lang.Number`	`getStep()`
`HICSSObject`	`getStyle()`
`java.lang.String`	`getText()`
`java.lang.Boolean`	`getUseHTML()`
`java.lang.String`	`getVerticalAlign()`
`java.lang.Number`	`getX()`
`java.lang.Number`	`getY()`
`java.lang.Number`	`getZIndex()`
`void`	`setAccessibility(HIAccessibility accessibility)` Accessibility options for an annotation label.
`void`	`setAlign(java.lang.String align)` /** * description: What part of the string the given position is anchored to.
`void`	`setAllowOverlap(java.lang.Boolean allowOverlap)` Whether to allow the axis labels to overlap.
`void`	`setAutoRotation(java.util.ArrayList<java.lang.Number> autoRotation)` For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels.
`void`	`setAutoRotationLimit(java.lang.Number autoRotationLimit)` When each category width is more than this many pixels, we don't apply auto rotation.
`void`	`setBackgroundColor(HIColor backgroundColor)` The background color or gradient for the annotation's label.
`void`	`setBorderColor(HIColor borderColor)` The border color for the annotation's label.
`void`	`setBorderRadius(java.lang.Number borderRadius)` The border radius in pixels for the annotation's label.
`void`	`setBorderWidth(java.lang.Number borderWidth)` The border width in pixels for the annotation's label defaults: 1
`void`	`setClassName(java.lang.String className)` A class name for styling by CSS.
`void`	`setClip(java.lang.Boolean clip)` Whether to hide labels that are outside the plot area.
`void`	`setCrop(java.lang.Boolean crop)` Whether to hide the annotation's label that is outside the plot area.
`void`	`setDistance(java.lang.Object distance)` /** * description: The label's pixel distance from the perimeter of the plot area.
`void`	`setEnabled(java.lang.Boolean enabled)` Enable or disable the axis labels.
`void`	`setFormat(java.lang.String format)` A format string for the axis label.
`void`	`setFormatter(HIFunction formatter)` Callback JavaScript function to format the label.
`void`	`setIncludeInDataExport(java.lang.Boolean includeInDataExport)` Whether the annotation is visible in the exported data table.
`void`	`setOverflow(java.lang.String overflow)` How to handle overflowing labels on horizontal axis.
`void`	`setPadding(java.lang.Number padding)` The pixel padding for axis labels, to ensure white space between them.
`void`	`setPoint(HIAnnotationMockPointOptionsObject point)` This option defines the point to which the label will be connected.
`void`	`setPosition3d(java.lang.String position3d)` Defines how the labels are be repositioned according to the 3D chart orientation. - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick marks, despite the chart orientation.
`void`	`setReserveSpace(java.lang.Boolean reserveSpace)` Whether to reserve space for the labels.
`void`	`setRotation(java.lang.Number rotation)` Rotation of the labels in degrees.
`void`	`setShadow(HIShadowOptionsObject shadow)` The shadow of the box.
`void`	`setShape(java.lang.String shape)` The name of a symbol to use for the border around the label.
`void`	`setSkew3d(java.lang.Boolean skew3d)` If enabled, the axis labels will skewed to follow the perspective.
`void`	`setStaggerLines(java.lang.Number staggerLines)` Horizontal axes only.
`void`	`setStep(java.lang.Number step)` To show only every _n_'th label on the axis, set the step to _n_.
`void`	`setStyle(HICSSObject style)` CSS styles for the label.
`void`	`setText(java.lang.String text)` Alias for the format option.
`void`	`setUseHTML(java.lang.Boolean useHTML)` Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) to render the labels.
`void`	`setVerticalAlign(java.lang.String verticalAlign)` The vertical alignment of the annotation's label.
`void`	`setX(java.lang.Number x)` /** * description: The x position offset of all labels relative to the tick positions on the axis.
`void`	`setY(java.lang.Number y)` /** * description: The y position offset of all labels relative to the tick positions on the axis.
`void`	`setZIndex(java.lang.Number zIndex)` The Z index for the axis labels.

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HILabels
```
public HILabels()
```
- Method Detail
  - getAccessibility
```
public HIAccessibility getAccessibility()
```
  - getAlign
```
public java.lang.String getAlign()
```
  - getAllowOverlap
```
public java.lang.Boolean getAllowOverlap()
```
  - getAutoRotation
```
public java.util.ArrayList<java.lang.Number> getAutoRotation()
```
  - getAutoRotationLimit
```
public java.lang.Number getAutoRotationLimit()
```
  - getBackgroundColor
```
public HIColor getBackgroundColor()
```
  - getBorderColor
```
public HIColor getBorderColor()
```
  - getBorderRadius
```
public java.lang.Number getBorderRadius()
```
  - getBorderWidth
```
public java.lang.Number getBorderWidth()
```
  - getClassName
```
public java.lang.String getClassName()
```
  - getClip
```
public java.lang.Boolean getClip()
```
  - getCrop
```
public java.lang.Boolean getCrop()
```
  - getDistance
```
public java.lang.Object getDistance()
```
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
  - getFormat
```
public java.lang.String getFormat()
```
  - getFormatter
```
public HIFunction getFormatter()
```
  - getIncludeInDataExport
```
public java.lang.Boolean getIncludeInDataExport()
```
  - getOverflow
```
public java.lang.String getOverflow()
```
  - getPadding
```
public java.lang.Number getPadding()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Specified by:
    
    getParams in class HIFoundation
  - getPoint
```
public HIAnnotationMockPointOptionsObject getPoint()
```
  - getPosition3d
```
public java.lang.String getPosition3d()
```
  - getReserveSpace
```
public java.lang.Boolean getReserveSpace()
```
  - getRotation
```
public java.lang.Number getRotation()
```
  - getShadow
```
public HIShadowOptionsObject getShadow()
```
  - getShape
```
public java.lang.String getShape()
```
  - getSkew3d
```
public java.lang.Boolean getSkew3d()
```
  - getStaggerLines
```
public java.lang.Number getStaggerLines()
```
  - getStep
```
public java.lang.Number getStep()
```
  - getStyle
```
public HICSSObject getStyle()
```
  - getText
```
public java.lang.String getText()
```
  - getUseHTML
```
public java.lang.Boolean getUseHTML()
```
  - getVerticalAlign
```
public java.lang.String getVerticalAlign()
```
  - getX
```
public java.lang.Number getX()
```
  - getY
```
public java.lang.Number getY()
```
  - getZIndex
```
public java.lang.Number getZIndex()
```
  - setAccessibility
```
public void setAccessibility(HIAccessibility accessibility)
```
    Accessibility options for an annotation label.
  - setAlign
```
public void setAlign(java.lang.String align)
```
    /** * description: What part of the string the given position is anchored to. Can be one of `"left"`, `"center"` or `"right"`. The exact position also depends on the `labels.x` setting. Angular gauges and solid gauges defaultss to `"center"`. Solid gauges with two labels have additional option `"auto"` for automatic horizontal and vertical alignment. * demo: * [Left](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/yaxis/labels-align-left/) * [Solid gauge labels auto aligned](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-solidgauge/labels-auto-aligned/)
  - setAllowOverlap
```
public void setAllowOverlap(java.lang.Boolean allowOverlap)
```
    Whether to allow the axis labels to overlap. When false, overlapping labels are hidden.
    
    defaults:
    
    false
  - setAutoRotation
```
public void setAutoRotation(java.util.ArrayList<java.lang.Number> autoRotation)
```
    For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels. If there is enough space, labels are not rotated. As the chart gets narrower, it will start rotating the labels -45 degrees, then remove every second label and try again with rotations 0 and -45 etc. Set it to `undefined` to disable rotation, which will cause the labels to word-wrap if possible. Defaults to `[-45]`` on bottom and top axes, `undefined` on left and right axes.
    
    defaults:
    
    undefined
  - setAutoRotationLimit
```
public void setAutoRotationLimit(java.lang.Number autoRotationLimit)
```
    When each category width is more than this many pixels, we don't apply auto rotation. Instead, we lay out the axis label with word wrap. A lower limit makes sense when the label contains multiple short words that don't extend the available horizontal space for each label.
    
    defaults:
    
    80
  - setBackgroundColor
```
public void setBackgroundColor(HIColor backgroundColor)
```
    The background color or gradient for the annotation's label.
    
    defaults:
    
    rgba(0, 0, 0, 0.75)
  - setBorderColor
```
public void setBorderColor(HIColor borderColor)
```
    The border color for the annotation's label.
    
    defaults:
    
    #000000
  - setBorderRadius
```
public void setBorderRadius(java.lang.Number borderRadius)
```
    The border radius in pixels for the annotation's label.
    
    defaults:
    
    3
  - setBorderWidth
```
public void setBorderWidth(java.lang.Number borderWidth)
```
    The border width in pixels for the annotation's label
    
    defaults:
    
    1
  - setClassName
```
public void setClassName(java.lang.String className)
```
    A class name for styling by CSS.
    
    defaults:
    
    highcharts-no-tooltip
  - setClip
```
public void setClip(java.lang.Boolean clip)
```
    Whether to hide labels that are outside the plot area.
    
    defaults:
    
    false
  - setCrop
```
public void setCrop(java.lang.Boolean crop)
```
    Whether to hide the annotation's label that is outside the plot area.
  - setDistance
```
public void setDistance(java.lang.Object distance)
```
    /** * description: The label's pixel distance from the perimeter of the plot area. On cartesian charts, this is overridden if the `labels.y` setting is set. On polar charts, if it's a percentage string, it is interpreted the same as `series.radius`, so the label can be aligned under the gauge's shape. * demo: * [Polar chart, labels centered under the arc](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/yaxis/labels-distance/) defaults: 15
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Enable or disable the axis labels.
    
    defaults:
    
    True
  - setFormat
```
public void setFormat(java.lang.String format)
```
    A format string for the axis label. The context is available as format string variables. For example, you can use `{text}` to insert the defaults formatted text. The recommended way of adding units for the label is using `text`, for example `{text} km`. To add custom numeric or datetime formatting, use `{value}` with formatting, for example `{value:.1f}` or `{value:%Y-%m-%d}`. See [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) for more examples of formatting. The defaults value is not specified due to the dynamic nature of the defaults implementation.
  - setFormatter
```
public void setFormatter(HIFunction formatter)
```
    Callback JavaScript function to format the label. The value is given by `this.value`. Additional properties for `this` are `axis`, `chart`, `isFirst`, `isLast` and `text` which holds the value of the defaults formatter. Defaults to a built in function returning a formatted string depending on whether the axis is `category`, `datetime`, `numeric` or other.
  - setIncludeInDataExport
```
public void setIncludeInDataExport(java.lang.Boolean includeInDataExport)
```
    Whether the annotation is visible in the exported data table.
    
    defaults:
    
    True
  - setOverflow
```
public void setOverflow(java.lang.String overflow)
```
    How to handle overflowing labels on horizontal axis. If set to `"allow"`, it will not be aligned at all. By defaults it `"justify"` labels inside the chart area. If there is room to move it, it will be aligned to the edge, else it will be removed.
    
    defaults:
    
    justify
  - setPadding
```
public void setPadding(java.lang.Number padding)
```
    The pixel padding for axis labels, to ensure white space between them.
    
    defaults:
    
    5
  - setPoint
```
public void setPoint(HIAnnotationMockPointOptionsObject point)
```
    This option defines the point to which the label will be connected. It can be either the point which exists in the series - it is referenced by the point's id - or a new point with defined x, y properties and optionally axes.
  - setPosition3d
```
public void setPosition3d(java.lang.String position3d)
```
    Defines how the labels are be repositioned according to the 3D chart orientation. - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick marks, despite the chart orientation. This is the backwards compatible behavior, and causes skewing of X and Z axes. - `'chart'`: Preserve 3D position relative to the chart. This looks nice, but hard to read if the text isn't forward-facing. - `'flap'`: Rotated text along the axis to compensate for the chart orientation. This tries to maintain text as legible as possible on all orientations. - `'ortho'`: Rotated text along the axis direction so that the labels are orthogonal to the axis. This is very similar to `'flap'`, but prevents skewing the labels (X and Y scaling are still present).
    
    defaults:
    
    offset
  - setReserveSpace
```
public void setReserveSpace(java.lang.Boolean reserveSpace)
```
    Whether to reserve space for the labels. By defaults, space is reserved for the labels in these cases: * On all horizontal axes. * On vertical axes if `label.align` is `right` on a left-side axis or `left` on a right-side axis. * On vertical axes if `label.align` is `center`. This can be turned off when for example the labels are rendered inside the plot area instead of outside.
  - setRotation
```
public void setRotation(java.lang.Number rotation)
```
    Rotation of the labels in degrees. When `undefined`, the `autoRotation` option takes precedence.
    
    defaults:
    
    0
  - setShadow
```
public void setShadow(HIShadowOptionsObject shadow)
```
    The shadow of the box. The shadow can be an object configuration containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  - setShape
```
public void setShape(java.lang.String shape)
```
    The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.
    
    defaults:
    
    callout
  - setSkew3d
```
public void setSkew3d(java.lang.Boolean skew3d)
```
    If enabled, the axis labels will skewed to follow the perspective. This will fix overlapping labels and titles, but texts become less legible due to the distortion. The final appearance depends heavily on `labels.position3d`.
  - setStaggerLines
```
public void setStaggerLines(java.lang.Number staggerLines)
```
    Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels. 0 disables staggering.
  - setStep
```
public void setStep(java.lang.Number step)
```
    To show only every _n_'th label on the axis, set the step to _n_. Setting the step to 2 shows every other label. By defaults, when 0, the step is calculated automatically to avoid overlap. To prevent this, set it to 1\. This usually only happens on a category axis, and is often a sign that you have chosen the wrong axis type. Read more at [Axis docs](https://www.highcharts.com/docs/chart-concepts/axes) => What axis should I use?
  - setStyle
```
public void setStyle(HICSSObject style)
```
    CSS styles for the label. Use `whiteSpace: 'nowrap'` to prevent wrapping of category labels. Use `textOverflow: 'none'` to prevent ellipsis (dots). In styled mode, the labels are styled with the `.highcharts-axis-labels` class.
  - setText
```
public void setText(java.lang.String text)
```
    Alias for the format option.
  - setUseHTML
```
public void setUseHTML(java.lang.Boolean useHTML)
```
    Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) to render the labels.
  - setVerticalAlign
```
public void setVerticalAlign(java.lang.String verticalAlign)
```
    The vertical alignment of the annotation's label.
    
    defaults:
    
    bottom
  - setX
```
public void setX(java.lang.Number x)
```
    /** * description: The x position offset of all labels relative to the tick positions on the axis. Defaults to -15 for left axis, 15 for right axis. * demo: * [Y axis labels placed on grid lines](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/xaxis/labels-x/)
  - setY
```
public void setY(java.lang.Number y)
```
    /** * description: The y position offset of all labels relative to the tick positions on the axis. For polar and radial axis consider the use of the `distance` option. * demo: * [Y axis labels placed on grid lines](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/xaxis/labels-x/) defaults: 3
  - setZIndex
```
public void setZIndex(java.lang.Number zIndex)
```
    The Z index for the axis labels.
    
    defaults:
    
    7

Class HILabels

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HILabels

Method Detail

getAccessibility

getAlign

getAllowOverlap

getAutoRotation

getAutoRotationLimit

getBackgroundColor

getBorderColor

getBorderRadius

getBorderWidth

getClassName

getClip

getCrop

getDistance

getEnabled

getFormat

getFormatter

getIncludeInDataExport

getOverflow

getPadding

getParams

getPoint

getPosition3d

getReserveSpace

getRotation

getShadow

getShape

getSkew3d

getStaggerLines

getStep

getStyle

getText

getUseHTML

getVerticalAlign

getX

getY

getZIndex

setAccessibility

setAlign

setAllowOverlap

setAutoRotation

setAutoRotationLimit

setBackgroundColor

setBorderColor

setBorderRadius

setBorderWidth

setClassName

setClip

setCrop

setDistance

setEnabled

setFormat

setFormatter

setIncludeInDataExport

setOverflow

setPadding

setPoint

setPosition3d

setReserveSpace

setRotation

setShadow

setShape

setSkew3d

setStaggerLines

setStep

setStyle

setText

setUseHTML

setVerticalAlign

setX

setY

setZIndex