public class Legend extends BaseOption
Options for the tooltip that appears when the user hovers over a series or point.
Copyright (c) 2018 Powerbuilt Systems. All rights reserved.Constructor and Description |
---|
Legend() |
Modifier and Type | Method and Description |
---|---|
HorizontalAlign |
align()
The horizontal alignment of the legend box within the chart area.
|
Legend |
align(HorizontalAlign align)
The horizontal alignment of the legend box within the chart area.
|
Boolean |
enabled()
Enable or disable the legend.
|
Legend |
enabled(Boolean enabled)
Enable or disable the legend.
|
HorizontalAlign |
getAlign()
The horizontal alignment of the legend box within the chart area.
|
Boolean |
getEnabled()
Enable or disable the legend.
|
Layout |
getLayout() |
VerticalAlign |
getVerticalAlign()
The vertical alignment of the legend box.
|
Layout |
layout() |
Legend |
layout(Layout layout) |
Legend |
setAlign(HorizontalAlign align)
The horizontal alignment of the legend box within the chart area.
|
Legend |
setEnabled(Boolean enabled)
Enable or disable the legend.
|
Legend |
setLayout(Layout layout) |
Legend |
setVerticalAlign(VerticalAlign verticalAlign)
The vertical alignment of the legend box.
|
VerticalAlign |
verticalAlign()
The vertical alignment of the legend box.
|
Legend |
verticalAlign(VerticalAlign verticalAlign)
The vertical alignment of the legend box.
|
set_hcNulledOption
public HorizontalAlign align()
The horizontal alignment of the legend box within the chart area. Valid values are left
, center
and right
.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
public Legend align(HorizontalAlign align)
The horizontal alignment of the legend box within the chart area. Valid values are left
, center
and right
.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
align
- the value for the align optionpublic HorizontalAlign getAlign()
The horizontal alignment of the legend box within the chart area. Valid values are left
, center
and right
.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
public Legend setAlign(HorizontalAlign align)
The horizontal alignment of the legend box within the chart area. Valid values are left
, center
and right
.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
align
- the value for the align optionpublic Boolean enabled()
Enable or disable the legend.
public Legend enabled(Boolean enabled)
Enable or disable the legend.
enabled
- the value for the enabled optionpublic Boolean getEnabled()
Enable or disable the legend.
public Legend setEnabled(Boolean enabled)
Enable or disable the legend.
enabled
- the value for the enabled optionpublic Layout layout()
public Legend layout(Layout layout)
layout
- the value for the layout optionpublic Layout getLayout()
public Legend setLayout(Layout layout)
layout
- the value for the layout optionpublic VerticalAlign verticalAlign()
The vertical alignment of the legend box. Can be one of top
, middle
or bottom
. Vertical position can be further determined by the y
option.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
When the layout option is proximate
, the verticalAlign
option doesn't apply.
public Legend verticalAlign(VerticalAlign verticalAlign)
The vertical alignment of the legend box. Can be one of top
, middle
or bottom
. Vertical position can be further determined by the y
option.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
When the layout option is proximate
, the verticalAlign
option doesn't apply.
verticalAlign
- the value for the verticalAlign optionpublic VerticalAlign getVerticalAlign()
The vertical alignment of the legend box. Can be one of top
, middle
or bottom
. Vertical position can be further determined by the y
option.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
When the layout option is proximate
, the verticalAlign
option doesn't apply.
public Legend setVerticalAlign(VerticalAlign verticalAlign)
The vertical alignment of the legend box. Can be one of top
, middle
or bottom
. Vertical position can be further determined by the y
option.
In the case that the legend is aligned in a corner position, the layout
option will determine whether to place it above/below or on the side of the plot area.
When the layout option is proximate
, the verticalAlign
option doesn't apply.
verticalAlign
- the value for the verticalAlign optionCopyright © 2022. All rights reserved.