com.aspose.cells
Class Legend

java.lang.Object
  extended by ChartFrame
      extended by com.aspose.cells.Legend

public class Legend 
extends ChartFrame

Encapsulates the object that represents the chart legend.

Example:

//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);

Property Getters/Setters Summary
AreagetArea()→ inherited from ChartFrame
           Gets the area.
booleangetAutoScaleFont()→ inherited from ChartFrame
voidsetAutoScaleFont(boolean value)
           True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()→ inherited from ChartFrame
voidsetBackground(int value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()→ inherited from ChartFrame
voidsetBackgroundMode(int value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()→ inherited from ChartFrame
           Gets the Line.
ChartgetChart()→ inherited from ChartFrame
          
intgetDefaultHeight()→ inherited from ChartFrame
           Represents height of default position
intgetDefaultWidth()→ inherited from ChartFrame
           Represents width of default position
intgetDefaultX()→ inherited from ChartFrame
           Represents x of default position
intgetDefaultY()→ inherited from ChartFrame
           Represents y of default position
FontgetFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetHeight()→ inherited from ChartFrame
voidsetHeight(int value)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()→ inherited from ChartFrame
voidsetAutomaticSize(boolean value)
           Indicates whether the chart frame is automatic sized.
booleanisDefaultPosBeSet()→ inherited from ChartFrame
           Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisInnerMode()→ inherited from ChartFrame
voidsetInnerMode(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.
LegendEntryCollectiongetLegendEntries()
           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.
intgetPosition()
voidsetPosition(int value)
           Gets or sets the legend position type. The value of the property is LegendPositionType integer constant.
booleangetShadow()→ inherited from ChartFrame
voidsetShadow(boolean value)
           True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()→ inherited from ChartFrame
           Gets the ShapeProperties object.
FontgetTextFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetWidth()→ inherited from ChartFrame
voidsetWidth(int value)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()→ inherited from ChartFrame
voidsetX(int value)
           Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
intgetY()→ inherited from ChartFrame
voidsetY(int value)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 

Property Getters/Setters Detail

getPosition/setPosition

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.

getLegendEntries

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.

isInnerMode/setInnerMode

→ inherited from ChartFrame
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.

getChart

→ inherited from ChartFrame
public Chart getChart()

getBorder

→ inherited from ChartFrame
public Line getBorder()
Gets the Line.

getArea

→ inherited from ChartFrame
public Area getArea()
Gets the area.

getTextFont

→ inherited from ChartFrame
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.

getFont

→ inherited from ChartFrame
public Font getFont()
Gets a Font object of the specified ChartFrame object.

getAutoScaleFont/setAutoScaleFont

→ inherited from ChartFrame
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.

getBackgroundMode/setBackgroundMode

→ inherited from ChartFrame
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.

getBackground/setBackground

→ inherited from ChartFrame
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.

isAutomaticSize/setAutomaticSize

→ inherited from ChartFrame
public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
Indicates whether the chart frame is automatic sized.

getX/setX

→ inherited from ChartFrame
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;

getY/setY

→ inherited from ChartFrame
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;

getHeight/setHeight

→ inherited from ChartFrame
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;

getWidth/setWidth

→ inherited from ChartFrame
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;

getShadow/setShadow

→ inherited from ChartFrame
public boolean getShadow() / public void setShadow(boolean value)
True if the frame has a shadow.

getShapeProperties

→ inherited from ChartFrame
public ShapePropertyCollection getShapeProperties()
Gets the ShapeProperties object.

isDefaultPosBeSet

→ inherited from ChartFrame
public boolean isDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

getDefaultX

→ inherited from ChartFrame
public int getDefaultX()
Represents x of default position

getDefaultY

→ inherited from ChartFrame
public int getDefaultY()
Represents y of default position

getDefaultWidth

→ inherited from ChartFrame
public int getDefaultWidth()
Represents width of default position

getDefaultHeight

→ inherited from ChartFrame
public int getDefaultHeight()
Represents height of default position

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.