The requested page is not available for the requested platform. You are viewing the content for Default platform.

LegendStyle Class

The storage of the chart legend's appearance settings.

Declaration

public class LegendStyle
extends TextElementStyleBase

Remarks

The following image shows legend elements which apearance you can modify.

Legend style

Inherited Members

java.lang.Object.equals(java.lang.Object)
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long, int)

Constructors

LegendStyle() Constructor

Initializes a new LegendStyle class instance with default parameters.

Declaration

public LegendStyle()

Methods

getBackgroundColor() Method

Returns the background color of the legend.

Declaration

public Integer getBackgroundColor()

Returns

Type Description
Integer

The Integer object specifying the legend's background color.

getBorderColor() Method

Returns the border color of the legend.

Declaration

public Integer getBorderColor()

Returns

Type Description
Integer

The Integer object specifying the legend's border color.

getBorderThickness() Method

Returns the thickness of the legend border.

Declaration

public Float getBorderThickness()

Returns

Type Description
Float

The thickness of the legend border in pixels.

getBottomIndentFromDiagram() Method

Returns the indent between the legend bottom and the chart.

Declaration

public Integer getBottomIndentFromDiagram()

Returns

Type Description
Integer

The indent, in pixels.

getItemsHorizontalIndent() Method

Returns the indent between horizontally positioned legend's items.

Declaration

public Integer getItemsHorizontalIndent()

Returns

Type Description
Integer

The indent between legend items, in pixels.

getItemsVerticalIndent() Method

Returns the indent between vertically positioned legend's items.

Declaration

public Integer getItemsVerticalIndent()

Returns

Type Description
Integer

The indent between legend items, in pixels.

getLeftIndentFromDiagram() Method

Returns the indent between the legend left and the chart.

Declaration

public Integer getLeftIndentFromDiagram()

Returns

Type Description
Integer

The indent, in pixels.

getMarkerSize() Method

Returns the legend item's marker size.

Declaration

public Integer getMarkerSize()

Returns

Type Description
Integer

The marker size in pixels.

getPaddingBottom() Method

Return the legend bottom padding.

Declaration

public Integer getPaddingBottom()

Returns

Type Description
Integer

The Integer object specifying bottom padding in pixels.

getPaddingLeft() Method

Return the legend left padding.

Declaration

public Integer getPaddingLeft()

Returns

Type Description
Integer

The Integer object specifying left padding in pixels.

getPaddingRight() Method

Return the legend right padding.

Declaration

public Integer getPaddingRight()

Returns

Type Description
Integer

The Integer object specifying right padding in pixels.

getPaddingTop() Method

Return the legend top padding.

Declaration

public Integer getPaddingTop()

Returns

Type Description
Integer

The Integer object specifying top padding in pixels.

getRightIndentFromDiagram() Method

Returns the indent between the legend right and the chart.

Declaration

public Integer getRightIndentFromDiagram()

Returns

Type Description
Integer

The indent, in pixels.

getTextIndent() Method

Returns the indent between a marker and a legend item's text.

Declaration

public Integer getTextIndent()

Returns

Type Description
Integer

The indent between a marker and a legend item's text in pixels.

getTopIndentFromDiagram() Method

Returns the indent between the legend top and the chart.

Declaration

public Integer getTopIndentFromDiagram()

Returns

Type Description
Integer

The indent, in pixels.

setBackgroundColor(Integer) Method

Specidies the background color of the legend.

Declaration

public void setBackgroundColor(Integer backgroundColor)

Parameters

Name Type Description
backgroundColor Integer

The Integer object specifying the legend's background color.

setBorderColor(Integer) Method

Specifies the border color of the legend.

Declaration

public void setBorderColor(Integer borderColor)

Parameters

Name Type Description
borderColor Integer

The Integer object specifying the legend's border color.

setBorderThickness(Float) Method

Specifies the thickness of the legend border.

Declaration

public void setBorderThickness(Float borderThickness)

Parameters

Name Type Description
borderThickness Float

The thickness of the legend border in pixels.

setIndentFromDiagram(Integer, Integer, Integer, Integer) Method

Specifies the indent between the legend and the chart.

Declaration

public void setIndentFromDiagram(Integer left, Integer top, Integer right, Integer bottom)

Parameters

Name Type Description
left Integer

The left indent between the legend and the chart, in pixels.

top Integer

The top indent between the legend and the chart, in pixels.

right Integer

The right indent between the legend and the chart, in pixels.

bottom Integer

The right indent between the legend and the chart, in pixels.

Remarks

If legend is positioned outside the plot area, this property specifies an indent between the plot area and the legend.

setItemsHorizontalIndent(Integer) Method

Specifies the indent between horizontally positioned legend's items.

Declaration

public void setItemsHorizontalIndent(Integer itemsHorizontalIndent)

Parameters

Name Type Description
itemsHorizontalIndent Integer

The indent between legend items, in pixels.

setItemsVerticalIndent(Integer) Method

Specifies the indent between vertically positioned legend's items.

Declaration

public void setItemsVerticalIndent(Integer itemsVerticalIndent)

Parameters

Name Type Description
itemsVerticalIndent Integer

The indent between legend items, in pixels.

setMarkerSize(Integer) Method

Specifies the legend item's marker size.

Declaration

public void setMarkerSize(Integer markerSize)

Parameters

Name Type Description
markerSize Integer

The marker size in pixels.

setPadding(Integer, Integer, Integer, Integer) Method

Specifies the legend paddings in pixels.

Declaration

public void setPadding(Integer left, Integer top, Integer right, Integer bottom)

Parameters

Name Type Description
left Integer

The Integer object specifying the left padding, in pixels.

top Integer

The Integer object specifying the top padding, in pixels.

right Integer

The Integer object specifying the right padding, in pixels.

bottom Integer

The Integer object specifying the bottom padding, in pixels.

setTextIndent(Integer) Method

Specifies the indent between a marker and a legend item's text.

Declaration

public void setTextIndent(Integer textIndent)

Parameters

Name Type Description
textIndent Integer

The indent between a marker and a legend item's text in pixels.