Legend класс

Инкапсулирует объект, представляющий легенду диаграммы.

Наследование: Legend → ChartTextFrame → ChartFrame

Тип Legend предоставляет следующие элементы:

Характеристики

Свойство	Описание
is_inner_mode	Указывает, включает ли размер области графика деления и подписи осей. Значение False указывает, что размер будет определять размер области графика, отметок и подписей осей.
border	Получает `Line`.
area	Получает `ChartFrame.area`.
text_font	Получает объект `ChartFrame.font` указанного объекта ChartFrame.
text_options	Получает и задает параметры текста.
font	Получает объект `ChartFrame.font` указанного объекта ChartFrame.
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

Смотрите также

модуль aspose.cells.charts
класс ChartFrame
класс ChartTextFrame
класс Legend
класс Line

Floor класс LegendEntry класс