public class HILabelOptions extends HIFoundation
Constructor and Description |
---|
HILabelOptions() |
Modifier and Type | Method and Description |
---|---|
HIAccessibility |
getAccessibility() |
java.lang.String |
getAlign() |
java.lang.Boolean |
getAllowOverlap() |
HIColor |
getBackgroundColor() |
HIColor |
getBorderColor() |
java.lang.Number |
getBorderRadius() |
java.lang.Number |
getBorderWidth() |
java.lang.String |
getClassName() |
java.lang.Boolean |
getCrop() |
java.lang.Number |
getDistance() |
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() |
HIShadowOptionsObject |
getShadow() |
java.lang.String |
getShape() |
HICSSObject |
getStyle() |
java.lang.String |
getText() |
java.lang.Boolean |
getUseHTML() |
java.lang.String |
getVerticalAlign() |
java.lang.Number |
getX() |
java.lang.Number |
getY() |
void |
setAccessibility(HIAccessibility accessibility)
Accessibility options for an annotation label.
|
void |
setAlign(java.lang.String align)
The alignment of the annotation's label.
|
void |
setAllowOverlap(java.lang.Boolean allowOverlap)
Whether to allow the annotation's labels to overlap.
|
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 |
setCrop(java.lang.Boolean crop)
Whether to hide the annotation's label that is outside the plot area.
|
void |
setDistance(java.lang.Number distance)
The label's pixel distance from the point.
|
void |
setFormat(java.lang.String format)
A [format](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) string for the data label.
|
void |
setFormatter(HIFunction formatter)
Callback JavaScript function to format the annotation's 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 the annotation's label that flow outside the plot area.
|
void |
setPadding(java.lang.Number padding)
When either the borderWidth or the backgroundColor is set, this is the padding within the box.
|
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 |
setStyle(HICSSObject style)
Styles for the annotation's 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 annotation's label.
|
void |
setVerticalAlign(java.lang.String verticalAlign)
The vertical alignment of the annotation's label.
|
void |
setX(java.lang.Number x)
The x position offset of the label relative to the point.
|
void |
setY(java.lang.Number y)
The y position offset of the label relative to the point.
|
public HIAccessibility getAccessibility()
public java.lang.String getAlign()
public java.lang.Boolean getAllowOverlap()
public HIColor getBackgroundColor()
public HIColor getBorderColor()
public java.lang.Number getBorderRadius()
public java.lang.Number getBorderWidth()
public java.lang.String getClassName()
public java.lang.Boolean getCrop()
public java.lang.Number getDistance()
public java.lang.String getFormat()
public HIFunction getFormatter()
public java.lang.Boolean getIncludeInDataExport()
public java.lang.String getOverflow()
public java.lang.Number getPadding()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public HIShadowOptionsObject getShadow()
public java.lang.String getShape()
public HICSSObject getStyle()
public java.lang.String getText()
public java.lang.Boolean getUseHTML()
public java.lang.String getVerticalAlign()
public java.lang.Number getX()
public java.lang.Number getY()
public void setAccessibility(HIAccessibility accessibility)
public void setAlign(java.lang.String align)
public void setAllowOverlap(java.lang.Boolean allowOverlap)
public void setBackgroundColor(HIColor backgroundColor)
public void setBorderColor(HIColor borderColor)
public void setBorderRadius(java.lang.Number borderRadius)
public void setBorderWidth(java.lang.Number borderWidth)
public void setClassName(java.lang.String className)
public void setCrop(java.lang.Boolean crop)
public void setDistance(java.lang.Number distance)
public void setFormat(java.lang.String format)
public void setFormatter(HIFunction formatter)
public void setIncludeInDataExport(java.lang.Boolean includeInDataExport)
public void setOverflow(java.lang.String overflow)
public void setPadding(java.lang.Number padding)
public void setShadow(HIShadowOptionsObject shadow)
public void setShape(java.lang.String shape)
public void setStyle(HICSSObject style)
public void setText(java.lang.String text)
public void setUseHTML(java.lang.Boolean useHTML)
public void setVerticalAlign(java.lang.String verticalAlign)
public void setX(java.lang.Number x)
public void setY(java.lang.Number y)