Legend类
Legend类
封装代表图表图例的对象。
继承： Legend →
ChartTextFrame →
ChartFrame
Legend 类型公开以下成员：
属性
| 属性 | 描述 |
|---|---|
| is_inner_mode | 指示绘图区尺寸是否包括刻度线和轴标签。 False 指定大小应确定绘图区域、刻度线和轴标签的大小。 |
| border | 获取 Line。 |
| area | 获取 ChartFrame.area。 |
| text_font | 获取指定 ChartFrame 对象的 ChartFrame.font 对象。 |
| text_options | 获取并设置文本的选项。 |
| font | 获取指定 ChartFrame 对象的 ChartFrame.font 对象。 |
| auto_scale_font | 如果对象中的文本字体大小随对象大小变化而变化，则为 True。默认值为 True。 |
| background_mode | 获取和设置背景的显示模式 |
| background | 获取和设置背景的显示模式 |
| is_automatic_size | 指示图表框架是否自动调整大小。 |
| x | 获取或设置图表区域左上角的 x 坐标，以 1/4000 为单位。 |
| y | 获取或设置图表区域左上角的 y 坐标，以 1/4000 为单位。 |
| height | 获取或设置图表区域的框架高度（以 1/4000 为单位）。 |
| width | 获取或设置图表区域的框架宽度（以 1/4000 为单位）。 |
| shadow | 如果框架有阴影则为真。 |
| shape_properties | 获取 ChartFrame.shape_properties 对象。 |
| is_default_pos_be_set | 指示是否设置了默认位置（DefaultX、DefaultY、DefaultWidth 和 DefaultHeight）。 |
| default_x | 表示图表区域的默认位置的 x ，以 1/4000 为单位。 |
| default_y | 表示图表区域的默认位置的 y 轴，以 1/4000 为单位。 |
| default_width | 表示图表区域的默认位置的宽度，以 1/4000 为单位。 |
| default_height | 表示图表区域的默认位置的高度，以 1/4000 为单位。 |
| default_x_ratio_to_chart | 表示以图表区域分数为单位的默认位置的 x。 |
| default_y_ratio_to_chart | 以图表区域的分数为单位表示默认位置的 y。 |
| default_width_ratio_to_chart | 表示默认位置的宽度，以图表区域的分数为单位。 |
| default_height_ratio_to_chart | 表示默认位置的高度，以图表区域的分数为单位。 |
| x_ratio_to_chart | 获取或设置图表区域左上角的 x 坐标（以比例为单位）。 |
| y_ratio_to_chart | 获取或设置图表区域左上角的 y 坐标（以比例为单位）。 |
| width_ratio_to_chart | 获取或设置框架的宽度，以图表区域的比例为单位。 |
| height_ratio_to_chart | 获取或设置框架的高度，以图表区域的比例为单位。 |
| x_pixel | 获取或设置左上角的 x 坐标（以像素为单位）。 |
| y_pixel | 获取或设置左上角的 y 坐标（以像素为单位）。 |
| width_pixel | 以像素为单位获取或设置框架的宽度。 |
| height_pixel | 以像素为单位获取或设置框架的高度。 |
| is_auto_text | 表示文本是自动生成的。 |
| is_deleted | 表示该数据标签是否被删除。 |
| text_horizontal_alignment | 获取并设置文本水平对齐方式。 |
| text_vertical_alignment | 获取或设置文本的垂直对齐方式。 |
| rotation_angle | 表示文本旋转角度。 |
| is_automatic_rotation | 指示图表的文本是否自动旋转。 |
| text | 获取或设置框架标题的文本。 |
| linked_source | 获取并设置对工作表的引用。 |
| text_direction | 表示文本阅读顺序。 |
| reading_order | 表示文本阅读顺序。 |
| direction_type | 获取并设置文本的方向。 |
| is_text_wrapped | 获取或设置一个值，指示文本是否换行。 |
| is_resize_shape_to_fit_text | 获取或设置形状是否应自动调整以完全包含其中描述的文本。自动调整是 当形状内的文本被缩放以包含其中的所有文本时。 |
| position | 获取或设置图例位置类型。 |
| legend_entries | 获取指定图表图例中所有 LegendEntry 对象的集合。 不支持设置曲面图的图例条目。 所以如果图表类型是曲面图类型，则会返回null。 |
| legend_entries_labels | 调用Chart.Calculate()方法后获取图例条目的标签。 |
| is_over_lay | 获取或设置是否在不覆盖图表的情况下显示图例。 |
方法
| 方法 | 描述 |
|---|---|
set_position_auto(self) | 将框架位置设置为自动 |
characters(self, start_index, length) | 返回表示文本内字符范围的 Characters 对象。 |
get_legend_labels(self) | 调用Chart.Calculate()方法后获取图例条目的标签。 |
例子
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
