public class HIBubbleLegend extends HIFoundation
Constructor and Description |
---|
HIBubbleLegend() |
Modifier and Type | Method and Description |
---|---|
HIColor |
getBorderColor() |
java.lang.Number |
getBorderWidth() |
java.lang.String |
getClassName() |
HIColor |
getColor() |
java.lang.String |
getConnectorClassName() |
HIColor |
getConnectorColor() |
java.lang.Number |
getConnectorDistance() |
java.lang.Number |
getConnectorWidth() |
java.lang.Boolean |
getEnabled() |
HILabels |
getLabels() |
java.lang.Number |
getLegendIndex() |
java.lang.Number |
getMaxSize() |
java.lang.Number |
getMinSize() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
java.util.ArrayList |
getRanges() |
java.lang.String |
getSizeBy() |
java.lang.Boolean |
getSizeByAbsoluteValue() |
java.lang.Number |
getZIndex() |
java.lang.Number |
getZThreshold() |
void |
setBorderColor(HIColor borderColor)
The color of the ranges borders, can be also defined for an individual range.
|
void |
setBorderWidth(java.lang.Number borderWidth)
The width of the ranges borders in pixels, can be also defined for an individual range.
|
void |
setClassName(java.lang.String className)
An additional class name to apply to the bubble legend' circle graphical elements.
|
void |
setColor(HIColor color)
The main color of the bubble legend.
|
void |
setConnectorClassName(java.lang.String connectorClassName)
An additional class name to apply to the bubble legend's connector graphical elements.
|
void |
setConnectorColor(HIColor connectorColor)
The color of the connector, can be also defined for an individual range.
|
void |
setConnectorDistance(java.lang.Number connectorDistance)
The length of the connectors in pixels.
|
void |
setConnectorWidth(java.lang.Number connectorWidth)
The width of the connectors in pixels.
|
void |
setEnabled(java.lang.Boolean enabled)
Enable or disable the bubble legend.
|
void |
setLabels(HILabels labels)
Options for the bubble legend labels.
|
void |
setLegendIndex(java.lang.Number legendIndex)
The position of the bubble legend in the legend.
|
void |
setMaxSize(java.lang.Number maxSize)
Maximum bubble legend range size.
|
void |
setMinSize(java.lang.Number minSize)
Minimum bubble legend range size.
|
void |
setRanges(java.util.ArrayList ranges)
Options for specific range.
|
void |
setSizeBy(java.lang.String sizeBy)
Whether the bubble legend range value should be represented by the area or the width of the bubble.
|
void |
setSizeByAbsoluteValue(java.lang.Boolean sizeByAbsoluteValue)
When this is true, the absolute value of z determines the size of the bubble.
|
void |
setZIndex(java.lang.Number zIndex)
Define the visual z index of the bubble legend.
|
void |
setZThreshold(java.lang.Number zThreshold)
Ranges with lower value than zThreshold are skipped.
|
public HIColor getBorderColor()
public java.lang.Number getBorderWidth()
public java.lang.String getClassName()
public HIColor getColor()
public java.lang.String getConnectorClassName()
public HIColor getConnectorColor()
public java.lang.Number getConnectorDistance()
public java.lang.Number getConnectorWidth()
public java.lang.Boolean getEnabled()
public HILabels getLabels()
public java.lang.Number getLegendIndex()
public java.lang.Number getMaxSize()
public java.lang.Number getMinSize()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public java.util.ArrayList getRanges()
public java.lang.String getSizeBy()
public java.lang.Boolean getSizeByAbsoluteValue()
public java.lang.Number getZIndex()
public java.lang.Number getZThreshold()
public void setBorderColor(HIColor borderColor)
public void setBorderWidth(java.lang.Number borderWidth)
public void setClassName(java.lang.String className)
public void setColor(HIColor color)
public void setConnectorClassName(java.lang.String connectorClassName)
public void setConnectorColor(HIColor connectorColor)
public void setConnectorDistance(java.lang.Number connectorDistance)
public void setConnectorWidth(java.lang.Number connectorWidth)
public void setEnabled(java.lang.Boolean enabled)
public void setLabels(HILabels labels)
public void setLegendIndex(java.lang.Number legendIndex)
public void setMaxSize(java.lang.Number maxSize)
public void setMinSize(java.lang.Number minSize)
public void setRanges(java.util.ArrayList ranges)
public void setSizeBy(java.lang.String sizeBy)
public void setSizeByAbsoluteValue(java.lang.Boolean sizeByAbsoluteValue)
public void setZIndex(java.lang.Number zIndex)
public void setZThreshold(java.lang.Number zThreshold)