public class HILabel extends HIFoundation
Constructor and Description |
---|
HILabel() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlign() |
java.util.ArrayList<HILabelIntersectBoxObject> |
getBoxesToAvoid() |
java.lang.Boolean |
getConnectorAllowed() |
java.lang.Number |
getConnectorNeighbourDistance() |
java.lang.Boolean |
getEnabled() |
java.lang.String |
getFormat() |
HIFunction |
getFormatter() |
java.lang.Number |
getMaxFontSize() |
java.lang.Number |
getMinFontSize() |
java.lang.Boolean |
getOnArea() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
java.lang.Number |
getRotation() |
HICSSObject |
getStyle() |
java.lang.String |
getText() |
java.lang.String |
getTextAlign() |
java.lang.Boolean |
getUseHTML() |
java.lang.String |
getVerticalAlign() |
java.lang.Number |
getX() |
java.lang.Number |
getY() |
void |
setAlign(java.lang.String align)
Horizontal alignment of the label.
|
void |
setBoxesToAvoid(java.util.ArrayList<HILabelIntersectBoxObject> boxesToAvoid)
An array of boxes to avoid when laying out the labels.
|
void |
setConnectorAllowed(java.lang.Boolean connectorAllowed)
Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph.
|
void |
setConnectorNeighbourDistance(java.lang.Number connectorNeighbourDistance)
If the label is closer than this to a neighbour graph, draw a connector.
|
void |
setEnabled(java.lang.Boolean enabled)
Enable the series label per series.
|
void |
setFormat(java.lang.String format)
A format string for the label, with support for a subset of HTML.
|
void |
setFormatter(HIFunction formatter)
Callback function to format each of the series' labels.
|
void |
setMaxFontSize(java.lang.Number maxFontSize)
For area-like series, allow the font size to vary so that small areas get a smaller font size.
|
void |
setMinFontSize(java.lang.Number minFontSize)
For area-like series, allow the font size to vary so that small areas get a smaller font size.
|
void |
setOnArea(java.lang.Boolean onArea)
Draw the label on the area of an area series.
|
void |
setRotation(java.lang.Number rotation)
Rotation of the text label in degrees.
|
void |
setStyle(HICSSObject style)
Styles for the series label.
|
void |
setText(java.lang.String text)
The text itself.
|
void |
setTextAlign(java.lang.String textAlign)
The text alignment for the label.
|
void |
setUseHTML(java.lang.Boolean useHTML)
Whether to use HTML to render the series label.
|
void |
setVerticalAlign(java.lang.String verticalAlign)
Vertical alignment of the label relative to the plot line.
|
void |
setX(java.lang.Number x)
Horizontal position relative the alignment.
|
void |
setY(java.lang.Number y)
Vertical position of the text baseline relative to the alignment.
|
public java.lang.String getAlign()
public java.util.ArrayList<HILabelIntersectBoxObject> getBoxesToAvoid()
public java.lang.Boolean getConnectorAllowed()
public java.lang.Number getConnectorNeighbourDistance()
public java.lang.Boolean getEnabled()
public java.lang.String getFormat()
public HIFunction getFormatter()
public java.lang.Number getMaxFontSize()
public java.lang.Number getMinFontSize()
public java.lang.Boolean getOnArea()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public java.lang.Number getRotation()
public HICSSObject getStyle()
public java.lang.String getText()
public java.lang.String getTextAlign()
public java.lang.Boolean getUseHTML()
public java.lang.String getVerticalAlign()
public java.lang.Number getX()
public java.lang.Number getY()
public void setAlign(java.lang.String align)
public void setBoxesToAvoid(java.util.ArrayList<HILabelIntersectBoxObject> boxesToAvoid)
public void setConnectorAllowed(java.lang.Boolean connectorAllowed)
public void setConnectorNeighbourDistance(java.lang.Number connectorNeighbourDistance)
public void setEnabled(java.lang.Boolean enabled)
public void setFormat(java.lang.String format)
public void setFormatter(HIFunction formatter)
public void setMaxFontSize(java.lang.Number maxFontSize)
public void setMinFontSize(java.lang.Number minFontSize)
public void setOnArea(java.lang.Boolean onArea)
public void setRotation(java.lang.Number rotation)
public void setStyle(HICSSObject style)
public void setText(java.lang.String text)
public void setTextAlign(java.lang.String textAlign)
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)