com.aspose.cells

Class Legend

  • java.lang.Object
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()
Gets the area.
booleangetAutoScaleFont()
void
setAutoScaleFont(booleanvalue)
True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()
void
setBackground(intvalue)
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()
void
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()
Gets the Line.
ChartgetChart()
intgetDefaultHeight()
Represents height of default position
intgetDefaultWidth()
Represents width of default position
intgetDefaultX()
Represents x of default position
intgetDefaultY()
Represents y of default position
FontgetFont()
Gets a Font object of the specified ChartFrame object.
intgetHeight()
void
setHeight(intvalue)
Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()
void
setAutomaticSize(booleanvalue)
Indicates whether the chart frame is automatic sized.
booleanisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisInnerMode()
void
setInnerMode(booleanvalue)
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.
booleanisOverLay()
void
setOverLay(booleanvalue)
Gets or sets whether other chart elements shall be allowed to overlap this chart element.
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()
void
setPosition(intvalue)
Gets or sets the legend position type. The value of the property is LegendPositionType integer constant.
booleangetShadow()
void
setShadow(booleanvalue)
True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()
Gets the ShapeProperties object.
FontgetTextFont()
Gets a Font object of the specified ChartFrame object.
intgetWidth()
void
setWidth(intvalue)
Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()
void
setX(intvalue)
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
intgetY()
void
setY(intvalue)
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
voidsetPositionAuto()
Set position of the frame to automatic
 

    • 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.
      • isOverLay/setOverLay

        public boolean isOverLay() / public void setOverLay(boolean value)
        
        Gets or sets whether other chart elements shall be allowed to overlap this chart element.
      • isInnerMode/setInnerMode

        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

        public Chart getChart()
        
      • getBorder

        public Line getBorder()
        
        Gets the Line.
      • getArea

        public Area getArea()
        
        Gets the area.
      • getTextFont

        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

        public Font getFont()
        
        Gets a Font object of the specified ChartFrame object.
      • getAutoScaleFont/setAutoScaleFont

        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

        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

        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

        public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
        
        Indicates whether the chart frame is automatic sized.
      • getX/setX

        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

        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

        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

        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

        public boolean getShadow() / public void setShadow(boolean value)
        
        True if the frame has a shadow.
      • isDefaultPosBeSet

        public boolean isDefaultPosBeSet()
        
        Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
      • getDefaultX

        public int getDefaultX()
        
        Represents x of default position
      • getDefaultY

        public int getDefaultY()
        
        Represents y of default position
      • getDefaultWidth

        public int getDefaultWidth()
        
        Represents width of default position
      • getDefaultHeight

        public int getDefaultHeight()
        
        Represents height of default position
    • Method Detail

      • setPositionAuto

        public void setPositionAuto()
        Set position of the frame to automatic