public class HILegend extends HIFoundation
Constructor and Description |
---|
HILegend() |
Modifier and Type | Method and Description |
---|---|
HIAccessibility |
getAccessibility() |
java.lang.String |
getAlign() |
java.lang.Boolean |
getAlignColumns() |
HIColor |
getBackgroundColor() |
HIColor |
getBorderColor() |
java.lang.Number |
getBorderRadius() |
java.lang.Number |
getBorderWidth() |
HIBubbleLegend |
getBubbleLegend() |
java.lang.String |
getClassName() |
java.lang.Boolean |
getEnabled() |
java.lang.Boolean |
getFloating() |
HICSSObject |
getItemCheckboxStyle() |
java.lang.Number |
getItemDistance() |
HICSSObject |
getItemHiddenStyle() |
HICSSObject |
getItemHoverStyle() |
java.lang.Number |
getItemMarginBottom() |
java.lang.Number |
getItemMarginTop() |
HICSSObject |
getItemStyle() |
java.lang.Number |
getItemWidth() |
java.lang.String |
getLabelFormat() |
HIFunction |
getLabelFormatter() |
java.lang.String |
getLayout() |
java.lang.String |
getLegendItem() |
java.lang.String |
getLegendLabel() |
java.lang.String |
getLegendLabelNoTitle() |
java.lang.Number |
getMargin() |
java.lang.Number |
getMaxHeight() |
HINavigation |
getNavigation() |
java.lang.Number |
getPadding() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
java.lang.Boolean |
getReversed() |
java.lang.Boolean |
getRtl() |
HICSSObject |
getShadow() |
java.lang.Boolean |
getSquareSymbol() |
java.lang.Number |
getSymbolHeight() |
java.lang.Number |
getSymbolPadding() |
java.lang.Number |
getSymbolRadius() |
java.lang.Number |
getSymbolWidth() |
HITitle |
getTitle() |
java.lang.Boolean |
getUseHTML() |
java.lang.Number |
getValueDecimals() |
java.lang.String |
getValueSuffix() |
java.lang.String |
getVerticalAlign() |
java.lang.Object |
getWidth() |
java.lang.Number |
getX() |
java.lang.Number |
getY() |
void |
setAccessibility(HIAccessibility accessibility)
Accessibility options for the legend.
|
void |
setAlign(java.lang.String align)
The horizontal alignment of the legend box within the chart area.
|
void |
setAlignColumns(java.lang.Boolean alignColumns)
If the `layout` is `horizontal` and the legend items span over two lines or more, whether to align the items into vertical columns.
|
void |
setBackgroundColor(HIColor backgroundColor)
The background color of the legend.
|
void |
setBorderColor(HIColor borderColor)
The color of the drawn border around the legend.
|
void |
setBorderRadius(java.lang.Number borderRadius)
The border corner radius of the legend.
|
void |
setBorderWidth(java.lang.Number borderWidth)
The width of the drawn border around the legend.
|
void |
setBubbleLegend(HIBubbleLegend bubbleLegend)
The bubble legend is an additional element in legend which presents the scale of the bubble series.
|
void |
setClassName(java.lang.String className)
A CSS class name to apply to the legend group.
|
void |
setEnabled(java.lang.Boolean enabled)
Enable or disable the legend.
|
void |
setFloating(java.lang.Boolean floating)
When the legend is floating, the plot area ignores it and is allowed to be placed below it.
|
void |
setItemCheckboxStyle(HICSSObject itemCheckboxStyle)
Default styling for the checkbox next to a legend item when `showCheckbox` is true.
|
void |
setItemDistance(java.lang.Number itemDistance)
In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.
|
void |
setItemHiddenStyle(HICSSObject itemHiddenStyle)
CSS styles for each legend item when the corresponding series or point is hidden.
|
void |
setItemHoverStyle(HICSSObject itemHoverStyle)
CSS styles for each legend item in hover mode.
|
void |
setItemMarginBottom(java.lang.Number itemMarginBottom)
The pixel bottom margin for each legend item.
|
void |
setItemMarginTop(java.lang.Number itemMarginTop)
The pixel top margin for each legend item.
|
void |
setItemStyle(HICSSObject itemStyle)
CSS styles for each legend item.
|
void |
setItemWidth(java.lang.Number itemWidth)
The width for each legend item.
|
void |
setLabelFormat(java.lang.String labelFormat)
A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) for each legend label.
|
void |
setLabelFormatter(HIFunction labelFormatter)
Callback function to format each of the series' labels.
|
void |
setLayout(java.lang.String layout)
The layout of the legend items.
|
void |
setLegendItem(java.lang.String legendItem)
Accessible label for individual legend items.
|
void |
setLegendLabel(java.lang.String legendLabel)
Accessible label for the legend, for charts where there is a legend title defined.
|
void |
setLegendLabelNoTitle(java.lang.String legendLabelNoTitle)
Accessible label for the legend, for charts where there is no legend title defined.
|
void |
setMargin(java.lang.Number margin)
If the plot area sized is calculated automatically and the legend is not floating, the legend margin is the space between the legend and the axis labels or plot area.
|
void |
setMaxHeight(java.lang.Number maxHeight)
Maximum pixel height for the legend.
|
void |
setNavigation(HINavigation navigation)
Options for the paging or navigation appearing when the legend is overflown.
|
void |
setPadding(java.lang.Number padding)
The inner padding of the legend box.
|
void |
setPointText(HIPoint item)
Set the legend item text.
|
void |
setReversed(java.lang.Boolean reversed)
Whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object.
|
void |
setRtl(java.lang.Boolean rtl)
Whether to show the symbol on the right side of the text rather than the left side.
|
void |
setSeriesText(HISeries item)
Set the legend item text.
|
void |
setShadow(HICSSObject shadow)
Whether to apply a drop shadow to the legend.
|
void |
setSquareSymbol(java.lang.Boolean squareSymbol)
When this is true, the legend symbol width will be the same as the symbol height, which in turn defaultss to the font size of the legend items.
|
void |
setSymbolHeight(java.lang.Number symbolHeight)
The pixel height of the symbol for series types that use a rectangle in the legend.
|
void |
setSymbolPadding(java.lang.Number symbolPadding)
The pixel padding between the legend item symbol and the legend item text.
|
void |
setSymbolRadius(java.lang.Number symbolRadius)
The border radius of the symbol for series types that use a rectangle in the legend.
|
void |
setSymbolWidth(java.lang.Number symbolWidth)
The pixel width of the legend item symbol.
|
void |
setTitle(HITitle title)
A title to be added on top of the legend.
|
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 legend item texts.
|
void |
setValueDecimals(java.lang.Number valueDecimals)
For a color axis with data classes, how many decimals to render in the legend.
|
void |
setValueSuffix(java.lang.String valueSuffix)
For a color axis with data classes, a suffix for the range numbers in the legend.
|
void |
setVerticalAlign(java.lang.String verticalAlign)
The vertical alignment of the legend box.
|
void |
setWidth(java.lang.Object width)
The width of the legend box.
|
void |
setX(java.lang.Number x)
The x offset of the legend relative to its horizontal alignment `align` within chart.spacingLeft and chart.spacingRight.
|
void |
setY(java.lang.Number y)
The vertical offset of the legend relative to it's vertical alignment `verticalAlign` within chart.spacingTop and chart.spacingBottom.
|
void |
update(HILegend options)
Update the legend with new options.
|
void |
update(HILegend options,
boolean redraw)
Update the legend with new options.
|
public HIAccessibility getAccessibility()
public java.lang.String getAlign()
public java.lang.Boolean getAlignColumns()
public HIColor getBackgroundColor()
public HIColor getBorderColor()
public java.lang.Number getBorderRadius()
public java.lang.Number getBorderWidth()
public HIBubbleLegend getBubbleLegend()
public java.lang.String getClassName()
public java.lang.Boolean getEnabled()
public java.lang.Boolean getFloating()
public HICSSObject getItemCheckboxStyle()
public java.lang.Number getItemDistance()
public HICSSObject getItemHiddenStyle()
public HICSSObject getItemHoverStyle()
public java.lang.Number getItemMarginBottom()
public java.lang.Number getItemMarginTop()
public HICSSObject getItemStyle()
public java.lang.Number getItemWidth()
public java.lang.String getLabelFormat()
public HIFunction getLabelFormatter()
public java.lang.String getLayout()
public java.lang.String getLegendItem()
public java.lang.String getLegendLabel()
public java.lang.String getLegendLabelNoTitle()
public java.lang.Number getMargin()
public java.lang.Number getMaxHeight()
public HINavigation getNavigation()
public java.lang.Number getPadding()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public java.lang.Boolean getReversed()
public java.lang.Boolean getRtl()
public HICSSObject getShadow()
public java.lang.Boolean getSquareSymbol()
public java.lang.Number getSymbolHeight()
public java.lang.Number getSymbolPadding()
public java.lang.Number getSymbolRadius()
public java.lang.Number getSymbolWidth()
public HITitle getTitle()
public java.lang.Boolean getUseHTML()
public java.lang.Number getValueDecimals()
public java.lang.String getValueSuffix()
public java.lang.String getVerticalAlign()
public java.lang.Object getWidth()
public java.lang.Number getX()
public java.lang.Number getY()
public void setAccessibility(HIAccessibility accessibility)
public void setAlign(java.lang.String align)
public void setAlignColumns(java.lang.Boolean alignColumns)
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 setBubbleLegend(HIBubbleLegend bubbleLegend)
public void setClassName(java.lang.String className)
public void setEnabled(java.lang.Boolean enabled)
public void setFloating(java.lang.Boolean floating)
public void setItemCheckboxStyle(HICSSObject itemCheckboxStyle)
public void setItemDistance(java.lang.Number itemDistance)
public void setItemHiddenStyle(HICSSObject itemHiddenStyle)
public void setItemHoverStyle(HICSSObject itemHoverStyle)
public void setItemMarginBottom(java.lang.Number itemMarginBottom)
public void setItemMarginTop(java.lang.Number itemMarginTop)
public void setItemStyle(HICSSObject itemStyle)
public void setItemWidth(java.lang.Number itemWidth)
public void setLabelFormat(java.lang.String labelFormat)
public void setLabelFormatter(HIFunction labelFormatter)
public void setLayout(java.lang.String layout)
public void setLegendItem(java.lang.String legendItem)
public void setLegendLabel(java.lang.String legendLabel)
public void setLegendLabelNoTitle(java.lang.String legendLabelNoTitle)
public void setMargin(java.lang.Number margin)
public void setMaxHeight(java.lang.Number maxHeight)
public void setNavigation(HINavigation navigation)
public void setPadding(java.lang.Number padding)
public void setPointText(HIPoint item)
item
- The item for which to update the text in the legend.public void setReversed(java.lang.Boolean reversed)
public void setRtl(java.lang.Boolean rtl)
public void setSeriesText(HISeries item)
item
- The item for which to update the text in the legend.public void setShadow(HICSSObject shadow)
public void setSquareSymbol(java.lang.Boolean squareSymbol)
public void setSymbolHeight(java.lang.Number symbolHeight)
public void setSymbolPadding(java.lang.Number symbolPadding)
public void setSymbolRadius(java.lang.Number symbolRadius)
public void setSymbolWidth(java.lang.Number symbolWidth)
public void setTitle(HITitle title)
public void setUseHTML(java.lang.Boolean useHTML)
public void setValueDecimals(java.lang.Number valueDecimals)
public void setValueSuffix(java.lang.String valueSuffix)
public void setVerticalAlign(java.lang.String verticalAlign)
public void setWidth(java.lang.Object width)
public void setX(java.lang.Number x)
public void setY(java.lang.Number y)
public void update(HILegend options)
options
- Legend options.public void update(HILegend options, boolean redraw)
options
- Legend options.redraw
- Whether to redraw the chart after the axis is altered. If doing more operations on the chart, it is a good idea to set redraw to false and call HIChartView redraw() after. Whether to redraw the chart.