asposecells.api

Classes

Constants

Class Legend

Encapsulates the object that represents the chart legend.

Example:

# Set Legend's width and height
workbook = Workbook()
sheetIndex = workbook.getWorksheets().add()
worksheet = workbook.getWorksheets().get(sheetIndex)
charts = worksheet.getCharts()
# Create a chart
chart = charts.get(charts.add(ChartType.COLUMN, 1, 1, 10, 10))
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
`method`	`getArea()`
	Gets the area.
`method`	`getAutoScaleFont()`
`method`	`setAutoScaleFont(value)`
	True if the text in the object changes font size when the object size changes. The default value is True.
`method`	`getBackground()`
`method`	`setBackground(value)`
	Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
`method`	`getBackgroundMode()`
`method`	`setBackgroundMode(value)`
	Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
`method`	`getBorder()`
	Gets the Line.
`method`	`getChart()`
	Gets the chart to which this object belongs.
`method`	`getDefaultHeight()`
	Represents height of default position
`method`	`getDefaultWidth()`
	Represents width of default position
`method`	`getDefaultX()`
	Represents x of default position
`method`	`getDefaultY()`
	Represents y of default position
`method`	`getDirectionType()`
`method`	`setDirectionType(value)`
	Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
`method`	`getFont()`
	Gets a Font object of the specified ChartFrame object.
`method`	`getHeight()`
`method`	`setHeight(value)`
	Gets or sets the height of frame in units of 1/4000 of the chart area.
`method`	`isAutomaticRotation()`
	Indicates whether the text of the chart is automatically rotated.
`method`	`isAutomaticSize()`
`method`	`setAutomaticSize(value)`
	Indicates whether the chart frame is automatic sized.
`method`	`isAutoText()`
`method`	`setAutoText(value)`
	Indicates the text is auto generated.
`method`	`isDefaultPosBeSet()`
	Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
`method`	`isDeleted()`
`method`	`setDeleted(value)`
	Indicates whether this data labels is deleted.
`method`	`isInnerMode()`
`method`	`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.
`method`	`isOverLay()`
`method`	`setOverLay(value)`
	Gets or sets whether showing the legend without overlapping the chart.
`method`	`isResizeShapeToFitText()`
`method`	`setResizeShapeToFitText(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.
`method`	`isTextWrapped()`
`method`	`setTextWrapped(value)`
	Gets or sets a value indicating whether the text is wrapped.
`method`	`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.
`method`	`getLegendEntriesLabels()`
	Gets the labels of the legend entries after call Chart.Calculate() method.
`method`	`getLinkedSource()`
`method`	`setLinkedSource(value)`
	Gets and sets a reference to the worksheet.
`method`	`getPosition()`
`method`	`setPosition(value)`
	Gets or sets the legend position type. The value of the property is LegendPositionType integer constant.
`method`	`getReadingOrder()`
`method`	`setReadingOrder(value)`
	Represents text reading order. The value of the property is TextDirectionType integer constant.
`method`	`getRotationAngle()`
`method`	`setRotationAngle(value)`
	Represents text rotation angle.
`method`	`getShadow()`
`method`	`setShadow(value)`
	True if the frame has a shadow.
`method`	`getShapeProperties()`
	Gets the ShapeProperties object.
`method`	`getText()`
`method`	`setText(value)`
	Gets or sets the text of a frame's title.
`method`	`getTextDirection()`
`method`	`setTextDirection(value)`
	Represents text reading order. The value of the property is TextDirectionType integer constant.
`method`	`getTextFont()`
	Gets a Font object of the specified ChartFrame object.
`method`	`getTextHorizontalAlignment()`
`method`	`setTextHorizontalAlignment(value)`
	Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
`method`	`getTextOptions()`
	Gets and sets the options of the text.
`method`	`getTextVerticalAlignment()`
`method`	`setTextVerticalAlignment(value)`
	Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
`method`	`getWidth()`
`method`	`setWidth(value)`
	Gets or sets the width of frame in units of 1/4000 of the chart area.
`method`	`getX()`
`method`	`setX(value)`
	Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
`method`	`getY()`
`method`	`setY(value)`
	Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.

Method Summary
`method`	`characters(startIndex, length)`
`method`	Returns a Characters object that represents a range of characters within the text.
`method`	`getLegendLabels()`
`method`	Gets the labels of the legend entries after call Chart.Calculate() method.
`method`	`setPositionAuto()`
`method`	Set position of the frame to automatic

- Property Getters/Setters Detail
  - getPosition/setPosition : int
```
int getPosition() / 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
```
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 : ArrayList
```
ArrayList getLegendEntriesLabels()
```
    Gets the labels of the legend entries after call Chart.Calculate() method.
    NOTE: This member is now obsolete. Instead, please use Legend.GetLegendLabels method. This property will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.
  - isOverLay/setOverLay : boolean
```
boolean isOverLay() / setOverLay(value)
```
    Gets or sets whether showing the legend without overlapping the chart.
  - isAutoText/setAutoText : boolean
```
boolean isAutoText() / setAutoText(value)
```
    Indicates the text is auto generated.
  - isDeleted/setDeleted : boolean
```
boolean isDeleted() / setDeleted(value)
```
    Indicates whether this data labels is deleted.
  - getTextHorizontalAlignment/setTextHorizontalAlignment : int
```
int getTextHorizontalAlignment() / setTextHorizontalAlignment(value)
```
    Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
  - getTextVerticalAlignment/setTextVerticalAlignment : int
```
int getTextVerticalAlignment() / setTextVerticalAlignment(value)
```
    Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
  - getRotationAngle/setRotationAngle : int
```
int getRotationAngle() / setRotationAngle(value)
```
    Represents text rotation angle.
    
    0: Not rotated.
    
    255: Top to Bottom.
    
    -90: Downward.
    
    90: Upward.
  - isAutomaticRotation : boolean
```
boolean isAutomaticRotation()
```
    Indicates whether the text of the chart is automatically rotated.
  - getText/setText : String
```
String getText() / setText(value)
```
    Gets or sets the text of a frame's title.
  - getLinkedSource/setLinkedSource : String
```
String getLinkedSource() / setLinkedSource(value)
```
    Gets and sets a reference to the worksheet.
  - getTextDirection/setTextDirection : int
```
int getTextDirection() / setTextDirection(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 : int
```
int getReadingOrder() / setReadingOrder(value)
```
    Represents text reading order. The value of the property is TextDirectionType integer constant.
  - getDirectionType/setDirectionType : int
```
int getDirectionType() / setDirectionType(value)
```
    Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
  - isTextWrapped/setTextWrapped : boolean
```
boolean isTextWrapped() / setTextWrapped(value)
```
    Gets or sets a value indicating whether the text is wrapped.
  - isResizeShapeToFitText/setResizeShapeToFitText : boolean
```
boolean isResizeShapeToFitText() / setResizeShapeToFitText(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 : boolean
```
boolean isInnerMode() / 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
```
Chart getChart()
```
    Gets the chart to which this object belongs.
  - getBorder : Line
```
Line getBorder()
```
    Gets the Line.
  - getArea : Area
```
Area getArea()
```
    Gets the area.
  - getTextFont : Font
```
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.
  - getTextOptions : TextOptions
```
TextOptions getTextOptions()
```
    Gets and sets the options of the text.
  - getFont : Font
```
Font getFont()
```
    Gets a Font object of the specified ChartFrame object.
  - getAutoScaleFont/setAutoScaleFont : boolean
```
boolean getAutoScaleFont() / setAutoScaleFont(value)
```
    True if the text in the object changes font size when the object size changes. The default value is True.
  - getBackgroundMode/setBackgroundMode : int
```
int getBackgroundMode() / setBackgroundMode(value)
```
    Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
  - getBackground/setBackground : int
```
int getBackground() / 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
```
boolean isAutomaticSize() / setAutomaticSize(value)
```
    Indicates whether the chart frame is automatic sized.
  - getX/setX : int
```
int getX() / 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 : int
```
int getY() / 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 : int
```
int getHeight() / 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 : int
```
int getWidth() / 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
```
boolean getShadow() / setShadow(value)
```
    True if the frame has a shadow.
  - getShapeProperties : ShapePropertyCollection
```
ShapePropertyCollection getShapeProperties()
```
    Gets the ShapeProperties object.
  - isDefaultPosBeSet : boolean
```
boolean isDefaultPosBeSet()
```
    Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
  - getDefaultX : int
```
int getDefaultX()
```
    Represents x of default position
  - getDefaultY : int
```
int getDefaultY()
```
    Represents y of default position
  - getDefaultWidth : int
```
int getDefaultWidth()
```
    Represents width of default position
  - getDefaultHeight : int
```
int getDefaultHeight()
```
    Represents height of default position
- Method Detail
  - getLegendLabels
```
String[] getLegendLabels()
```
    Gets the labels of the legend entries after call Chart.Calculate() method.
  - characters
```
FontSetting characters(startIndex, length)
```
    Returns a Characters object that represents a range of characters within the text.
    Parameters:
    startIndex: int - The index of the start of the character.
    length: int - The number of characters.
    Returns:
    Characters object.
  - setPositionAuto
```
 setPositionAuto()
```
    Set position of the frame to automatic

asposecells.api

Classes

Constants

Class Legend

Property Getters/Setters Detail

getPosition/setPosition : int

getLegendEntries : LegendEntryCollection

getLegendEntriesLabels : ArrayList

isOverLay/setOverLay : boolean

isAutoText/setAutoText : boolean

isDeleted/setDeleted : boolean

getTextHorizontalAlignment/setTextHorizontalAlignment : int

getTextVerticalAlignment/setTextVerticalAlignment : int

getRotationAngle/setRotationAngle : int

isAutomaticRotation : boolean

getText/setText : String

getLinkedSource/setLinkedSource : String

getTextDirection/setTextDirection : int

getReadingOrder/setReadingOrder : int

getDirectionType/setDirectionType : int

isTextWrapped/setTextWrapped : boolean

isResizeShapeToFitText/setResizeShapeToFitText : boolean

isInnerMode/setInnerMode : boolean

getChart : Chart

getBorder : Line

getArea : Area

getTextFont : Font

getTextOptions : TextOptions

getFont : Font

getAutoScaleFont/setAutoScaleFont : boolean

getBackgroundMode/setBackgroundMode : int

getBackground/setBackground : int

isAutomaticSize/setAutomaticSize : boolean

getX/setX : int

getY/setY : int

getHeight/setHeight : int

getWidth/setWidth : int

getShadow/setShadow : boolean

getShapeProperties : ShapePropertyCollection

isDefaultPosBeSet : boolean

getDefaultX : int

getDefaultY : int

getDefaultWidth : int

getDefaultHeight : int

Method Detail

getLegendLabels

characters

setPositionAuto