Legend Class

The legend of the chart.

Declaration

public class Legend
extends StyledElement

Inherited Members

java.lang.Object.equals(java.lang.Object)(Object)

Object.getClass()

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)(long)

java.lang.Object.wait(long, int)(long,int)

Inheritance

Object

ChartElement

StyledElement

Legend

Legend()

Initializes a new Legend class instance with default parameters.

Declaration

public Legend()

Methods

getHorizontalPosition() Method

Returns the horizontal position of the legend within the chart.

Declaration

public LegendHorizontalPosition getHorizontalPosition()

Returns

Type	Description
LegendHorizontalPosition	The LegendHorizontalPosition enumeration value that specifies the horizontal position.

getOrientation() Method

Returns the legend orientation.

Declaration

public LegendOrientation getOrientation()

Returns

Type	Description
LegendOrientation	The LegendOrientation enumeration value that specifies the legend orientation.

getStyle() Method

Returns the legend style.

Declaration

public LegendStyle getStyle()

Returns

Type	Description
LegendStyle	The LegendStyle object that stores parameters of the legend appearance.

getVerticalPosition() Method

Returns the vertical position of the legend within the chart.

Declaration

public LegendVerticalPosition getVerticalPosition()

Returns

Type	Description
LegendVerticalPosition	The LegendVerticalPosition enumeration value that specifies the vertical position.

isVisible() Method

Returns the value specifying whether the legend is visible.

Declaration

public boolean isVisible()

Returns

Type	Description
boolean	true if the legend is visible; otherwise false.

setHorizontalPosition(LegendHorizontalPosition) Method

Specifies the horizontal position of the legend within the chart.

Declaration

public void setHorizontalPosition(LegendHorizontalPosition value)

Parameters

Name	Type	Description
value	LegendHorizontalPosition	The LegendHorizontalPosition enumeration value that specifies the horizontal position.

setOrientation(LegendOrientation) Method

Specifies the legend orientation.

Declaration

public void setOrientation(LegendOrientation value)

Parameters

Name	Type	Description
value	LegendOrientation	The LegendOrientation enumeration value that specifies the legend orientation.

setStyle(LegendStyle) Method

Specifies the legend style.

Declaration

public void setStyle(LegendStyle style)

Parameters

Name	Type	Description
style	LegendStyle	The LegendStyle object that stores parameters of the legend appearance.

setVerticalPosition(LegendVerticalPosition) Method

Specifies the vertical position of the legend within the chart.

Declaration

public void setVerticalPosition(LegendVerticalPosition value)

Parameters

Name	Type	Description
value	LegendVerticalPosition	The LegendVerticalPosition enumeration value that specifies the vertical position.

setVisible(boolean) Method

Specifies the value specifying whether the legend is visible.

Declaration

public void setVisible(boolean value)

Parameters

Name	Type	Description
value	boolean	true if the legend is visible; otherwise false.