All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspose.cells.Legend.html Maven / Gradle / Ivy






Legend




com.aspose.cells
Class Legend

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

public class Legend 
extends ChartTextFrame

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)
           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)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()→ inherited from ChartFrame
voidsetBackgroundMode(int)
           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
           Gets the chart to which this object belongs.
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
intgetDirectionType()→ inherited from ChartTextFrame
voidsetDirectionType(int)
           Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
FontgetFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetHeight()→ inherited from ChartFrame
voidsetHeight(int)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()→ inherited from ChartFrame
voidsetAutomaticSize(boolean)
           Indicates whether the chart frame is automatic sized.
booleanisAutoText()→ inherited from ChartTextFrame
voidsetAutoText(boolean)
           Indicates the text is auto generated.
booleanisDefaultPosBeSet()→ inherited from ChartFrame
           Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisDeleted()→ inherited from ChartTextFrame
voidsetDeleted(boolean)
           Indicates whether this data labels is deleted.
booleanisInnerMode()→ inherited from ChartFrame
voidsetInnerMode(boolean)
           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()
voidsetOverLay(boolean)
           Gets or sets whether other chart elements shall be allowed to overlap this chart element.
booleanisResizeShapeToFitText()→ inherited from ChartTextFrame
voidsetResizeShapeToFitText(boolean)
           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.
booleanisTextWrapped()→ inherited from ChartTextFrame
voidsetTextWrapped(boolean)
           Gets or sets a value indicating whether the text is wrapped.
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.
java.util.ArrayListgetLegendEntriesLabels()
           Gets the labels of the legend entries after call Chart.Calculate() method.
java.lang.StringgetLinkedSource()→ inherited from ChartTextFrame
voidsetLinkedSource(java.lang.String)
           Gets and sets a reference to the worksheet.
intgetPosition()
voidsetPosition(int)
           Gets or sets the legend position type. The value of the property is LegendPositionType integer constant.
intgetReadingOrder()→ inherited from ChartTextFrame
voidsetReadingOrder(int)
           Represents text reading order. The value of the property is TextDirectionType integer constant.
intgetRotationAngle()→ inherited from ChartTextFrame
voidsetRotationAngle(int)
           Represents text rotation angle.
booleangetShadow()→ inherited from ChartFrame
voidsetShadow(boolean)
           True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()→ inherited from ChartFrame
           Gets the ShapeProperties object.
java.lang.StringgetText()→ inherited from ChartTextFrame
voidsetText(java.lang.String)
           Gets or sets the text of a frame's title.
intgetTextDirection()→ inherited from ChartTextFrame
voidsetTextDirection(int)
           Represents text reading order. The value of the property is TextDirectionType integer constant.
FontgetTextFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetTextHorizontalAlignment()→ inherited from ChartTextFrame
voidsetTextHorizontalAlignment(int)
           Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalAlignment()→ inherited from ChartTextFrame
voidsetTextVerticalAlignment(int)
           Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
intgetWidth()→ inherited from ChartFrame
voidsetWidth(int)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()→ inherited from ChartFrame
voidsetX(int)
           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)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
FontSettingcharacters(int startIndex, int length)→ inherited from ChartTextFrame
           Returns a Characters object that represents a range of characters within the text.
voidsetPositionAuto()→ inherited from ChartFrame
           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.

setPosition

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.

getLegendEntriesLabels

public java.util.ArrayList getLegendEntriesLabels()
Gets the labels of the legend entries after call Chart.Calculate() method.

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.

setOverLay

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

isAutoText/setAutoText

→ inherited from ChartTextFrame
public boolean isAutoText() / public void setAutoText(boolean value)
Indicates the text is auto generated.

setAutoText

→ inherited from ChartTextFrame
public void setAutoText(boolean value)
Indicates the text is auto generated.

isDeleted/setDeleted

→ inherited from ChartTextFrame
public boolean isDeleted() / public void setDeleted(boolean value)
Indicates whether this data labels is deleted.

setDeleted

→ inherited from ChartTextFrame
public void setDeleted(boolean value)
Indicates whether this data labels is deleted.

getTextHorizontalAlignment/setTextHorizontalAlignment

→ inherited from ChartTextFrame
public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.

setTextHorizontalAlignment

→ inherited from ChartTextFrame
public void setTextHorizontalAlignment(int value)
Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.

getTextVerticalAlignment/setTextVerticalAlignment

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

setTextVerticalAlignment

→ inherited from ChartTextFrame
public void setTextVerticalAlignment(int value)
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.

getRotationAngle/setRotationAngle

→ inherited from ChartTextFrame
public int getRotationAngle() / public void setRotationAngle(int value)
Represents text rotation angle.
0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

setRotationAngle

→ inherited from ChartTextFrame
public void setRotationAngle(int value)
Represents text rotation angle.
0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

getText/setText

→ inherited from ChartTextFrame
public java.lang.String getText() / public void setText(java.lang.String value)
Gets or sets the text of a frame's title.

setText

→ inherited from ChartTextFrame
public void setText(java.lang.String value)
Gets or sets the text of a frame's title.

getLinkedSource/setLinkedSource

→ inherited from ChartTextFrame
public java.lang.String getLinkedSource() / public void setLinkedSource(java.lang.String value)
Gets and sets a reference to the worksheet.

setLinkedSource

→ inherited from ChartTextFrame
public void setLinkedSource(java.lang.String value)
Gets and sets a reference to the worksheet.

getTextDirection/setTextDirection

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

setTextDirection

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

getReadingOrder/setReadingOrder

→ inherited from ChartTextFrame
public int getReadingOrder() / public void setReadingOrder(int value)
Represents text reading order. The value of the property is TextDirectionType integer constant.

setReadingOrder

→ inherited from ChartTextFrame
public void setReadingOrder(int value)
Represents text reading order. The value of the property is TextDirectionType integer constant.

getDirectionType/setDirectionType

→ inherited from ChartTextFrame
public int getDirectionType() / public void setDirectionType(int value)
Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.

setDirectionType

→ inherited from ChartTextFrame
public void setDirectionType(int value)
Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.

isTextWrapped/setTextWrapped

→ inherited from ChartTextFrame
public boolean isTextWrapped() / public void setTextWrapped(boolean value)
Gets or sets a value indicating whether the text is wrapped.

setTextWrapped

→ inherited from ChartTextFrame
public void setTextWrapped(boolean value)
Gets or sets a value indicating whether the text is wrapped.

isResizeShapeToFitText/setResizeShapeToFitText

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

setResizeShapeToFitText

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

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.

setInnerMode

→ inherited from ChartFrame
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()
Gets the chart to which this object belongs.

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.

setAutoScaleFont

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

setBackgroundMode

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

setBackground

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

setAutomaticSize

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

setX

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

setY

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

setHeight

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

setWidth

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

setShadow

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

Method Detail

characters

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

setPositionAuto

→ inherited from ChartFrame
public void setPositionAuto()
Set position of the frame to automatic

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





© 2015 - 2024 Weber Informatics LLC | Privacy Policy