public class HIAnnotations extends HIFoundation
Constructor and Description |
---|
HIAnnotations() |
Modifier and Type | Method and Description |
---|---|
HIAnimationOptionsObject |
getAnimation() |
HIControlPointOptions |
getControlPointOptions() |
java.lang.Boolean |
getCrop() |
java.lang.String |
getDescriptionMultiplePoints() |
java.lang.String |
getDescriptionNoPoints() |
java.lang.String |
getDescriptionSinglePoint() |
java.lang.String |
getDraggable() |
HIEvents |
getEvents() |
java.lang.String |
getHeading() |
java.lang.Object |
getId() |
java.lang.String |
getItemDelimiter() |
java.lang.Boolean |
getJoin() |
HILabelOptions |
getLabelOptions() |
java.util.ArrayList |
getLabels() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
HIShapeOptions |
getShapeOptions() |
java.util.ArrayList |
getShapes() |
java.lang.Boolean |
getVisible() |
java.lang.Number |
getZIndex() |
void |
setAnimation(HIAnimationOptionsObject animation)
Enable or disable the initial animation when a series is displayed for the `annotation`.
|
void |
setControlPointOptions(HIControlPointOptions controlPointOptions)
Options for annotation's control points.
|
void |
setCrop(java.lang.Boolean crop)
Whether to hide the part of the annotation that is outside the plot area.
|
void |
setDescriptionMultiplePoints(java.lang.String descriptionMultiplePoints) |
void |
setDescriptionNoPoints(java.lang.String descriptionNoPoints) |
void |
setDescriptionSinglePoint(java.lang.String descriptionSinglePoint) |
void |
setDraggable(java.lang.String draggable)
Allow an annotation to be draggable by a user.
|
void |
setEvents(HIEvents events)
Events available in annotations.
|
void |
setHeading(java.lang.String heading) |
void |
setId(java.lang.Object id)
Sets an ID for an annotation.
|
void |
setItemDelimiter(java.lang.String itemDelimiter)
The way to mark the separator for annotations combined in one export-data table cell.
|
void |
setJoin(java.lang.Boolean join)
When several labels are assigned to a specific point, they will be displayed in one field in the table.
|
void |
setLabelOptions(HILabelOptions labelOptions)
Options for annotation's labels.
|
void |
setLabels(java.util.ArrayList labels)
An array of labels for the annotation.
|
void |
setShapeOptions(HIShapeOptions shapeOptions)
Options for annotation's shapes.
|
void |
setShapes(java.util.ArrayList shapes)
An array of shapes for the annotation.
|
void |
setVisible(java.lang.Boolean visible)
Whether the annotation is visible.
|
void |
setZIndex(java.lang.Number zIndex)
The Z index of the annotation.
|
public HIAnimationOptionsObject getAnimation()
public HIControlPointOptions getControlPointOptions()
public java.lang.Boolean getCrop()
public java.lang.String getDescriptionMultiplePoints()
public java.lang.String getDescriptionNoPoints()
public java.lang.String getDescriptionSinglePoint()
public java.lang.String getDraggable()
public HIEvents getEvents()
public java.lang.String getHeading()
public java.lang.Object getId()
public java.lang.String getItemDelimiter()
public java.lang.Boolean getJoin()
public HILabelOptions getLabelOptions()
public java.util.ArrayList getLabels()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public HIShapeOptions getShapeOptions()
public java.util.ArrayList getShapes()
public java.lang.Boolean getVisible()
public java.lang.Number getZIndex()
public void setAnimation(HIAnimationOptionsObject animation)
public void setControlPointOptions(HIControlPointOptions controlPointOptions)
public void setCrop(java.lang.Boolean crop)
public void setDescriptionMultiplePoints(java.lang.String descriptionMultiplePoints)
public void setDescriptionNoPoints(java.lang.String descriptionNoPoints)
public void setDescriptionSinglePoint(java.lang.String descriptionSinglePoint)
public void setDraggable(java.lang.String draggable)
public void setEvents(HIEvents events)
public void setHeading(java.lang.String heading)
public void setId(java.lang.Object id)
public void setItemDelimiter(java.lang.String itemDelimiter)
public void setJoin(java.lang.Boolean join)
public void setLabelOptions(HILabelOptions labelOptions)
public void setLabels(java.util.ArrayList labels)
public void setShapeOptions(HIShapeOptions shapeOptions)
public void setShapes(java.util.ArrayList shapes)
public void setVisible(java.lang.Boolean visible)
public void setZIndex(java.lang.Number zIndex)