aspose.cells

aspose.cells

Class Legend

Encapsulates the object that represents the chart legend.

Example: 

//Set Legend's width and height
var workbook = new aspose.cells.Workbook();
var sheetIndex = workbook.getWorksheets().add();
var worksheet = workbook.getWorksheets().get(sheetIndex);
var charts = worksheet.getCharts();
//Create a chart
var chart = charts.get(charts.add(aspose.cells.ChartType.COLUMN, 1, 1, 10, 10));
var 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(aspose.cells.LegendPositionType.LEFT);

Property Getters/Setters Summary
functiongetArea()
Gets the area.
functiongetAutoScaleFont()
function
setAutoScaleFont(value)
           True if the text in the object changes font size when the object size changes. The default value is True.
functiongetBackground()
function
setBackground(value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
functiongetBackgroundMode()
function
setBackgroundMode(value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
functiongetBorder()
Gets the Line.
functiongetChart()
functiongetDefaultHeight()
Represents height of default position
functiongetDefaultWidth()
Represents width of default position
functiongetDefaultX()
Represents x of default position
functiongetDefaultY()
Represents y of default position
functiongetFont()
Gets a Font object of the specified ChartFrame object.
functiongetHeight()
function
setHeight(value)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
functionisAutomaticSize()
function
setAutomaticSize(value)
           Indicates whether the chart frame is automatic sized.
functionisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
functionisInnerMode()
function
setInnerMode(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.
functionisOverLay()
function
setOverLay(value)
           Gets or sets whether other chart elements shall be allowed to overlap this chart element.
functiongetLegendEntries()
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.
functiongetLegendEntriesLabels()
Gets the labels of the legend entries after call Chart.Calculate() method.
functiongetPosition()
function
setPosition(value)
           Gets or sets the legend position type. The value of the property is LegendPositionType integer constant.
functiongetShadow()
function
setShadow(value)
           True if the frame has a shadow.
functiongetShapeProperties()
Gets the ShapeProperties object.
functiongetTextFont()
Gets a Font object of the specified ChartFrame object.
functiongetWidth()
function
setWidth(value)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
functiongetX()
function
setX(value)
           Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
functiongetY()
function
setY(value)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
functionsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • getPosition/setPosition : Number 

        function getPosition() / function setPosition(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 : LegendEntryCollection 

        function 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.

      • getLegendEntriesLabels : ArrayList 

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

      • isOverLay/setOverLay : boolean 

        function isOverLay() / function setOverLay(value)
        Gets or sets whether other chart elements shall be allowed to overlap this chart element.

      • isInnerMode/setInnerMode : boolean 

        function isInnerMode() / function setInnerMode(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 : Chart 

        function getChart()

      • getBorder : Line 

        function getBorder()
        Gets the Line.

      • getArea : Area 

        function getArea()
        Gets the area.

      • getTextFont : Font 

        function 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 : Font 

        function getFont()
        Gets a Font object of the specified ChartFrame object.

      • getAutoScaleFont/setAutoScaleFont : boolean 

        function getAutoScaleFont() / function setAutoScaleFont(value)
        True if the text in the object changes font size when the object size changes. The default value is True.

      • getBackgroundMode/setBackgroundMode : Number 

        function getBackgroundMode() / function setBackgroundMode(value)
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

      • getBackground/setBackground : Number 

        function getBackground() / function setBackground(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 : boolean 

        function isAutomaticSize() / function setAutomaticSize(value)
        Indicates whether the chart frame is automatic sized.

      • getX/setX : Number 

        function getX() / function setX(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 : Number 

        function getY() / function setY(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 : Number 

        function getHeight() / function setHeight(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 : Number 

        function getWidth() / function setWidth(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 : boolean 

        function getShadow() / function setShadow(value)
        True if the frame has a shadow.

      • isDefaultPosBeSet : boolean 

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

      • getDefaultX : Number 

        function getDefaultX()
        Represents x of default position

      • getDefaultY : Number 

        function getDefaultY()
        Represents y of default position

      • getDefaultWidth : Number 

        function getDefaultWidth()
        Represents width of default position

      • getDefaultHeight : Number 

        function getDefaultHeight()
        Represents height of default position

    • Method Detail

      • setPositionAuto

        function setPositionAuto()
        Set position of the frame to automatic