com.aspose.words

Class LegendPosition

java.lang.Object

com.aspose.words.LegendPosition

public class LegendPosition
extends java.lang.Object

Specifies the possible positions for a chart legend.

Examples:

Shows how to edit the appearance of a chart's legend.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.LINE, 450.0, 300.0);
 Chart chart = shape.getChart();

 Assert.assertEquals(3, chart.getSeries().getCount());
 Assert.assertEquals("Series 1", chart.getSeries().get(0).getName());
 Assert.assertEquals("Series 2", chart.getSeries().get(1).getName());
 Assert.assertEquals("Series 3", chart.getSeries().get(2).getName());

 // Move the chart's legend to the top right corner.
 ChartLegend legend = chart.getLegend();
 legend.setPosition(LegendPosition.TOP_RIGHT);

 // Give other chart elements, such as the graph, more room by allowing them to overlap the legend.
 legend.setOverlay(true);

 doc.save(getArtifactsDir() + "Charts.ChartLegend.docx");
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM Specifies that the legend shall be drawn at the bottom of the chart.
static int	LEFT Specifies that the legend shall be drawn at the left of the chart.
static int	length
static int	NONE No legend will be shown for the chart.
static int	RIGHT Specifies that the legend shall be drawn at the right of the chart.
static int	TOP Specifies that the legend shall be drawn at the top of the chart.
static int	TOP_RIGHT Specifies that the legend shall be drawn at the top right of the chart.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String legendPositionName)
static java.lang.String	getName(int legendPosition)
static int[]	getValues()
static java.lang.String	toString(int legendPosition)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static int NONE

No legend will be shown for the chart.

BOTTOM

public static int BOTTOM

Specifies that the legend shall be drawn at the bottom of the chart.

LEFT

public static int LEFT

Specifies that the legend shall be drawn at the left of the chart.

RIGHT

public static int RIGHT

Specifies that the legend shall be drawn at the right of the chart.

TOP

public static int TOP

Specifies that the legend shall be drawn at the top of the chart.

TOP_RIGHT

public static int TOP_RIGHT

Specifies that the legend shall be drawn at the top right of the chart.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int legendPosition)

toString

public static java.lang.String toString(int legendPosition)

fromName

public static int fromName(java.lang.String legendPositionName)

getValues

public static int[] getValues()