Paper Office
paper-pptxAPI referenceshapes.group

GroupShape

paper-pptx 0.2.0 API reference

A shape that acts as a container for other shapes.

GroupShape(grpSp: CT_GroupShape, parent: ProvidesPart)

Attributes

click_action

attributeclick_actionActionSetting

Unconditionally raises TypeError.

A group shape cannot have a click action or hover action.

element

attributeelementShapeElement

lxml element for this shape, e.g. a CT_Shape instance.

Note that manipulating this element improperly can produce an invalid presentation file. Make sure you know what you're doing if you use this to change the underlying XML.

has_chart

attributehas_chartbool

True if this shape is a graphic frame containing a chart object.

False otherwise. When True, the chart object can be accessed using the .chart property.

has_table

attributehas_tablebool

True if this shape is a graphic frame containing a table object.

False otherwise. When True, the table object can be accessed using the .table property.

has_text_frame

attributehas_text_framebool

Unconditionally False.

A group shape does not have a textframe and cannot itself contain text. This does not impact the ability of shapes contained by the group to each have their own text.

height

attributeheightLength

Read/write. Integer distance between top and bottom extents of shape in EMUs.

is_placeholder

attributeis_placeholderbool

True if this shape is a placeholder.

A shape is a placeholder if it has a <p:ph> element.

left

attributeleftLength

Integer distance of the left edge of this shape from the left edge of the slide.

Read/write. Expressed in English Metric Units (EMU)

name

attributenamestr

Name of this shape, e.g. 'Picture 7'.

part

attributepartBaseSlidePart

The package part containing this shape.

A BaseSlidePart subclass in this case. Access to a slide part should only be required if you are extending the behavior of pp API objects.

placeholder_format

attributeplaceholder_format_PlaceholderFormat

Provides access to placeholder-specific properties such as placeholder type.

Raises ValueError on access if the shape is not a placeholder.

rotation

attributerotationfloat

Degrees of clockwise rotation.

Read/write float. Negative values can be assigned to indicate counter-clockwise rotation, e.g. assigning -45.0 will change setting to 315.0.

shadow

attributeshadowShadowFormat

ShadowFormat object representing shadow effect for this group.

A ShadowFormat object is always returned, even when no shadow is explicitly defined on this group shape (i.e. when the group inherits its shadow behavior).

shape_id

attributeshape_idint

Read-only positive integer identifying this shape.

The id of a shape is unique among all shapes on a slide.

shape_type

attributeshape_typeMSO_SHAPE_TYPE

Member of :ref:MsoShapeType identifying the type of this shape.

Unconditionally MSO_SHAPE_TYPE.GROUP in this case

shapes

attributeshapesGroupShapes

GroupShapes object for this group.

The GroupShapes object provides access to the group's member shapes and provides methods for adding new ones.

top

attributetopLength

Distance from the top edge of the slide to the top edge of this shape.

Read/write. Expressed in English Metric Units (EMU)

width

attributewidthLength

Distance between left and right extents of this shape.

Read/write. Expressed in English Metric Units (EMU).

On this page