com.aspose.cells
Class Legend

java.lang.Object
  ChartFrame
      ChartTextFrame
          com.aspose.cells.Legend

public class Legend 
extends ChartTextFrame

Workbook workbook = new Workbook();
   Worksheet sheet = workbook.getWorksheets().get(0);
        
   Cells cells = sheet.getCells();
   cells.get(0,1).putValue("Income");
   cells.get(1,0).putValue("Company A");
   cells.get(2,0).putValue("Company B");
   cells.get(3,0).putValue("Company C");
   cells.get(1,1).putValue(10000);
   cells.get(2,1).putValue(20000);
   cells.get(3,1).putValue(30000);
           
   int chartIndex = sheet.getCharts().add(ChartType.COLUMN, 9, 9, 21, 15);
   Chart chart = sheet.getCharts().get(chartIndex);
   chart.setChartDataRange("A1:B4", true);
//Set Legend's width and height
Legend legend = chart.getLegend();

//Legend is at right side of chart by default.
//If the legend is at left or right side of the chart, setting Legend.X property will not take effect.
//If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.
legend.setY(1500);
legend.setWidth(50);
legend.setHeight(50); 
//Set legend's position
legend.setPosition(LegendPositionType.LEFT);

public int getPosition() / public void setPosition(int value)

Gets or sets the legend position type. The value of the property is LegendPositionType integer constant.

Default position is right.

If the legend is at left or right side of the chart, setting Legend.X property will not take effect.

If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.

public void setPosition(int value)

public LegendEntryCollection getLegendEntries()

Gets a collection of all the LegendEntry objects in the specified chart legend. Setting the legend entries of the surface chart is not supported. So it will return null if the chart type is surface chart type.

public java.util.ArrayList getLegendEntriesLabels()

Gets the labels of the legend entries after call Chart.Calculate() method.

public boolean isOverLay() / public void setOverLay(boolean value)

Gets or sets whether other chart elements shall be allowed to overlap this chart element.

public void setOverLay(boolean value)

public boolean isAutoText() / public void setAutoText(boolean value)

Indicates the text is auto generated.

public void setAutoText(boolean value)

public boolean isDeleted() / public void setDeleted(boolean value)

Indicates whether this data labels is deleted.

public void setDeleted(boolean value)

public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)

Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.

public void setTextHorizontalAlignment(int value)

public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)

Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.

public void setTextVerticalAlignment(int value)

public int getRotationAngle() / public void setRotationAngle(int value)

Represents text rotation angle.

0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

public void setRotationAngle(int value)

public java.lang.String getText() / public void setText(java.lang.String value)

Gets or sets the text of a frame's title.

public void setText(java.lang.String value)

public java.lang.String getLinkedSource() / public void setLinkedSource(java.lang.String value)

Gets and sets a reference to the worksheet.

public void setLinkedSource(java.lang.String value)

public int getTextDirection() / public void setTextDirection(int value)

Represents text reading order. The value of the property is TextDirectionType integer constant.

NOTE: This member is now obsolete. Instead, please use ChartTextFrame.ReadingOrder property. This property will be removed 12 months later since March 2020. Aspose apologizes for any inconvenience you may have experienced.

public void setTextDirection(int value)

public int getReadingOrder() / public void setReadingOrder(int value)

Represents text reading order. The value of the property is TextDirectionType integer constant.

public void setReadingOrder(int value)

public int getDirectionType() / public void setDirectionType(int value)

Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.

public void setDirectionType(int value)

public boolean isTextWrapped() / public void setTextWrapped(boolean value)

Gets or sets a value indicating whether the text is wrapped.

public void setTextWrapped(boolean value)

public boolean isResizeShapeToFitText() / public void setResizeShapeToFitText(boolean value)

Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.

public void setResizeShapeToFitText(boolean value)

public boolean isInnerMode() / public void setInnerMode(boolean value)

Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.

Only for Xlsx file.

public void setInnerMode(boolean value)

public Chart getChart()

Gets the chart to which this object belongs.

public Line getBorder()

Gets the Line.

public Area getArea()

Gets the area.

public Font getTextFont()

Gets a Font object of the specified ChartFrame object.

NOTE: This member is now obsolete. Instead, please use ChartFrame.Font property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public Font getFont()

Gets a Font object of the specified ChartFrame object.

public boolean getAutoScaleFont() / public void setAutoScaleFont(boolean value)

True if the text in the object changes font size when the object size changes. The default value is True.

public void setAutoScaleFont(boolean value)

public int getBackgroundMode() / public void setBackgroundMode(int value)

Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

public void setBackgroundMode(int value)

public int getBackground() / public void setBackground(int value)

Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

NOTE: This member is now obsolete. Instead, please use ChartFrame.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public void setBackground(int value)

public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)

Indicates whether the chart frame is automatic sized.

public void setAutomaticSize(boolean value)

public int getX() / public void setX(int value)

Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.

How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;

public void setX(int value)

public int getY() / public void setY(int value)

Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.

How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;

public void setY(int value)

public int getHeight() / public void setHeight(int value)

Gets or sets the height of frame in units of 1/4000 of the chart area.

How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;

public void setHeight(int value)

public int getWidth() / public void setWidth(int value)

Gets or sets the width of frame in units of 1/4000 of the chart area.

How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;

public void setWidth(int value)

public boolean getShadow() / public void setShadow(boolean value)

True if the frame has a shadow.

public void setShadow(boolean value)

public ShapePropertyCollection getShapeProperties()

Gets the ShapeProperties object.

public boolean isDefaultPosBeSet()

Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

public int getDefaultX()

Represents x of default position

public int getDefaultY()

Represents y of default position

public int getDefaultWidth()

Represents width of default position

public int getDefaultHeight()

Represents height of default position

public FontSetting characters(int startIndex, int length)

Returns a Characters object that represents a range of characters within the text.

Parameters:

startIndex - The index of the start of the character.

length - The number of characters.

Returns:

Characters object.

public void setPositionAuto()

Set position of the frame to automatic