com.aspose.cells.Legend.html Maven / Gradle / Ivy
Legend
com.aspose.cells
Class Legend
java.lang.Object
ChartFrame
ChartTextFrame
com.aspose.cells.Legend
public class Legend
- extends ChartTextFrame
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 | ||
---|---|---|
Area | getArea() | → inherited from ChartFrame
|
Gets the |
||
boolean | getAutoScaleFont() | → inherited from ChartFrame
|
void | setAutoScaleFont(boolean) | |
True if the text in the object changes font size when the object size changes. The default value is True. | ||
int | getBackground() | → inherited from ChartFrame
|
void | setBackground(int) | |
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. | ||
int | getBackgroundMode() | → inherited from ChartFrame
|
void | setBackgroundMode(int) | |
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. | ||
Line | getBorder() | → inherited from ChartFrame
|
Gets the |
||
Chart | getChart() | → inherited from ChartFrame
|
Gets the chart to which this object belongs. | ||
int | getDefaultHeight() | → inherited from ChartFrame
|
Represents height of default position | ||
int | getDefaultWidth() | → inherited from ChartFrame
|
Represents width of default position | ||
int | getDefaultX() | → inherited from ChartFrame
|
Represents x of default position | ||
int | getDefaultY() | → inherited from ChartFrame
|
Represents y of default position | ||
int | getDirectionType() | → inherited from ChartTextFrame
|
void | setDirectionType(int) | |
Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant. | ||
Font | getFont() | → inherited from ChartFrame
|
Gets a |
||
int | getHeight() | → inherited from ChartFrame
|
void | setHeight(int) | |
Gets or sets the height of frame in units of 1/4000 of the chart area. | ||
boolean | isAutomaticSize() | → inherited from ChartFrame
|
void | setAutomaticSize(boolean) | |
Indicates whether the chart frame is automatic sized. | ||
boolean | isAutoText() | → inherited from ChartTextFrame
|
void | setAutoText(boolean) | |
Indicates the text is auto generated. | ||
boolean | isDefaultPosBeSet() | → inherited from ChartFrame
|
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. | ||
boolean | isDeleted() | → inherited from ChartTextFrame
|
void | setDeleted(boolean) | |
Indicates whether this data labels is deleted. | ||
boolean | isInnerMode() | → inherited from ChartFrame
|
void | setInnerMode(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. | ||
boolean | isOverLay() | |
void | setOverLay(boolean) | |
Gets or sets whether other chart elements shall be allowed to overlap this chart element. | ||
boolean | isResizeShapeToFitText() | → inherited from ChartTextFrame
|
void | setResizeShapeToFitText(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. | ||
boolean | isTextWrapped() | → inherited from ChartTextFrame
|
void | setTextWrapped(boolean) | |
Gets or sets a value indicating whether the text is wrapped. | ||
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. | ||
java.util.ArrayList | getLegendEntriesLabels() | |
Gets the labels of the legend entries after call Chart.Calculate() method. | ||
java.lang.String | getLinkedSource() | → inherited from ChartTextFrame
|
void | setLinkedSource(java.lang.String) | |
Gets and sets a reference to the worksheet. | ||
int | getPosition() | |
void | setPosition(int) | |
Gets or sets the legend position type. The value of the property is LegendPositionType integer constant. | ||
int | getReadingOrder() | → inherited from ChartTextFrame
|
void | setReadingOrder(int) | |
Represents text reading order. The value of the property is TextDirectionType integer constant. | ||
int | getRotationAngle() | → inherited from ChartTextFrame
|
void | setRotationAngle(int) | |
Represents text rotation angle. | ||
boolean | getShadow() | → inherited from ChartFrame
|
void | setShadow(boolean) | |
True if the frame has a shadow. | ||
ShapePropertyCollection | getShapeProperties() | → inherited from ChartFrame
|
Gets the |
||
java.lang.String | getText() | → inherited from ChartTextFrame
|
void | setText(java.lang.String) | |
Gets or sets the text of a frame's title. | ||
int | getTextDirection() | → inherited from ChartTextFrame
|
void | setTextDirection(int) | |
Represents text reading order. The value of the property is TextDirectionType integer constant. | ||
Font | getTextFont() | → inherited from ChartFrame
|
Gets a |
||
int | getTextHorizontalAlignment() | → inherited from ChartTextFrame
|
void | setTextHorizontalAlignment(int) | |
Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant. | ||
int | getTextVerticalAlignment() | → inherited from ChartTextFrame
|
void | setTextVerticalAlignment(int) | |
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant. | ||
int | getWidth() | → inherited from ChartFrame
|
void | setWidth(int) | |
Gets or sets the width of frame in units of 1/4000 of the chart area. | ||
int | getX() | → inherited from ChartFrame
|
void | setX(int) | |
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. | ||
int | getY() | → inherited from ChartFrame
|
void | setY(int) | |
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
Method Summary | ||
---|---|---|
FontSetting | characters(int startIndex, int length) | → inherited from ChartTextFrame
|
Returns a Characters object that represents a range of characters within the text. | ||
void | setPositionAuto() | → 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.
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.
isAutoText/setAutoText | → inherited from ChartTextFrame
|
public boolean isAutoText() / 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.
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.
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.
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.
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.
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.
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.
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.
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.
isTextWrapped/setTextWrapped | → inherited from ChartTextFrame
|
public boolean isTextWrapped() / 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.
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() |
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.
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
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.