## On this page

  

 

 # `Image`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Image"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Image

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a Image.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#Image.Activate)Activate the current object.[`AddComment`](#Image.AddComment)Creates a new child Comment.[`AddImage`](#Image.AddImage)Creates a new child Image.[`CopyTo`](#Image.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#Image.CreateParameter)Creates a new parameter for a Property.[`Delete`](#Image.Delete)Run the Delete action.[`Duplicate`](#Image.Duplicate)Creates a copy of the current DataModelObject.[`GetChildren`](#Image.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#Image.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#Image.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#Image.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#Image.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#Image.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#Image.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`Children`](#Image.Children)Gets the list of children.[`Comments`](#Image.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#Image.DataModelObjectCategory)Gets the current DataModelObject's category.[`Images`](#Image.Images)Gets the list of associated images.[`InternalObject`](#Image.InternalObject)Gets the internal object. For advanced usage only.[`Properties`](#Image.Properties)Gets the list of properties for this object.[`VisibleProperties`](#Image.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="Image.Children"></a>

### *property* Image.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="Image.Comments"></a>

### *property* Image.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="Image.DataModelObjectCategory"></a>

### *property* Image.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject's category.

<a id="Image.Images"></a>

### *property* Image.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="Image.InternalObject"></a>

### *property* Image.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSAdvancedPostOutputAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="Image.Properties"></a>

### *property* Image.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="Image.VisibleProperties"></a>

### *property* Image.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="method-detail"></a>

## Method detail

<a id="Image.Activate"></a>

### Image.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="Image.AddComment"></a>

### Image.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

<a id="Image.AddImage"></a>

### Image.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Image)

```text
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

```

<a id="Image.CopyTo"></a>

### Image.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="Image.CreateParameter"></a>

### Image.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

<a id="Image.Delete"></a>

### Image.Delete() → [None](https://docs.python.org/3/library/constants.html#None)

Run the Delete action.

<a id="Image.Duplicate"></a>

### Image.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="Image.GetChildren"></a>

### Image.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="Image.GetParameter"></a>

### Image.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="Image.GroupAllSimilarChildren"></a>

### Image.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="Image.GroupSimilarObjects"></a>

### Image.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](TreeGroupingFolder.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="Image.PropertyByAPIName"></a>

### Image.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```text
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

```

<a id="Image.PropertyByName"></a>

### Image.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="Image.RemoveParameter"></a>

### Image.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

Removes the parameter from the parameter set corresponding to the given property.