## On this page

  

 

 # `Path`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Path"></a>

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

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

Defines a Path.

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

## Overview

### Methods

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

NameDescription[`Children`](#Path.Children)Gets the list of children.[`Comments`](#Path.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#Path.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DiscretizationPoints`](#Path.DiscretizationPoints)Gets or sets the DiscretizationPoints.[`EndCoordinateSystem`](#Path.EndCoordinateSystem)Gets or sets the EndCoordinateSystem.[`EndXCoordinate`](#Path.EndXCoordinate)Gets or sets the EndXCoordinate.[`EndYCoordinate`](#Path.EndYCoordinate)Gets or sets the EndYCoordinate.[`EndZCoordinate`](#Path.EndZCoordinate)Gets or sets the EndZCoordinate.[`Figures`](#Path.Figures)Gets the list of associated figures.[`HasValidGeometrySelection`](#Path.HasValidGeometrySelection)Gets the HasValidGeometrySelection.[`Images`](#Path.Images)Gets the list of associated images.[`InternalObject`](#Path.InternalObject)Gets the internal object. For advanced usage only.[`Location`](#Path.Location)Gets or sets the Location.[`NumberOfSamplingPoints`](#Path.NumberOfSamplingPoints)Gets or sets the NumberOfSamplingPoints.[`NumberOfSubpaths`](#Path.NumberOfSubpaths)Gets or sets the NumberOfSubpaths.[`OffsetEdgeLocation`](#Path.OffsetEdgeLocation)Gets or sets the OffsetEdgeLocation.[`PathCoordinateSystem`](#Path.PathCoordinateSystem)Gets or sets the PathCoordinateSystem.[`PathType`](#Path.PathType)Gets or sets the PathType.[`Properties`](#Path.Properties)Gets the list of properties for this object.[`ShowMesh`](#Path.ShowMesh)Gets or sets the ShowMesh.[`SnapToMeshNodes`](#Path.SnapToMeshNodes)Gets or sets the SnapToMeshNodes.[`StartCoordinateSystem`](#Path.StartCoordinateSystem)Gets or sets the StartCoordinateSystem.[`StartXCoordinate`](#Path.StartXCoordinate)Gets or sets the StartXCoordinate.[`StartYCoordinate`](#Path.StartYCoordinate)Gets or sets the StartYCoordinate.[`StartZCoordinate`](#Path.StartZCoordinate)Gets or sets the StartZCoordinate.[`Suppressed`](#Path.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#Path.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

<a id="Path.DiscretizationPoints"></a>

### *property* Path.DiscretizationPoints *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DiscretizationPoints.

<a id="Path.EndCoordinateSystem"></a>

### *property* Path.EndCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](CoordinateSystem.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the EndCoordinateSystem.

<a id="Path.EndXCoordinate"></a>

### *property* Path.EndXCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the EndXCoordinate.

<a id="Path.EndYCoordinate"></a>

### *property* Path.EndYCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the EndYCoordinate.

<a id="Path.EndZCoordinate"></a>

### *property* Path.EndZCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the EndZCoordinate.

<a id="Path.Figures"></a>

### *property* Path.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="Path.HasValidGeometrySelection"></a>

### *property* Path.HasValidGeometrySelection *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the HasValidGeometrySelection.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

<a id="Path.Location"></a>

### *property* Path.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="Path.NumberOfSamplingPoints"></a>

### *property* Path.NumberOfSamplingPoints *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NumberOfSamplingPoints.

<a id="Path.NumberOfSubpaths"></a>

### *property* Path.NumberOfSubpaths *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NumberOfSubpaths.

<a id="Path.OffsetEdgeLocation"></a>

### *property* Path.OffsetEdgeLocation *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the OffsetEdgeLocation.

<a id="Path.PathCoordinateSystem"></a>

### *property* Path.PathCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](CoordinateSystem.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PathCoordinateSystem.

<a id="Path.PathType"></a>

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

Gets or sets the PathType.

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

### *property* Path.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="Path.ShowMesh"></a>

### *property* Path.ShowMesh *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ShowMesh.

<a id="Path.SnapToMeshNodes"></a>

### *property* Path.SnapToMeshNodes *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SnapToMeshNodes.

<a id="Path.StartCoordinateSystem"></a>

### *property* Path.StartCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](CoordinateSystem.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StartCoordinateSystem.

<a id="Path.StartXCoordinate"></a>

### *property* Path.StartXCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StartXCoordinate.

<a id="Path.StartYCoordinate"></a>

### *property* Path.StartYCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StartYCoordinate.

<a id="Path.StartZCoordinate"></a>

### *property* Path.StartZCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StartZCoordinate.

<a id="Path.Suppressed"></a>

### *property* Path.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

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

### *property* Path.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="Path.Activate"></a>

### Path.Activate()

Activate the current object.

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

### Path.AddComment()

Creates a new child Comment.

<a id="Path.AddFigure"></a>

### Path.AddFigure()

Creates a new child Figure.

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

### Path.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="Path.CopyTo"></a>

### Path.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

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

### Path.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

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

### Path.Delete()

Run the Delete action.

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

### Path.Duplicate()

Creates a copy of the current DataModelObject.

<a id="Path.FlipPathOrientatation"></a>

### Path.FlipPathOrientatation()

Flip Path Orientatation

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

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

Gets the list of children, filtered by type.

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

### Path.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

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

### Path.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### Path.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### Path.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="Path.PropertyByName"></a>

### Path.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

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

### Path.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

<a id="Path.SnapPathToMeshNodes"></a>

### Path.SnapPathToMeshNodes()

Snap path to mesh nodes