Legend class
Legend class
Encapsulates the object that represents the chart legend.
Inheritance: Legend →
ChartTextFrame →
ChartFrame
The Legend type exposes the following members:
Properties
| Property | Description |
|---|---|
| is_inner_mode | 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. |
| border | Gets the Line. |
| area | Gets the ChartFrame.area. |
| text_font | Gets a ChartFrame.font object of the specified ChartFrame object. |
| text_options | Gets and sets the options of the text. |
| font | Gets a ChartFrame.font object of the specified ChartFrame object. |
| auto_scale_font | True if the text in the object changes font size when the object size changes. The default value is True. |
| background_mode | Gets and sets the display mode of the background |
| background | Gets and sets the display mode of the background |
| is_automatic_size | Indicates whether the chart frame is automatic sized. |
| x | Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. |
| y | Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
| height | Gets or sets the height of frame in units of 1/4000 of the chart area. |
| width | Gets or sets the width of frame in units of 1/4000 of the chart area. |
| shadow | True if the frame has a shadow. |
| shape_properties | Gets the ChartFrame.shape_properties object. |
| is_default_pos_be_set | Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
| default_x | Represents x of default position in units of 1/4000 of the chart area. |
| default_y | Represents y of default position in units of 1/4000 of the chart area. |
| default_width | Represents width of default position in units of 1/4000 of the chart area. |
| default_height | Represents height of default position in units of 1/4000 of the chart area. |
| default_x_ratio_to_chart | Represents x of default position in units of Fraction of the chart area. |
| default_y_ratio_to_chart | Represents y of default position in units of Fraction of the chart area. |
| default_width_ratio_to_chart | Represents width of default position in units of Fraction of the chart area. |
| default_height_ratio_to_chart | Represents height of default position in units of Fraction of the chart area. |
| x_ratio_to_chart | Gets or sets the x coordinate of the upper left corner in units of ratio of the chart area. |
| y_ratio_to_chart | Gets or sets the y coordinate of the upper left corner in units of ratio of the chart area. |
| width_ratio_to_chart | Gets or sets the width of frame in units of ratio of the chart area. |
| height_ratio_to_chart | Gets or sets the height of frame in units of ratio of the chart area. |
| x_pixel | Gets or sets the x coordinate of the upper left corner in units of Pixel. |
| y_pixel | Gets or sets the y coordinate of the upper left corner in units of Pixel. |
| width_pixel | Gets or sets the width of frame in units of Pixel. |
| height_pixel | Gets or sets the height of frame in units of Pixel. |
| is_auto_text | Indicates the text is auto generated. |
| is_deleted | Indicates whether this data labels is deleted. |
| text_horizontal_alignment | Gets and sets the text horizontal alignment. |
| text_vertical_alignment | Gets or sets the text vertical alignment of text. |
| rotation_angle | Represents text rotation angle. |
| is_automatic_rotation | Indicates whether the text of the chart is automatically rotated. |
| text | Gets or sets the text of a frame’s title. |
| linked_source | Gets and sets a reference to the worksheet. |
| text_direction | Represents text reading order. |
| reading_order | Represents text reading order. |
| direction_type | Gets and sets the direction of text. |
| is_text_wrapped | Gets or sets a value indicating whether the text is wrapped. |
| is_resize_shape_to_fit_text | 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. |
| position | Gets or sets the legend position type. |
| legend_entries | 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. |
| legend_entries_labels | Gets the labels of the legend entries after call Chart.Calculate() method. |
| is_over_lay | Gets or sets whether showing the legend without overlapping the chart. |
Methods
| Method | Description |
|---|---|
set_position_auto(self) | Set position of the frame to automatic |
characters(self, start_index, length) | Returns a Characters object that represents a range of characters within the text. |
get_legend_labels(self) | Gets the labels of the legend entries after call Chart.Calculate() method. |
Example
from aspose.cells import Workbook
from aspose.cells.charts import ChartType, LegendPositionType
workbook = Workbook()
sheet = workbook.worksheets[0]
cells = sheet.cells
cells.get(0, 1).put_value("Income")
cells.get(1, 0).put_value("Company A")
cells.get(2, 0).put_value("Company B")
cells.get(3, 0).put_value("Company C")
cells.get(1, 1).put_value(10000)
cells.get(2, 1).put_value(20000)
cells.get(3, 1).put_value(30000)
chartIndex = sheet.charts.add(ChartType.COLUMN, 9, 9, 21, 15)
chart = sheet.charts[chartIndex]
chart.set_chart_data_range("A1:B4", True)
# Set Legend's width and height
legend = chart.legend
# 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.y = 1500
legend.width = 50
legend.height = 50
# Set legend's position
legend.position = LegendPositionType.LEFT
See Also
- module
aspose.cells.charts - class
ChartFrame - class
ChartTextFrame - class
Legend - class
Line
