Shape — Aspose.Cells FOSS for Python API Reference
aspose-cells-foss suporta a adição de formas geométricas e caixas de texto às planilhas através do ShapeCollection (ws.shapes). Cada forma é representada por um Shape objeto com propriedades configuráveis de preenchimento, linha e texto.
ImageRenderOptions: aspose.cells_foss
from aspose.cells_foss import (
MsoDrawingType, FillType, MsoLineDashStyle,
TextAlignmentType, TextAnchorType,
MsoFillFormat, MsoLineFormat, ShapeFont, Shape,
)MsoDrawingType
MsoDrawingType é um IntEnum identificando o tipo de forma geométrica.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
UNKNOWN | 0 | TEXT_BOX | 21 |
RECTANGLE | 1 | CALLOUT | 22 |
ROUNDED_RECTANGLE | 2 | PENTAGON | 23 |
OVAL | 3 | CLOUD | 24 |
DIAMOND | 4 | HEART | 25 |
TRIANGLE | 5 | LIGHTNING_BOLT | 26 |
RIGHT_TRIANGLE | 6 | SMILEY_FACE | 27 |
PARALLELOGRAM | 7 | LEFT_RIGHT_ARROW | 28 |
TRAPEZOID | 8 | UP_DOWN_ARROW | 29 |
HEXAGON | 9 | CUBE | 30 |
OCTAGON | 10 | BEVEL | 31 |
CROSS | 11 | STAR_4 | 12 |
RIGHT_ARROW | 17 | STAR_5 | 13 |
LEFT_ARROW | 18 | STAR_6 | 14 |
UP_ARROW | 19 | STAR_7 | 15 |
DOWN_ARROW | 20 | STAR_8 | 16 |
FillType
FillType é um IntEnum identificando o tipo de preenchimento aplicado a uma forma.
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NONE | 0 |
SOLID | 1 |
GRADIENT | 2 |
PATTERN | 3 |
AUTOMATIC | 4 |
MsoLineDashStyle
MsoLineDashStyle é um IntEnum para o padrão de traços da linha de borda/contorno.
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SOLID | 0 |
DASH | 1 |
DOT | 2 |
DASH_DOT | 3 |
DASH_DOT_DOT | 4 |
LONG_DASH | 5 |
LONG_DASH_DOT | 6 |
TextAlignmentType
TextAlignmentType é um IntEnum para o alinhamento horizontal de texto dentro de uma forma.
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LEFT | 0 |
CENTER | 1 |
RIGHT | 2 |
JUSTIFY | 3 |
DISTRIBUTED | 4 |
TextAnchorType
TextAnchorType é um IntEnum para o ancoramento vertical de texto dentro de uma forma.
| ImageRenderOptions | ImageRenderOptions |
|---|---|
TOP | 0 |
MIDDLE | 1 |
BOTTOM | 2 |
JUSTIFIED | 3 |
MsoFillFormat
Controla a aparência de preenchimento de uma forma. Acessado via shape.fill.
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
fill_type | FillType | O tipo de preenchimento ativo. |
fore_color | str | Cor de preenchimento de primeiro plano (primária) como hex RRGGBB. |
transparency | float | Opacidade de preenchimento como um valor de 0.0 (totalmente opaco) a 1.0 (totalmente transparente). |
ImageRenderOptions
cópia
fill.copy() -> MsoFillFormatRetorna uma cópia profunda dessas configurações de preenchimento.
MsoLineFormat
Controla a aparência do contorno/borda de uma forma. Acessado via shape.line.
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
is_visible | bool | True para desenhar o contorno da forma. |
color | str | Cor do contorno como hex RRGGBB. |
weight | int | Espessura do contorno (grossura) em pontos. |
dash_style | MsoLineDashStyle | Padrão de traço para o contorno. |
transparency | float | Opacidade do contorno de 0.0 (opaco) a 1.0 (transparente). |
ImageRenderOptions
cópia
line.copy() -> MsoLineFormatRetorna uma cópia profunda dessas configurações de linha.
ShapeFont
Controla a fonte do texto dentro de uma forma. Acessado via shape.font.
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
name | str | Nome da família da fonte (ex., "Calibri"). |
size | float | Tamanho da fonte em pontos. |
bold | bool | True para peso negrito. |
italic | bool | True para estilo itálico. |
underline | bool | True para sublinhado simples. |
color | str | Cor da fonte como hexadecimal RRGGBB. |
ImageRenderOptions
cópia
font.copy() -> ShapeFontRetorna uma cópia profunda dessas configurações de fonte.
ImageRenderOptions
Shape os objetos não são construídos diretamente. Use ws.shapes.add(...) ou ws.shapes.add_text_box(...).
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
name | str | Leitura/Gravação | Nome da forma (deve ser exclusivo dentro da planilha). |
drawing_type | MsoDrawingType | ImageRenderOptions | O tipo geométrico desta forma. |
upper_left_row | int | Leitura/Gravação | 0-based row index of the top-left anchor cell. |
upper_left_column | int | Leitura/Gravação | 0-based column index of the top-left anchor cell. |
lower_right_row | int | Leitura/Gravação | 0-based row index of the bottom-right anchor cell. |
lower_right_column | int | Leitura/Gravação | 0-based column index of the bottom-right anchor cell. |
upper_left_row_offset | int | Leitura/Gravação | Deslocamento de pixel a partir da borda superior da célula superior esquerda. |
upper_left_column_offset | int | Leitura/Gravação | Deslocamento de pixel a partir da borda esquerda da célula superior esquerda. |
lower_right_row_offset | int | Leitura/Gravação | Deslocamento de pixel a partir da borda superior da célula inferior direita. |
lower_right_column_offset | int | Leitura/Gravação | Deslocamento de pixel a partir da borda esquerda da célula inferior direita. |
fill | MsoFillFormat | ImageRenderOptions | Configurações de preenchimento (fundo). |
line | MsoLineFormat | ImageRenderOptions | Configurações de contorno/borda. |
text | str | Leitura/Gravação | Conteúdo de texto exibido dentro da forma. |
font | ShapeFont | ImageRenderOptions | Configurações de fonte para o texto da forma. |
text_horizontal_alignment | TextAlignmentType | Leitura/Gravação | Alinhamento horizontal do texto dentro da forma. |
text_vertical_alignment | TextAnchorType | Leitura/Gravação | Ancoragem vertical do texto dentro da forma. |
is_text_wrapped | bool | Leitura/Gravação | True para ajustar o texto ao limite da forma. |
is_locked | bool | Leitura/Gravação | True para bloquear a forma quando a proteção da planilha está ativa. |
is_hidden | bool | Leitura/Gravação | True para ocultar a forma. |
hyperlink | `str | None` | Leitura/Gravação |
ImageRenderOptions
cópia
shape.copy() -> ShapeRetorna uma cópia profunda desta forma com toda a formatação preservada.
ShapeCollection
ShapeCollection é acessado como ws.shapes. Ele contém todas as formas em uma planilha.
ImageRenderOptions
adicionar
ws.shapes.add(
drawing_type: MsoDrawingType,
upper_left_row: int,
upper_left_column: int,
lower_right_row: int,
lower_right_column: int
) -> ShapeAdiciona uma forma do tipo especificado. Todos os argumentos de posição são índices de linha/coluna baseados em 0.
add_text_box
ws.shapes.add_text_box(
upper_left_row: int,
upper_left_column: int,
lower_right_row: int,
lower_right_column: int
) -> ShapeAtalho para add(MsoDrawingType.TEXT_BOX, ...).
Propriedades e Iteração
| ImageRenderOptions | ImageRenderOptions |
|---|---|
count | Número de formas na coleção (somente leitura). |
__len__() | ImageRenderOptions count. |
__iter__() | Itera sobre todos Shape objetos. |
__getitem__(index) | Retorna o Shape em base zero index. |
ImageRenderOptions
Adicionar um Retângulo com Preenchimento Sólido
from aspose.cells_foss import Workbook, MsoDrawingType, FillType, MsoLineDashStyle, TextAlignmentType
wb = Workbook()
ws = wb.worksheets[0]
# Add a blue rectangle spanning rows 1-5, columns 1-4 (0-based)
rect = ws.shapes.add(MsoDrawingType.RECTANGLE, 1, 1, 5, 4)
rect.name = "BlueBox"
rect.fill.fill_type = FillType.SOLID
rect.fill.fore_color = "4472C4" # blue
rect.fill.transparency = 0.0
rect.line.is_visible = True
rect.line.color = "1F3864" # dark blue
rect.line.weight = 2
rect.line.dash_style = MsoLineDashStyle.SOLID
rect.text = "Sales Summary"
rect.font.bold = True
rect.font.color = "FFFFFF" # white text
rect.font.size = 12
rect.text_horizontal_alignment = TextAlignmentType.CENTER
wb.save("shapes.xlsx")Adicionar uma Caixa de Texto
from aspose.cells_foss import Workbook
wb = Workbook()
ws = wb.worksheets[0]
tb = ws.shapes.add_text_box(2, 0, 5, 3)
tb.name = "NoteBox"
tb.text = "Review this section before publishing."
tb.font.italic = True
tb.font.color = "595959"
tb.is_text_wrapped = True
tb.line.is_visible = True
tb.line.color = "BFBFBF"
wb.save("textbox.xlsx")