Shape

class Shape(*args, **options)

The shape object is a member of the shapes collection:

>>> import xlwings as xw
>>> sht = xw.books['Book1'].sheets[0]
>>> sht.shapes[0]  # or sht.shapes['ShapeName']
<Shape 'Rectangle 1' in <Sheet [Book1]Sheet1>>

Changed in version 0.9.0.

activate()

Activates the shape.

Added in version 0.5.0.

property api: Any

Returns the native object (pywin32 or appscript obj) of the engine being used.

Added in version 0.19.2.

delete()

Deletes the shape.

Added in version 0.5.0.

async get_text()

Fetch the shape’s text on demand.

None if the shape holds no text.

Requires xlwings Lite.

property height: float

Returns or sets the number of points that represent the height of the shape.

Added in version 0.5.0.

property left: float

Returns or sets the number of points that represent the horizontal position of the shape.

Added in version 0.5.0.

property name: str

Returns or sets the name of the shape.

Added in version 0.5.0.

property parent: Sheet

Returns the parent of the shape.

Added in version 0.9.0.

scale_height(factor, relative_to_original_size=False, scale='scale_from_top_left')
Parameters:

  • factor (float) – For example 1.5 to scale it up to 150%

  • relative_to_original_size (bool) – If False, it scales relative to current height (default). For True must be a picture or OLE object.

  • scale (str) – One of scale_from_top_left (default), scale_from_bottom_right, scale_from_middle

Added in version 0.19.2.

scale_width(factor, relative_to_original_size=False, scale='scale_from_top_left')
Parameters:

  • factor (float) – For example 1.5 to scale it up to 150%

  • relative_to_original_size (bool) – If False, it scales relative to current width (default). For True must be a picture or OLE object.

  • scale (str) – One of scale_from_top_left (default), scale_from_bottom_right, scale_from_middle

Added in version 0.19.2.

property text: str

Returns or sets the text of a shape.

Added in version 0.21.4.

property top: float

Returns or sets the number of points that represent the vertical position of the shape.

Added in version 0.5.0.

property type: str

Returns the type of the shape.

Added in version 0.9.0.

property width: float

Returns or sets the number of points that represent the width of the shape.

Added in version 0.5.0.