public class Legend extends Object implements Serializable
Constructor and Description |
---|
Legend() |
Modifier and Type | Method and Description |
---|---|
String |
encode()
Write the common options of the legend.
|
String |
getAlign()
Alignment of the legend.
|
LegendLabel |
getLabels()
The legend label configuration is nested below the legend configuration using the labels key.
|
String |
getPosition()
Position of the legend.
|
String |
getTextDirection()
Text Direction 'ltr' or 'rtl' regardless of the css specified on the canvas.
|
boolean |
isDisplay()
Is the legend shown?
|
boolean |
isFullWidth()
Marks that this box should take the full width of the canvas (pushing down other boxes).
|
boolean |
isReverse()
Legend will show datasets in reverse order.
|
boolean |
isRtl()
For rendering the legends from right to left.
|
void |
setAlign(String align)
Alignment of the legend.
|
void |
setDisplay(boolean display)
Set if the legend is shown.
|
void |
setFullWidth(boolean fullWidth)
Marks that this box should take the full width of the canvas (pushing down other boxes).
|
void |
setLabels(LegendLabel labels)
The legend label configuration is nested below the legend configuration using the labels key.
|
void |
setPosition(String position)
Position of the legend.
|
void |
setReverse(boolean reverse)
Legend will show datasets in reverse order.
|
void |
setRtl(boolean rtl)
For rendering the legends from right to left.
|
void |
setTextDirection(String textDirection)
Text Direction 'ltr' or 'rtl' regardless of the css specified on the canvas.
|
public boolean isDisplay()
public void setDisplay(boolean display)
display
- the display to setpublic String getPosition()
public void setPosition(String position)
position
- the position to setpublic String getAlign()
public void setAlign(String align)
align
- the align to setpublic boolean isFullWidth()
public void setFullWidth(boolean fullWidth)
fullWidth
- the fullWidth to setpublic boolean isReverse()
public void setReverse(boolean reverse)
reverse
- the reverse to setpublic boolean isRtl()
public void setRtl(boolean rtl)
rtl
- the rtl to setpublic String getTextDirection()
public void setTextDirection(String textDirection)
textDirection
- the textDirection to setpublic LegendLabel getLabels()
public void setLabels(LegendLabel labels)
labels
- the labels to setpublic String encode() throws IOException
IOException
- If an I/O error occursCopyright © 2020. All rights reserved.