public class LegendSettings extends AbstractChartObject
StockLegend
class
will be used.
Constructor and Description |
---|
LegendSettings() |
Modifier and Type | Method and Description |
---|---|
Align |
getAlign() |
java.lang.Boolean |
getEqualWidths() |
java.lang.Integer |
getHorizontalGap() |
java.lang.String |
getLabelText() |
java.lang.Integer |
getMarginBottom() |
java.lang.Integer |
getMarginTop() |
java.lang.Double |
getMarkerBorderAlpha() |
Color |
getMarkerBorderColor() |
java.lang.Integer |
getMarkerBorderThickness() |
Color |
getMarkerDisabledColor() |
java.lang.Integer |
getMarkerLabelGap() |
java.lang.Integer |
getMarkerSize() |
MarkerType |
getMarkerType() |
LegendSettingsPosition |
getPosition() |
java.lang.Boolean |
getReversedOrder() |
Color |
getRollOverColor() |
java.lang.Double |
getRollOverGraphAlpha() |
java.lang.Boolean |
getSwitchable() |
Color |
getSwitchColor() |
SwitchType |
getSwitchType() |
java.lang.Boolean |
getTextClickEnabled() |
java.lang.Boolean |
getUseMarkerColorForLabels() |
java.lang.String |
getValueTextComparing() |
java.lang.String |
getValueTextRegular() |
java.lang.Integer |
getValueWidth() |
java.lang.Integer |
getVerticalGap() |
LegendSettings |
setAlign(Align align)
Sets alignment of legend entries.
|
LegendSettings |
setEqualWidths(java.lang.Boolean equalWidths)
Set equalWidths to true if each legend entry should take up much space as the longest legend entry.
|
LegendSettings |
setHorizontalGap(java.lang.Integer horizontalGap)
Sets horizontal space between legend item and left/right border.
|
LegendSettings |
setLabelText(java.lang.String labelText)
Sets the text which will be displayed in the legend.
|
LegendSettings |
setMarginBottom(java.lang.Integer marginBottom)
Sets space below the last row of the legend, in pixels.
|
LegendSettings |
setMarginTop(java.lang.Integer marginTop)
Sets space above the first row of the legend, in pixels.
|
LegendSettings |
setMarkerBorderAlpha(java.lang.Double markerBorderAlpha)
Sets opacity of marker border.
|
LegendSettings |
setMarkerBorderColor(Color markerBorderColor)
Sets marker border color.
|
LegendSettings |
setMarkerBorderThickness(java.lang.Integer markerBorderThickness)
Sets thickness of the legend border.
|
LegendSettings |
setMarkerDisabledColor(Color markerDisabledColor)
Sets color of the disabled marker (when the graph is hidden).
|
LegendSettings |
setMarkerLabelGap(java.lang.Integer markerLabelGap)
Sets space between legend marker and legend text, in pixels.
|
LegendSettings |
setMarkerSize(java.lang.Integer markerSize)
Sets size of the legend marker (key).
|
LegendSettings |
setMarkerType(MarkerType markerType)
Sets shape of the legend marker (key).
|
LegendSettings |
setPosition(LegendSettingsPosition position)
Sets position of legend in panels.
|
LegendSettings |
setReversedOrder(java.lang.Boolean reversedOrder)
Set reversedOrder to true if legend entries should be placed in reversed order.
|
LegendSettings |
setRollOverColor(Color rollOverColor)
Sets legend item text color on roll-over.
|
LegendSettings |
setRollOverGraphAlpha(java.lang.Double rollOverGraphAlpha)
Sets the opacity of the graphs.
|
LegendSettings |
setSwitchable(java.lang.Boolean switchable)
Set switchable to false if graphs shouldn't be shown/hidden by click on the legend marker.
|
LegendSettings |
setSwitchColor(Color switchColor)
Sets legend switch color.
|
LegendSettings |
setSwitchType(SwitchType switchType)
Sets legend switch type (in case the legend is switchable).
|
LegendSettings |
setTextClickEnabled(java.lang.Boolean textClickEnabled)
Set textClickEnabled to true if the legend text should be clickable.
|
LegendSettings |
setUseMarkerColorForLabels(java.lang.Boolean useMarkerColorForLabels)
Set useMarkerColorForLabels to true if legend labels should use the same color as corresponding markers.
|
LegendSettings |
setValueTextComparing(java.lang.String valueTextComparing)
Sets the text which will be displayed in the value portion of the legend when graph is comparable and at least
one dataSet is selected for comparing.
|
LegendSettings |
setValueTextRegular(java.lang.String valueTextRegular)
Sets the text which will be displayed in the value portion of the legend.
|
LegendSettings |
setValueWidth(java.lang.Integer valueWidth)
Sets width of the value text.
|
LegendSettings |
setVerticalGap(java.lang.Integer verticalGap)
Sets vertical space between legend items, in pixels.
|
public Align getAlign()
public LegendSettings setAlign(Align align)
align
- alignment of legend entriespublic java.lang.Boolean getEqualWidths()
public LegendSettings setEqualWidths(java.lang.Boolean equalWidths)
equalWidths
- equalWidths optionpublic java.lang.Integer getHorizontalGap()
public LegendSettings setHorizontalGap(java.lang.Integer horizontalGap)
horizontalGap
- horizontal gappublic java.lang.String getLabelText()
public LegendSettings setLabelText(java.lang.String labelText)
labelText
- textpublic java.lang.Integer getMarginBottom()
public LegendSettings setMarginBottom(java.lang.Integer marginBottom)
marginBottom
- margin bottompublic java.lang.Integer getMarginTop()
public LegendSettings setMarginTop(java.lang.Integer marginTop)
marginTop
- margin toppublic java.lang.Double getMarkerBorderAlpha()
public LegendSettings setMarkerBorderAlpha(java.lang.Double markerBorderAlpha)
markerBorderAlpha
- opacitypublic Color getMarkerBorderColor()
public LegendSettings setMarkerBorderColor(Color markerBorderColor)
markerBorderColor
- colorpublic java.lang.Integer getMarkerBorderThickness()
public LegendSettings setMarkerBorderThickness(java.lang.Integer markerBorderThickness)
markerBorderThickness
- thicknesspublic Color getMarkerDisabledColor()
public LegendSettings setMarkerDisabledColor(Color markerDisabledColor)
markerDisabledColor
- colorpublic java.lang.Integer getMarkerLabelGap()
public LegendSettings setMarkerLabelGap(java.lang.Integer markerLabelGap)
markerLabelGap
- marker label gappublic java.lang.Integer getMarkerSize()
public LegendSettings setMarkerSize(java.lang.Integer markerSize)
markerSize
- marker sizepublic MarkerType getMarkerType()
public LegendSettings setMarkerType(MarkerType markerType)
markerType
- marker typepublic java.lang.Boolean getReversedOrder()
public LegendSettings setReversedOrder(java.lang.Boolean reversedOrder)
reversedOrder
- reversedOrder optionpublic Color getRollOverColor()
public LegendSettings setRollOverColor(Color rollOverColor)
rollOverColor
- colorpublic java.lang.Double getRollOverGraphAlpha()
public LegendSettings setRollOverGraphAlpha(java.lang.Double rollOverGraphAlpha)
rollOverGraphAlpha
- opacitypublic java.lang.Boolean getSwitchable()
public LegendSettings setSwitchable(java.lang.Boolean switchable)
switchable
- switchable optionpublic Color getSwitchColor()
public LegendSettings setSwitchColor(Color switchColor)
switchColor
- colorpublic SwitchType getSwitchType()
public LegendSettings setSwitchType(SwitchType switchType)
switchType
- switch typepublic java.lang.Boolean getTextClickEnabled()
public LegendSettings setTextClickEnabled(java.lang.Boolean textClickEnabled)
textClickEnabled
- textClickEnabled optionpublic java.lang.Boolean getUseMarkerColorForLabels()
public LegendSettings setUseMarkerColorForLabels(java.lang.Boolean useMarkerColorForLabels)
useMarkerColorForLabels
- useMarkerColorForLabels optionpublic java.lang.String getValueTextComparing()
public LegendSettings setValueTextComparing(java.lang.String valueTextComparing)
valueTextComparing
- value text comparingpublic java.lang.String getValueTextRegular()
public LegendSettings setValueTextRegular(java.lang.String valueTextRegular)
valueTextRegular
- value text regularpublic java.lang.Integer getValueWidth()
public LegendSettings setValueWidth(java.lang.Integer valueWidth)
valueWidth
- widthpublic java.lang.Integer getVerticalGap()
public LegendSettings setVerticalGap(java.lang.Integer verticalGap)
verticalGap
- vertical gappublic LegendSettingsPosition getPosition()
public LegendSettings setPosition(LegendSettingsPosition position)
position
- position